Dialogflow: Solicitação de Webhook Fulfilment

Se você está construindo um Agente de Dialogflow que usa Fulfillment extensivamente, você achará os dados passados pelo provedor de canais úteis para sua aplicação. Esses dados são passados da plataforma respond.io para Dialogflow usando o campo originalDetectIntentRequest.

Objeto do Contato

Para permitir casos de uso mais avançados da API, o objeto Contato é anexado à solicitação da plataforma. O item cId no objeto Contato reflete o mesmo valor usado na API de Contatos.

    "contact": {  
        "cId": "60133386712",  
        "contactId": 123456,  
        "channelId": 7890  
}

Facebook

"originalDetectIntentRequest": {  
    "carga útil": {  
      "fonte": "facebook",  
      "contato": {  
        "cId": "3854977680200098",  
        "contactId": "123456",  
        "channelId": "7890"  
      },  
      "anexos": \[  
        {  
          "tipo": "localização",  
          "carga útil": {  
            "lat": 3,146642,  
            "longo": 101.695847,  
            "endereço": "Centro da cidade de Kuala Lumpur"  
          }  
        }  
      \],  
      "corpo": {  
        "entrada": \[  
          {  
            "mensagens": \[  
              {  
                "destinatário": {  
                  "id": "177689475607202"  
                },  
                "mensagem": {  
                  "texto": "oi",  
                  "meio": "D3DJuA0YlOgDgOybFG1M2ZHoJg9hq9IAjMQE2ps6RIN4QJ25rNPMi"  
                },  
                "carimbo de data/hora": 1564743055901,  
                "remetente": {  
                  "id": "2254108171328398"  
                }  
              }  
            \],  
            "id": "177689475607202",  
            "tempo": 1564743056313  
          }  
        \],  
        "objeto": "página"  
      }  
    }  
}

LINE

"originalDetectIntentRequest": {  
  "carga útil": {  
    "fonte": "linha",  
    "contato": {  
        "cId": "U905251b5f5759acde5e4788681c04269",  
        "contactId": 123456,  
        "channelId": 7890  
    },  
    "anexos": \[  
        {  
          "tipo": "localização",  
          "carga útil": {  
            "lat": 3.146642,  
            "long": 101.695847,  
            "endereço": "Centro da cidade de Kuala Lumpur"  
          }  
        }  
      \],  
    "corpo": {  
      "eventos": \[  
        {  
          "tipo": "mensagem",  
          "replyToken": "16a59224c65b4c5cbecedc4f3504599b",  
          "fonte": {  
            "userId": "U905251b5f5759bbde5e4788681c04170",  
            "type": "user"  
          },  
          "timestamp": 1593146060317,  
          "mode": "active",  
          "message": {  
            "type": "text",  
            "id": "12211455206333",  
            "text": "Olá"  
          }  
        }  
      \],  
      "destino": "U5698920083824716136c04633a9e1710"  
    }  
  }  
}

Twilio SMS

"originalDetectIntentRequest": {  
  "carga útil": {  
    "fonte": "twilio",  
    "contato": {  
        "cId": "+12262120005",  
        "contactId": 123456,  
        "channelId": 7890  
    },  
    "anexos": \[  
        {  
          "tipo": "localização",  
          "carga útil": {  
            "lat": 3,146642,  
            "long": 101.695847,  
            "address": "Centro da cidade de Kuala Lumpur"  
          }  
        }  
      \],  
    "body": {  
      "ToCountry": "CA",  
      "ToState": "Ontário",  
      "SmsMessageSid": "SM1f1c9a30ff67cf5b1a89d5b1e0735a2b",  
      "NumMedia": "0",  
      "ToCity": "",  
      "FromZip": "",  
      "SmsSid": "SM1f1c9a30ff67cf5b1a89d5b1e0735a2b",  
      "FromState": "Ontário",  
      "SmsStatus": "recebido",  
      "FromCity": "St Thomas",  
      "Body": "Olá",  
      "FromCountry": "CA",  
      "To": "+12267022870",  
      "ToZip": "",  
      "NumSegments": "1",  
      "MessageSid": "SM1f1c9a30ff67cf5b1a89d5b1e0735a2b",  
      "AccountSid": "AC75bcf6cd15a35c46c6e5fa6d6dde6028",  
      "De": "+12262121015",  
      "ApiVersion": "2010-04-01"  
    }  
  }  
}

SMS MessageBird

"originalDetectIntentRequest": {  
  "carga útil": {  
    "fonte": "mensagem\_bird",  
    "contato": {  
        "cId": "16364923690"  
    },  
    "anexos": \[  
        {  
          "tipo": "localização",  
          "carga útil": {  
            "lat": 3,146642,  
            "long": 101,695847,  
            "endereço": "Kuala Centro da cidade de Lumpur"  
          }  
        }  
      \],  
    "corpo": {  
      "corpo": "Olá",  
      "createdDatetime": "2020-06-26T07:51:30+00:00",  
      "data": "1593186690",  
      "data\_utc": "1593157890",  
      "id": "6c4c8c58eb204e69ae7d07e309c5a11c",  
      "invocationId": "477a8bc9-a4ec-45db-98e0-3b982898945a",  
      "message": "Olá",  
      "message\_id": "026a4c0e38954e5684757ba1de645130",  
      "originator": "12267022870",  
      "payload": "Olá",  
      "receiver": "12262121015",  
      "recipient": "12262121015",  
      "reference": "88003423322",  
      "remetente": "12267022870"  
    }  
  }  
}

Vonage SMS

"originalDetectIntentRequest": {  
  "payload": {  
    "source": "nexmo",  
    "contact": {  
        "cId": "60133386712"  
    },  
    "body": {  
      "msisdn": "12012938397",  
      "to": "12012938397",  
      "messageId": "16000002AB5DBF42",  
      "text": "Olá",  
      "type": "texto",  
      "palavra-chave": "OI",  
      "chave-api": "2787fb30",  
      "carimbo-de-data-hora-da-mensagem": "2020-04-27 09:00:08"  
    }  
  }  
}

Telegram

"originalDetectIntentRequest": {  
  "carga útil": {  
    "fonte": "telegrama",  
    "contato": {  
        "cId": "928825753",  
        "contactId": 123456,  
        "channelId": 7890  
    },  
    "anexos": \[  
        {  
          "tipo": "localização",  
          "carga útil": {  
            "lat": 3,146642,  
            "longo": 101.695847,  
            "endereço": "Centro da cidade de Kuala Lumpur"  
          }  
        }  
      \],  
    "corpo": {  
      "atualização\_id": 68062810,  
      "mensagem": {  
        "mensagem\_id": 358,  
        "de": {  
          "id": 921815852,  
          "é\_bot": falso,  
          "primeiro\_nome": "Leo",  
          "código\_idioma": "en"  
        },  
        "chat": {  
          "id": 921815852,  
          "primeiro\_nome": "Leo",  
          "tipo": "privado"  
        },  
        "data": 1593415824,  
        "texto": "Olá"  
      }  
    }  
  }  
}

Twitter

"originalDetectIntentRequest": {  
  "payload": {  
    "source": "twitter",  
    "contact": {  
        "cId": "800244779787258095",  
        "contactId": 123456,  
        "channelId": 7890  
    },  
    "body": {  
      "for\_user\_id": "800244779786258096",  
      "direct\_message\_events": \[  
        {  
          "type": "message\_create",  
          "id": "1277881813680091140",  
          "created\_timestamp": "1593505740934",  
          "message\_create": {  
            "target": {  
              "recipient\_id": "800244779786258096"  
            },  
            "sender\_id": "1236829623670812661",  
            "message\_data": {  
              "text": "Olá",  
              "entities": {  
                "hashtags": \[\],  
                "symbols": \[\],  
                "user\_mentions": \[\],  
                "urls": \[\]  
              }  
            }  
          }  
        }  
      \],  
      "users": {  
        "1236829623670812661": {  
          "id": "1236829623670812661",  
          "created\_timestamp": "1583718145786",  
          "name": "leoawesome",  
          "screen\_name": "leoawesome21",  
          "protected": false,  
          "verified": false,  
          "followers\_count": 0,  
          "friends\_count": 1,  
          "statuses\_count": 0,  
          "profile\_image\_url": "http://abs.twimg.com/sticky/default\_profile\_images/default\_profile\_normal.png",  
          "profile\_image\_url\_https": "https://abs.twimg.com/sticky/default\_profile\_images/default\_profile\_normal.png"  
        },  
        "800244779786258096": {  
          "id": "800244779786258096",  
          "created\_timestamp": "1479628198125",  
          "name": "respond.io",  
          "screen\_name": "respond\_io",  
          "description": "https://t.co/8AN2CVzhwJ é uma plataforma de mensagens empresariais que conecta clientes de qualquer canal a toda a equipe.",  
          "url": "https://t.co/vE593YRZwo",  
          "protected": false,  
          "verified": false,  
          "followers\_count": 246,  
          "friends\_count": 23,  
          "statuses\_count": 1527,  
          "profile\_image\_url": "http://pbs.twimg.com/profile\_images/1250330944067653632/3KiCeUhc\_normal.jpg",  
          "profile\_image\_url\_https": "https://pbs.twimg.com/profile\_images/1250330944067653632/3KiCeUhc\_normal.jpg"  
        }  
      }  
    }  
  }  
}

Viber

"originalDetectIntentRequest": {  
  "carga útil": {  
    "fonte": "viber",  
    "contato": {  
        "cId": "T1yTBK3PQTHAFchsDh1skA==",  
        "contactId": 123456,  
        "channelId": 7890  
    },  
    "anexos": \[  
        {  
          "tipo": "localização",  
          "carga útil": {  
            "lat": 3.146642,  
            "longo": 101.695847,  
            "endereço": "Centro da cidade de Kuala Lumpur"  
          }  
        }  
      \],  
    "corpo": {  
      "evento": "mensagem",  
      "carimbo de data/hora": 1593420787910,  
      "chat\_nome do host": "BN-CHAT-14\_",  
      "mensagem\_token": 5458312086267550000,  
      "remetente": {  
        "id": "T1yTBK3PQFGAGdhsDh1skA==",  
        "nome": "Leo",  
        "avatar": "https://media-direct.cdn.viber.com/download\_photo?dlid=tHBOJafTJ8WSwoFLCQ0x1lmS8RXeDXXyUVoAoLmmOGPIMprwqNCUO6BH3cG-VoAYd3WetLrBK4nP7C86ZN3MxG5T40A1lduzChAts-ULz0oO9l7FjW3bAYljiLyTGkYbaCRjcQ&fltp=jpg&imsz=0000",  
        "idioma": "en",  
        "país": "MEU",  
        "api\_versão": 8  
      },  
      "mensagem": {  
        "texto": "Olá",  
        "tipo": "texto"  
      },  
      "silencioso": falso  
    }  
  }  
}

WeChat

"originalDetectIntentRequest": {  
  "carga útil": {  
    "fonte": "wechat",  
    "contato": {  
        "cId": "ovYOJv8eZlJ5efKToATGeOk5hBQM",  
        "contactId": 123456,  
        "channelId": 7890  
    },  
    "anexos": \[  
        {  
          "tipo": "localização",  
          "carga útil": {  
            "lat": 3.146642,  
            "longo": 101.695847,  
            "endereço": "Centro da cidade de Kuala Lumpur"  
          }  
        }  
      \],  
    "corpo": {  
      "xml": {  
        "ParaNomeDoUsuário": \[  
          "gh\_5b17802cd972"  
        \],  
        "DeNomeDoUsuário": \[  
          "ovYOJv8eZlJ5evMToATGePk5hAQM"  
        \],  
        "CreateTime": \[  
          "1593421765"  
        \],  
        "MsgType": \[  
          "texto"  
        \],  
        "Conteúdo": \[  
          "Olá"  
        \],  
        "MsgId": \[  
          "22812312807562437"  
        \]  
      }  
    }  
  }  
}

Webchat

"originalDetectIntentRequest": {  
  "carga útil": {  
    "fonte": "webchat",  
    "contato": {  
        "cId": "e6507476-e507-4503-9652-bcde24e8ea88",  
        "contactId": 123456,  
        "channelId": 7890  
    },  
    "corpo": {  
      "remetente": {  
        "id": "07f1e397-12a8-485b-a417-14d7e3837608",  
        "localidade": "en\_US"  
      },  
      "destinatário": {  
        "id": "4db00a5db70efbb51a0cd6a6635918390dd1945a89ce77898ab66b82d5c15344"  
      },  
      "consulta": \[  
        {  
          "tipo": "consulta",  
          "texto": "Olá"  
        }  
      \]  
    }  
  }  
}

WhatsApp Business API

"originalDetectIntentRequest": {  
"carga útil": {  
"corpo": {  
"objeto": "whatsapp\_business\_conta",  
"entrada": \[  
{  
"alterações": \[  
{  
"valor": {  
"contatos": \[  
{  
"wa\_id": "60124438291",  
"perfil": {  
"nome": "Shahzad"  
}  
}  
\],  
"metadados": {  
"display\_phone\_number": "15550468615",  
"phone\_number\_id": "106875742284151"  
},  
"mensagens\_produto": "whatsapp",  
"mensagens": \[  
{  
"id": "wamid.HBgLNjAxMjQ0MzgyOTEVAgASGBYzRUIwOTA1ODAxRUQ5MDAxOTI1QTcxAA==",  
"tipo": "texto",  
"de": "60124438291",  
"carimbo de data/hora": "1680061817",  
"texto": {  
"corpo": "Conte-me uma piada"  
}  
}  
\]  
},  
"campo": "mensagens"  
}  
\],  
"id": "106024152370383"  
}  
\]  
},  
"fonte": "whatsapp\_business",  
"contato": {  
"cId": "60124438291",  
"contatoId": 38,  
"canalId": 59  
}  
}  
}

API do WhatsApp Cloud

"originalDetectIntentRequest": {  
        "payload": {  
            "body": {  
                "entry": \[  
                    {  
                        "id": "106024152370383",  
                        "changes": \[  
                            {  
                                "field": "messages",  
                                "value": {  
                                    "messaging\_product": "whatsapp",  
                                    "messages": \[  
                                        {  
                                            "id": "wamid.HBgLNjAxMjQ0MzgyOTEVAgASGBYzRUIwMjM1OUQ4NkE4MUJDRDY1QkE0AA==",  
                                            "timestamp": "1680063507",  
                                            "text": {  
                                                "body": "Me conte uma piada"  
                                            },  
                                            "from": "60124438291",  
                                            "type": "text"  
                                        }  
                                    \],  
                                    "metadata": {  
                                        "display\_phone\_number": "15550468615",  
                                        "phone\_number\_id": "106875742284151"  
                                    },  
                                    "contacts": \[  
                                        {  
                                            "wa\_id": "60124438291",  
                                            "profile": {  
                                                "name": "Shahzad"  
                                            }  
                                        }  
                                    \]  
                                }  
                            }  
                        \]  
                    }  
                \],  
                "object": "whatsapp\_business\_account"  
            },  
            "contact": {  
                "cId": "60124438291",  
                "channelId": 45,  
                "contactId": 43  
            },  
            "source": "whatsapp\_cloud"  
        }  
    }

Twilio do WhatsApp

"originalDetectIntentRequest": {  
  "carga útil": {  
    "fonte": "twilio\_whatsapp",  
    "contato": {  
        "cId": "whatsapp:+60133385703",  
        "contactId": 123456,  
        "channelId": 7890  
    },  
    "anexos": \[  
        {  
          "tipo": "localização",  
          "carga útil": {  
            "lat": 3.146642,  
            "longo": 101.695847,  
            "endereço": "Centro da cidade de Kuala Lumpur"  
          }  
        }  
      \],  
    "corpo": {  
      "SmsMessageSid": "SMb16231017683857d42ca62aafabcf205",  
      "NumMedia": "0",  
      "SmsSid": "SMb16231017683857d42ca62aafabcf205",  
      "SmsStatus": "recebido",  
      "Corpo": "Olá",  
      "Para": "whatsapp:+14155238886",  
      "NumSegments": "1",  
      "MessageSid": "SMb16231017683857d42ca62aafabcf205",  
      "AccountSid": "AC75bcf6cd15a35c46c6e5fa6d6dde6028",  
      "De": "whatsapp:+60144486813",  
      "ApiVersion": "2010-04-01"  
    }  
  }  
}

WhatsApp MessageBird

"originalDetectIntentRequest": {  
  "carga útil": {  
    "fonte": "mensagem\_bird\_whatsapp",  
    "contato": {  
        "cId": "60133385712",  
        "contactId": 123456,  
        "channelId": 7890  
    },  
    "anexos": \[  
        {  
          "tipo": "localização",  
          "carga útil": {  
            "lat": 3.146642,  
            "longo": 101.695847,  
            "endereço": "Centro da cidade de Kuala Lumpur"  
          }  
        }  
      \],  
    "corpo": {  
      "contato": {  
        "atributos": {},  
        "createdDatetime": "2020-05-18T03:02:01Z",  
        "customDetails": {},  
        "displayName": "60123376813",  
        "primeiroNome": "",  
        "href": "https://contacts.messagebird.com/v2/contacts/32845951f19c43d0b4e3371df0da941a",  
        "id": "32845951f19c43d0b4e3371df0da941a",  
        "sobrenome": "",  
        "msisdn": 60123376813,  
        "data e hora atualizadas": "2020-05-18T03:02:01Z"  
      },  
      "conversa": {  
        "contactId": "32845951f19c43d0b4e3371df0da941a",  
        "createdDatetime": "2020-05-18T03:02:01Z",  
        "id": "64d59ed4cb4f419ca39114c292c1a597",  
        "lastReceivedDatetime": "2020-06-26T08:58:55.7451283Z",  
        "status": "ativo",  
        "updatedDatetime": "2020-06-25T08:59:30.877791342Z"  
      },  
      "mensagem": {  
        "channelId": "f4b115e89415407ab2b97fe85ad3d191",  
        "conteúdo": {  
          "texto": "Olá"  
        },  
        "conversationId": "64d59ed4cb4f419ca39114c292c1a597",  
        "createdDatetime": "2020-06-26T08:58:55Z",  
        "direction": "recebido",  
        "from": "+60123376813",  
        "id": "91c8268bb72b412cab3b4080a974c5dc",  
        "platform": "whatsapp",  
        "status": "recebido",  
        "to": "+6531290788",  
        "type": "text",  
        "updatedDatetime": "2020-06-26T08:58:55.750324338Z"  
      },  
      "tipo": "mensagem.criada"  
    }  
  }  
}

Vonage do WhatsApp

"originalDetectIntentRequest": {  
  "carga útil": {  
    "fonte": "nexmo\_whatsapp",  
    "contato": {  
        "cId": "60133386712",  
        "contactId": 123456,  
        "channelId": 7890  
    },  
    "anexos": \[  
        {  
          "tipo": "localização",  
          "carga útil": {  
            "lat": 3,146642,  
            "longo": 101.695847,  
            "endereço": "Centro da cidade de Kuala Lumpur"  
          }  
        }  
      \],  
    "corpo": {  
      "mensagem\_uuid": "2b53f909-1640-471f-a44d-e4cb9bd00c44",  
      "para": {  
        "tipo": "whatsapp",  
        "número": "12012938397"  
      },  
      "de": {  
        "tipo": "whatsapp",  
        "número": "60133285813"  
      },  
      "carimbo de data/hora": "2020-06-29T04:37:21.876Z",  
      "mensagem": {  
        "conteúdo": {  
          "tipo": "texto",  
          "texto": "Olá"  
        }  
      },  
      "direção": "entrada"  
    }  
  }  
}

WhatsApp 360dialog v1

"originalDetectIntentRequest": {  
  "carga útil": {  
    "fonte": "mensagem\_pipe\_whatsapp",  
    "contato": {  
        "cId": "60133386712",  
        "contactId": 123456,  
        "channelId": 7890  
    },  
    "anexos": \[  
        {  
          "tipo": "localização",  
          "carga útil": {  
            "lat": 3.146642,  
            "longo": 101.695847,  
            "endereço": "Centro da cidade de Kuala Lumpur"  
          }  
        }  
      \],  
    "corpo": {  
      "ambiente": {  
        "app\_id": "476"  
      },  
      "eventos": \[  
        {  
          "nome": "d360\_whatsapp\_message\_in",  
          "propriedades": {  
            "pilha\_id": "85256128299",  
            "mensagem\_id": "IY2Cx8lhx0E0M",  
            "conversa\_id": "K7SWYeCmed07C",  
            "tipo": "texto",  
            "conteúdo": {  
              "corpo": "Olá"  
            }  
          },  
          "carimbo de data/hora": "1593502341000",  
          "id": "7a104e27-d4d2-4e5d-8c8a-c74f3ba8e6c1"  
        }  
      \],  
      "dispositivo": {  
        "mdn": "60133286713",  
        "nome\_do\perfil": "Leo"  
      },  
      "id\_do\destinatário": "64f0699c-e005-409d-b177-6a975c61ba60"  
    }  
  }  
}

WhatsApp 360dialog v2

"originalDetectIntentRequest": {  
  "carga útil": {  
    "fonte": "360dialog\_whatsapp",  
    "contato": {  
        "cId": "60133386712",  
        "contactId": 123456,  
        "channelId": 7890  
    },  
    "anexos": \[  
        {  
          "tipo": "localização",  
          "carga útil": {  
            "lat": 3.146642,  
            "longo": 101.695847,  
            "endereço": "Centro da cidade de Kuala Lumpur"  
          }  
        }  
      \],  
    "corpo": {  
      "contatos": \[  
        {  
          "perfil": {  
            "nome": "John Don"  
          },  
          "wa\_id": "923339883320"  
        }  
      \],  
      "mensagens": \[  
        {  
          "de": "923339885509",  
          "id": "ABEGkjM5iFUJAhDGiqsifkiyZkH6HzvBfO2m",  
          "texto": {  
            "corpo": "Olá"  
          },  
          "carimbo de data/hora": "1595240228",  
          "tipo": "texto"  
        }  
      \]  
    }  
  }  
}

FAQ e Solução de Problemas

Payload não é suportado

Quaisquer payloads não suportados, por exemplo, cartões Google Assistente, não aparecerão na plataforma e serão ignorados por respond.io.

Formato incorreto do payload

Os formatos de carga são rigorosos e quaisquer valores de chave ausentes resultariam em resultados indesejáveis, ou seja, não apareceriam na plataforma, aparecendo incorretamente, etc.

Latência de tempo mais do que 5 segundos

Se tiver critérios de cumprimento complexos, por exemplo, conectando a algum serviço de terceiros que consulta antes de retornar uma resposta, então você deve considerar a latência do tempo conforme descrito na documentação Dialogflow aqui. A resposta precisa ser retornada dentro de 5 segundos, caso contrário, o webhook falhará e nenhuma resposta será retornada para DialogFlow e respond.io.