Bot.Messenger

Bot.messenger

Biblioteca de .NET Framework para Facebook Messenger Bot

Paquete nuget https://www.nuget.org/packages/bot.messenger

Proyecto de Webapi de muestra https://github.com/olisamaduka/messengerbot-webapi

Cómo usar

Para generar sus credenciales de Messenger junto con una instrucción detallada sobre la configuración de un bot en Facebook Messenger (incluidos Webhooks), consulte esta guía de inicio rápido en Facebook https://developers.facebook.com/docs/messenger-platform/guides/quick-start

• Cree una instancia de la clase BOT.Messenger.MessengerPlatform y pase sus credenciales

 Bot . Messenger . MessengerPlatform bot = Bot . Messenger . MessengerPlatform . CreateInstance (
        Bot . Messenger . MessengerPlatform . CreateCredentials ( _appSecret , _pageToken , _verifyToken ) ) ;

• O establezca sus credenciales en web.config e inicialice en código como SO;

  Web.config

   <configuration>
    <configSections>
      <sectionGroup name="applicationSettings" type="System.Configuration.ApplicationSettingsGroup, System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
        <section name="Bot.Messenger.Settings" type="System.Configuration.ClientSettingsSection, System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" />
      </sectionGroup>
    </configSections>
    <applicationSettings>
      <Bot.Messenger.Settings>
        <setting name="PageToken" serializeAs="String">
          <value>page token</value>
        </setting>
        <setting name="AppSecret" serializeAs="String">
          <value>app secret</value>
        </setting>
        <setting name="VerifyToken" serializeAs="String">
          <value>hello</value>
        </setting>
      </Bot.Messenger.Settings>
    </applicationSettings>
    ...
  </configuration>
  

  Código

   Bot . Messenger . MessengerPlatform bot = Bot . Messenger . MessengerPlatform . CreateInstance ( ) ;
  // OR
  // Bot.Messenger.MessengerPlatform bot = new Bot.Messenger.MessengerPlatform();

Las credenciales se obtienen de Web.Config AplicationStets cuando el método CrearInstance se llama sin un parámetro de credenciales o si el constructor sin parámetros se usa para inicializar la clase Messengerplatform. Esto es cierto para todos los tipos que heredan de bot.messenger.apibase.

• Puede acceder a las API de la plataforma Messenger a través de una instancia de la clase BOT.Messenger.MessengerPlatform (las API admitidas son API envío, API de perfil de usuario y API de perfil de Messenger). Aquí hay un uso de muestra en un ASP.NET WebAPI WebhookController

 // HTTP Get endpoint to verify Webhook using the Verify Token
public HttpResponseMessage Get ( )
{
    var querystrings = Request . GetQueryNameValuePairs ( ) . ToDictionary ( x => x . Key , x => x . Value ) ;

    Bot . Messenger . MessengerPlatform bot = Bot . Messenger . MessengerPlatform . CreateInstance (
            Bot . Messenger . MessengerPlatform . CreateCredentials ( _appSecret , _pageToken , _verifyToken ) ) ;

    if ( bot . Authenticator . VerifyToken ( querystrings [ "hub.verify_token" ] ) )
    {
        return new HttpResponseMessage ( HttpStatusCode . OK )
        {
            Content = new StringContent ( querystrings [ "hub.challenge" ] , Encoding . UTF8 , "text/plain" )
        } ;
    }

    return new HttpResponseMessage ( HttpStatusCode . Unauthorized ) ;
}

// HTTP Post endpoint to receive Webhook callbacks from Facebook Messenger
[ HttpPost ]
public async Task < HttpResponseMessage > Post ( )
{
    var body = await Request . Content . ReadAsStringAsync ( ) ;

    Bot . Messenger . MessengerPlatform bot = Bot . Messenger . MessengerPlatform . CreateInstance (
            Bot . Messenger . MessengerPlatform . CreateCredentials ( _appSecret , _pageToken , _verifyToken ) ) ;

    if ( ! bot . Authenticator . VerifySignature ( Request . Headers . GetValues ( "X-Hub-Signature" ) . FirstOrDefault ( ) , body ) )
        return new HttpResponseMessage ( HttpStatusCode . BadRequest ) ;

    Bot . Messenger . Models . WebhookModel webhookModel = bot . ProcessWebhookRequest ( body ) ;

    foreach ( var entry in webhookModel . Entries )
    {
        foreach ( var evt in entry . Events )
        {                
            if ( evt . EventType == Bot . Messenger . Models . WebhookEventType . MessageReceivedCallback )
            {
                await bot . SendApi . SendActionAsync ( evt . Sender . ID , Bot . Messenger . Models . SenderAction . typing_on ) ;

                Bot . Messenger . Models . UserProfileResponse userProfileRsp = await bot . UserProfileApi . GetUserProfileAsync ( evt . Sender . ID ) ;

                if ( evt . Message . Attachments == null )
                {
                        await bot . SendApi . SendTextAsync ( evt . Sender . ID , $ "Hello { userProfileRsp ? . FirstName } :)" ) ;
                }
                else // if the user sent an image, file, sticker etc., we send it back to them
                {
                        foreach ( var attachment in evt . Message . Attachments )
                        {
                            if ( attachment . Type != Bot . Messenger . Models . AttachmentType . fallback
                                && attachment . Type != Bot . Messenger . Models . AttachmentType . location )
                            {
                                await bot . SendApi . SendTextAsync ( evt . Sender . ID , $ "Hello { userProfileRsp ? . FirstName } , you sent this and we thought it would be nice we sent it back :)" ) ;

                                await bot . SendApi . SendAttachmentAsync ( evt . Sender . ID , attachment ) ;
                            }
                        }
                }
            }
        }
    }

    return new HttpResponseMessage ( HttpStatusCode . OK ) ;
}

Observe cómo se hace referencia a la API de perfil de usuario de usuario de la plataforma Messenger y se hace referencia a

 bot . UserProfileApi // Messenger User Profile API reference
 bot . SendApi // Messenger Send API reference
 
 //And of course the Messenger Profile API is referenced the same way
 bot . MessengerProfileApi

La referencia de Bot.Authenticator se utiliza para verificar su Webhook Verify Token y la firma OAuth de una devolución de llamada webhook

 /* checks if the query string value of hub.verify_token is equal to the specified VerifyToken
in your application (either the one in web.config ApplicationSettings or the one used to initialize the
Bot.Messenger.MessengerPlatform class instance) */
 bot . Authenticator . VerifyToken 

/* Verifies the X-Hub-Signature header against a Sha1 encryption of your specified App secret */
 bot . Authenticator . VerifySignature

• Esta biblioteca encapsula todas las solicitudes de serialización y contrato de datos entre su aplicación web y Facebook Messenger para que nunca tenga que preocuparse por esas cosas. Se hace referencia a todos los objetos de y para mensajería a través de clases fuertemente tipadas, por ejemplo, plantillas, archivos adjuntos, mensajes, objetos de webhook, etc. y a través del bot.messenger.messengerplatformform API referencias como el sendapi, puede hacer solicitudes directamente para mensajería sin preocuparse por cómo se debe estructurar el objeto JSON.

 SendApiResponse sendQuickReplyResponse = await bot . SendApi . SendTextAsync ( evt . Sender . ID , "Are you a Developer?" , new List < QuickReply >
{
        new QuickReply
        {
            ContentType = QuickReplyContentType . text ,
            Title = "Yes" ,
            Payload = "PAYLOAD_YES"
        } ,
        new QuickReply
        {
            ContentType = QuickReplyContentType . text ,
            Title = "No" ,
            Payload = "PAYLOAD_NO"
        }
} ) ;