ALTU
Search…
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

Estrutura

1
{
2
"to": "numero_whatsapp_destino",
3
"type": "template",
4
"context": {
5
"status": "aprovado"
6
},
7
"template": {
8
"namespace": "namespace",
9
"language": {
10
...
11
},
12
"name": "nome_do_template",
13
"components": [
14
...
15
]
16
}
17
18
19
"externalId": "seu_id_mensagem",
20
"restartContact": false | true,
21
"inactivityTime": 0
22
}
Copied!

Atributos

  • 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.

Estrutura

1
{
2
"to": "numero_whatsapp_destino",
3
"type": "text" | "audio" | "contact" | "document" | "image" | "location" | "sticker" | "video",
4
5
6
"text": {
7
"body": "Seu texto aqui!"
8
}
9
10
11
//ou
12
"audio": {
13
"id": "your-media-id",
14
}
15
16
//ou
17
"document": {
18
"link": "the-provider-name/protocol://the-url",
19
"provider": {
20
"name" : "provider-name"
21
},
22
"caption": "your-document-caption"
23
}
24
25
//ou
26
"video": {
27
"id": "your-media-id",
28
"caption": "your-video-caption"
29
}
30
31
//ou
32
"image": {
33
"link": "http(s)://the-url",
34
"provider": {
35
"name" : "provider-name"
36
},
37
"caption": "your-image-caption"
38
}
39
40
//ou
41
"sticker": {
42
"id": "your-media-id"
43
}
44
45
46
"externalId": "seu_id_mensagem",
47
"restartContact": false | true,
48
"inactivityTime": 0
Copied!

Atributos

  • 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.