Bot.Messenger

Bot.Messger

.NET Framework Library für Facebook Messenger Bot

Nuget -Paket https://www.nuget.org/packages/bot.messenger

Beispiel Webapi-Projekt https://github.com/olisamaduka/messengerbot-webapi

Wie man benutzt

So generieren Sie Ihre Messenger-Anmeldeinformationen zusammen mit einem detaillierten Anleitungen, einen Bot auf Facebook Messenger (einschließlich Webhooks) einzurichten

• Erstellen Sie eine Instanz der Bot.messenger.messgerPlatform -Klasse und geben Sie ihn an Ihre Anmeldeinformationen weiter

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

• Oder setzen Sie Ihre Anmeldeinformationen in Web.config und initialisieren Sie den Code 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>
  

  Code

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

Die Anmeldeinformationen werden aus Web.Config -Anwendungen abgerufen, wenn die Erstellung der Erstellung ohne Anmeldeinformationen Parameter aufgerufen wird oder wenn der parameterlose Konstruktor zur Initialisierung der MessengerPlatform -Klasse verwendet wird. Dies gilt für alle Typen, die von bot.messenger.apibase erben.

• Sie können über eine Instanz der Bot.messger.MessgerPlatform -Klasse auf die Messenger -Plattform -APIs zugreifen. Hier ist eine Beispielverwendung in einem 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 ) ;
}

Beachten Sie, wie die Benutzerprofil -API der Messenger -Plattform und die Senden von API oben genannt werden

 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

Die Referenz von Bot.Authenticator wird verwendet, um Ihnen Webhook -Token und die OAuth -Signatur eines Webhook -Rückrufs zu überprüfen

 /* 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

• Diese Bibliothek verkauft alle Serialisierungs- und Datenvertragsanfragen zwischen Ihrer Webanwendung und dem Facebook -Messenger, sodass Sie sich nie um diese Dinge Sorgen machen müssen. Alle Objekte von und auf Messenger werden über stark typisierte Klassen, z.

 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"
        }
} ) ;