Hello World

Das Senden und Empfangen von Nachrichten und Ereignissen ist der wichtigste Aspekt der Kommunikation zwischen einem Agent und einem Nutzer. Agents senden Nachrichten, Ereignisse und Anfragen an Nutzer über die Business Messages API, empfangen aber von Nutzern erstellte Nachrichten und Ereignisse in ihren Webhooks als JSON.

Im Beispiel unten sehen Sie anhand von Beispieldaten, wie Nachrichten, Ereignisse und Anfragen nützliche und aussagekräftige Interaktionen ermöglichen können.

In diesem Beispiel startet der Nutzer eine Unterhaltung und sendet die Nachricht „Hello, I!#“. Anschließend antwortet der Agent mit „Hello, World“.

1. Der Nutzer beginnt die Unterhaltung mit dem Agent.

2. Sobald der Nutzer beginnt, eine Antwort einzugeben, sendet er ein Eingabeereignis an den Agent.

   {
     "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. Der Nutzer sendet „Hello, I!“ als Nachricht.

   {
     "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. Der Agent sendet eine Nachricht an „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. Nach der Nachrichtenzustellung gibt das Gerät des Nutzers einen Zustellungsbeleg zurück.

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