سلام دنیا

ارسال و دریافت پیام ها و رویدادها جنبه های اصلی ارتباط بین یک نماینده و یک کاربر است. نمایندگان پیام‌ها، رویدادها و درخواست‌ها را از طریق Business Messages API برای کاربران ارسال می‌کنند، اما پیام‌ها و رویدادهای ایجاد شده توسط کاربر را در webhook‌های خود به‌عنوان JSON دریافت می‌کنند.

در زیر نمونه‌ای از جریان مکالمه است که از داده‌های نمونه استفاده می‌کند تا نشان دهد چگونه پیام‌ها، رویدادها و درخواست‌ها می‌توانند تعاملات مفید و معنی‌داری ایجاد کنند.

در این مثال، کاربر مکالمه ای را شروع می کند و پیام "Hello, I'm World!" را ارسال می کند، سپس نماینده با "Hello, World" پاسخ می دهد.

1. کاربر مکالمه را با نماینده شروع می کند.

2. هنگامی که کاربر شروع به تایپ پاسخ می کند، یک رویداد تایپ را برای نماینده ارسال می کند.

   {
     "agent": "brands/1111/agents/2222",
     "conversationId": "3333",
     "customAgentId": "hello-world-bot",
     "requestId": "1234567890",
     "userStatus": {
       "isTyping": "true",
       "createTime": "2020-10-02T15:01:23.045123456Z",
     },
     "sendTime": "2020-10-02T15:01:24.045123456Z",
   }
   

3. کاربر "Hello, I'm World" را ارسال می کند. به عنوان یک پیام

   {
     "agent": "brands/1111/agents/2222",
     "conversationId": "3333",
     "customAgentId": "hello-world-bot",
     "requestId": "123123123",
     "message": {
       "messageId": "4444",
       "name": "conversations/12345/messages/67890",
       "text": "Hello! I'm World!",
       "createTime": "2020-10-02T15:05:23.045123456Z",
     },
     "context": {
       "entryPoint": "PLACESHEET",
       "userInfo": {
         "displayName": "Michael",
         "userDeviceLocale": "en",
       },
       "resolvedLocale": "en",
     }
     "sendTime": "2020-10-02T15:05:24.045123456Z",
   }
   

4. نماینده "سلام، جهان" را به عنوان پیام ارسال می کند.

   curl -X POST "https://businessmessages.googleapis.com/v1/conversations/3333/messages" \
   -H "Content-Type: application/json" \
   -H "`oauth2l header --json path/to/service/account/key.json businessmessages`" \
   -d "{
       'messageId': '5555',
       'text': 'Hello, World',
       'representative': {
         'avatarImage': 'https://hello.world/avatar.jpg',
         'displayName': 'Hello World Agent',
         'representativeType': 'BOT'
     }
   }"
   

5. پس از تحویل پیام، دستگاه کاربر یک رسید تحویل را برمی گرداند.

   {
     "agent": "brands/1111/agents/2222",
     "conversationId": "3333",
     "customAgentId": "hello-world-bot",
     "receipts" : {
       "receipts": [
         {
           "message": "conversations/3333/messages/5555",
           "receiptType": "DELIVERED",
         }
       ],
       "createTime": "2020-10-02T16:01:23.045123456Z",
     },
     "sendTime": "2020-10-02T16:01:24.045123456Z",
   }