Bot.Messenger

Bot.Messenger

Perpustakaan .NET Framework untuk Bot Facebook Messenger

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

Contoh proyek webapi https://github.com/olisamaduka/messengerbot-webapi

Cara menggunakan

Untuk menghasilkan kredensial messenger Anda bersama dengan cara terperinci tentang pengaturan bot di Facebook Messenger (termasuk webhooks) lihat panduan start cepat ini di facebook https://developers.facebook.com/docs/messenger-platform/guides/quick-start

• Buat instance dari kelas Bot.Messenger.MessengerPlatform dan berikan kredensial Anda

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

• Atau atur kredensial Anda di web.config dan inisialisasi dalam kode seperti demikian;

  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>
  

  Kode

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

Kredensial diambil dari Web.config Applicationsettings Ketika metode CreateInstance dipanggil tanpa parameter kredensial atau jika konstruktor tanpa parameter digunakan untuk menginisialisasi kelas MESSIRERPLATFORM. Ini berlaku untuk semua jenis yang mewarisi dari bot.messenger.APIBase.

• Anda dapat mengakses API Platform Messenger melalui instance kelas Bot.Messenger.MessengerPlatform (API yang didukung adalah Kirim API, API Profil Pengguna dan API Profil Messenger). Berikut adalah contoh penggunaan di ASP.NET WEBAPI WEBHOOKCROLLER

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

Perhatikan bagaimana API Profil Pengguna Platform Messenger dan Kirim API direferensikan di atas

 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

Referensi bot

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

• Perpustakaan ini merangkum semua serialisasi dan permintaan kontrak data antara aplikasi web Anda dan Facebook Messenger sehingga Anda tidak perlu khawatir tentang hal -hal itu. Semua objek dari dan ke Messenger direferensikan melalui kelas yang diketik dengan kuat misalnya templat, lampiran, pesan, objek webhook dll. Dan melalui bot.messenger.Messengerplatform API referensi seperti sendapi, Anda dapat secara langsung membuat permintaan untuk messenger tanpa khawatir tentang bagaimana objek JSON harus disusun.

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