Enviar Botões
| ENDPOINT | /V1/Ativo | ||
| METHOD | POST | ||
| PARAMETERS | TYPE | DEMANDED | NOTES |
| CarteiraId | int | Obrigatório | |
| ChannelCode | string | Opcional | Informar "WHATSAPP_BUSINESS" para envio via Whatsapp Oficial |
|
ProviderCode |
string | Opcional | Informar "DIALOG_WHATSAPP" para envio via Whatsapp Oficial (somente no envio ativo - SourceId = 1 ou 4) |
|
TemplateCode |
string | Opcional |
Código do template a ser utilizado no envio de mensagem ativa via Whatsapp Oficial |
| WalletCode | string | Opcional | Poder ser enviado walletCode ou carteiraId, codigo externo da carteira |
| MessageText | string | Obrigatório | Texto vinculado do botão |
| Variables | string | Opcional |
Envio obrigatório no caso do template utilizar variáveis. Enviar um array json de objetos com as propriedades name e value em formato string. Exemplo: "[{\"name\":\"customerName\",\"value\":\"Maria\"},{\"name\":\"customerName\",\"value\":\"João\"}]" |
| MessageType | int | Obrigatório | Enviar valor 3 |
| ClientPhone | string | Obrigatório | 5511987259595 |
| ExternalId | string | Opcional | Informar um código do cliente utilizado no sistema do contratante. Será retornado em Webhook. |
| SourceId | int | Opcional | Active = 1(default) |
| Buttons | json | Obrigatório |
Exemplo: "{\"buttons\":[{\"id\":1,\"label\":\"Sim\"},{\"id\":2,\"label\":\"Não\"}]}" |
| Expires |
date | Opcional |
formato mm-dd-yyyy hh:mm:ss |
| Schedule |
date | Opcional |
formato mm-dd-yyyy hh:mm:ss |
| RETURN | TYPE | DEMANDED | NOTES |
| success | bool | ||
| message | string | ||
| data | json |
|
|
IDENTIFICAÇÃO DO CLIENTE
Para identificar um cliente, é possível enviar apenas um dentre:
ClientPhone: string - que contenha o DDI (55 - para o Brasil), DDD e TELEFONE.
ClientId: int - que seja um cliente previamente criado na carteira. (corresponde univocamente a um telefone - se informado junto com o telefone, será priorizado o telefone).
SEND - EXAMPLE
{
"ClientPhone": "5519999999999",
"CarteiraId": 278,
"MessageType"; 3,
"MessageText": "descrição do botão",
"SourceId":1,
"Buttons": "{ \"buttons\": [ { \"id\": \"1\", \"label\": \"Adoro\" }, { \"id\": \"2\", \"label\": \"Amo\" }, { \"id\": \"3\", \"label\": \"Nem Tamto\" } ] }",
"Expires":"01-30-2023 10:58:22",
"Schedule":"01-28-2023 10:58:22"
}RECEIVE EXAMPLE
{
"success": true,
"message": "Ativo enviado para processamento!",
"data": { }
}RECEIVE EXAMPLE
{
"success": false,
"message": "Carteira é obrigatório"
}