Enviar Opções
| ENDPOINT | /V1/Ativo | ||
| METHOD | POST | ||
| PARAMETERS | TYPE | DEMANDED | NOTES |
| CarteiraId | int | Obrigatório | |
| MessageText | string | Obrigatório | Texto vinculado as opções |
| AddicionalData | json | Opcional | |
| MessageType | int | Obrigatório | Enviar valor 7 |
| ClientPhone | string | Obrigatório | |
| ExternalId | string | Opcional | Informar um código do cliente utilizado no sistema do contratante. Será retornado em Webhook. |
| SourceId | int | Opcional | Active = 1(default), Client = 2, Chat = 3, Mailing = 4, Bot = 6 |
| Buttons | json | Obrigatório | |
| 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"; 7
"MessageText": "descrição das opções",
"SourceId":1,
"Buttons": "{ \"title\": \"Opções disponíveis\", \"buttonLabel\": \"Abrir lista de opções\", \"options\": [ { \"id\": \"1\", \"description\": \"Esta atendendo as necessidades da minha empresa.\", \"title\": \"Bom\" }, { \"id\": \"2\", \"description\": \"Não funcionam\", \"title\": \"Ruim\" } ] }",
"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"
}