Bot.Messenger

Bot.Messenger

.NET Framework Library for Facebook Messenger Bot

حزمة nuget https://www.nuget.org/packages/bot.messenger

عينة من Webapi Project https://github.com/olisamaduka/messengerbot-webapi

كيفية استخدام

لإنشاء بيانات اعتماد Messenger الخاصة بك إلى جانب كيفية إعداد روبوت مفصل على Facebook Messenger (بما في ذلك WebHooks) ، انظر هذا الدليل السريع على Facebook https://developers.facebook.com/docs/messenger-platform/guides/quick-start

• إنشاء مثيل لفئة bot.messenger.messengerplatform ومررها بيانات الاعتماد الخاصة بك

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

• أو قم بتعيين بيانات الاعتماد الخاصة بك في web.config وقم بتهيئة الكود على النحو ؛

  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>
  

  شفرة

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

يتم جلب بيانات الاعتماد من Web.Config Applicationsettings عندما يتم استدعاء طريقة CreateInstance بدون معلمة بيانات الاعتماد أو إذا تم استخدام منشئ المعلمة لتهيئة فئة MessengerPlatform. هذا ينطبق على جميع الأنواع التي ترث من bot.messenger.apibase.

• يمكنك الوصول إلى واجهات برمجة تطبيقات منصة Messenger من خلال مثيل من فئة bot.messenger.messengerplatform (APIs المدعومة هي إرسال واجهة برمجة التطبيقات ، واجهة برمجة تطبيقات ملف تعريف المستخدم و API). فيما يلي عينة من استخدام عينة في 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 ) ;
}

لاحظ كيفية الرجوع إلى واجهة برمجة تطبيقات ملف تعريف مستخدم منصة Messenger وإرسال API أعلاه

 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

يتم استخدام مرجع Bot.Authenticator للتحقق من أنك على شبكة الإنترنت التحقق من الرمز المميز وتوقيع OAUTH من رد اتصال 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

• تغلف هذه المكتبة جميع طلبات التسلسل وطلبات بيانات البيانات بين تطبيق الويب الخاص بك و Facebook Messenger ، لذلك لا تقلق أبدًا بشأن هذه الأشياء. تتم الرجوع إلى جميع الكائنات من وإلى Messenger عبر فئات مكتوبة بقوة على سبيل المثال قوالب ، مرفقات ، رسائل ، كائنات webhook وما إلى ذلك ، ومن خلال bot.messenger.messengerplatform API مراجع مثل sendapi ، يمكنك تقديم طلبات مباشرة إلى Messenger دون القلق بشأن كيفية تنظيم كائن 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"
        }
} ) ;