Ciao mondo

Inviare e ricevere messaggi ed eventi sono gli aspetti fondamentali della comunicazione tra un agente e un utente. Gli agenti inviano messaggi, eventi e richieste agli utenti tramite l'API Business Messages, ma ricevere messaggi ed eventi creati dall'utente ai loro webhook in formato JSON.

Di seguito è riportato un esempio di flusso di conversazione in cui vengono utilizzati dati di esempio per spiegare come messaggi, eventi e richieste possono creare interazioni utili e significative.

In questo esempio, l'utente avvia una conversazione e invia il messaggio "Ciao, Sono il mondo!", poi l'agente risponde con "Hello, World".

1. L'utente avvia la conversazione con l'agente.

2. Quando l'utente inizia a digitare una risposta, invia un evento di digitazione all' un agente.

   {
     "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. L'utente invia "Ciao, sono il mondo!". come messaggio.

   {
     "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. L'agente invia "Hello World" come messaggio.

   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. Al momento della consegna del messaggio, il dispositivo dell'utente restituisce una ricevuta di recapito.

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