.svg?alt=media&token=d4e6f36f-8994-47d0-b855-83e47927012c)
Outbound WhatsApp
Envio de outbound para integrações de WhatsApp, e poderá ser feito com templates, mídias ou texto.
Ao habilitar a API de outbound é gerado um endpoint e um token, que serão utilizados para realizar o envio das mensagens de outbound.
O envio será semelhante a API do WhatsApp. Para envio de templates: https://developers.facebook.com/docs/whatsapp/api/messages/message-templates/interactive-message-templates
{
"to": "numero_whatsapp_destino",
"type": "template",
"context": {
"status": "aprovado"
},
"template": {
"namespace": "namespace",
"language": {
...
},
"name": "nome_do_template",
"components": [
...
]
}
"externalId": "seu_id_mensagem",
"restartContact": false | true,
"inactivityTime": 0
}
- to(string): Número do WhatsApp que irá receber a mensagem
- type(string): Tipo de mensagem que seŕa enviada (template, text, image, video, document, audio ou sticker)
- context (opcional): variáveis que serão salvas no contexto do usuário
- template(string): Conteúdo do template que será utilizado no envio
- externalId (opcional): identificador único para a mensagem a ser enviada. Este ID será retornado nos status de envio em seu webhook de status
- restartContact (opcional): booleano para resetar as variáveis de contexto do usuário
- inactivityTime (opcional): tempo em minutos que deve ser passado desde a última interação do usuário com o assistente para que a mensagem seja enviada. Exemplo: Se o usuário está interagindo ou interagiu com assistente há 1 minuto e o tempo de inatividade necessário para mensagem ser enviada é de 2 minutos ("inactivityTime": 2), a mensagem não seria enviada. Caso a interação tivesse ocorrido 3 minutos atrás, a mensagem seria enviada.
{
"to": "numero_whatsapp_destino",
"type": "text" | "audio" | "contact" | "document" | "image" | "location" | "sticker" | "video",
"text": {
"body": "Seu texto aqui!"
}
//ou
"audio": {
"id": "your-media-id",
}
//ou
"document": {
"link": "the-provider-name/protocol://the-url",
"provider": {
"name" : "provider-name"
},
"caption": "your-document-caption"
}
//ou
"video": {
"id": "your-media-id",
"caption": "your-video-caption"
}
//ou
"image": {
"link": "http(s)://the-url",
"provider": {
"name" : "provider-name"
},
"caption": "your-image-caption"
}
//ou
"sticker": {
"id": "your-media-id"
}
"externalId": "seu_id_mensagem",
"restartContact": false | true,
"inactivityTime": 0
- to(string): Número do WhatsApp que irá receber a mensagem
- type(string): Tipo de mensagem que seŕa enviada (text, image, video, document, audio ou sticker)
- text | audio | document ... (objeto): Conteúdo do elemento utilizado no envio.
Last modified 1yr ago