שלום, עולם

שליחה וקבלה של הודעות ואירועים הם ההיבטים העיקריים בתקשורת בין נציג למשתמש. נציגים שולחים הודעות, אירועים ובקשות למשתמשים באמצעות Business Messages API, אבל לקבל הודעות ואירועים שנוצרו על ידי משתמשים ב-webhooks שלהם, בתור JSON.

בהמשך מוצגת דוגמה לתהליך שיחה שבו נעשה שימוש בנתונים לדוגמה כדי להמחיש איך הודעות, אירועים ובקשות יכולים ליצור אינטראקציות מועילות ומשמעותיות.

בדוגמה הזו, המשתמש מתחיל שיחה ושולח את ההודעה "שלום, אני עולם שלם! ואז הסוכן מגיב עם הכיתוב 'שלום, עולם'.

  1. המשתמש מתחיל את השיחה עם הנציג.
  2. ברגע שהמשתמש מתחיל להקליד תשובה, הוא שולח אירוע הקלדה נציג של Google.

    {
      "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. המשתמש שולח הודעה עם הכיתוב "שלום, אני עולם!" כהודעה.

    {
      "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. הנציג שולח את ההודעה "Hello, World" כהודעה.

    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",
    }