Enviar Arquivo
| ENDPOINT | /V1/Ativo | ||
| METHOD | POST | ||
| PARAMETERS | TYPE | DEMANDED | NOTES |
| ChannelCode | string | Obrigatório | Canal usado para envio da mensagem |
| ProviderCode | string | Obrigatório | Provedor usado para envio da mensagem |
| CarteiraId | int | Obrigatório | |
| WalletCode | string | Opcional | Poder ser enviado walletCode ou carteiraId, codigo externo da carteira |
| MessageText | string | Obrigatório | base64 (data:application/pdf) |
| TemplateCode | string | Obrigatório | Código do template |
| FileName | string | Obrigatório | Indica o nome do arquivo com extessão. meuArquivo.docx |
| Caption | string | Opcional | pode ser usado como uma descrição ou mensagem do arquivo |
| Variables | json | Obrigatório | Caso o template possua variáveis |
| MessageType | int | Obrigatório | Enviar valor 2 |
| 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 |
| 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 |
|
|
(1) 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
{
"channelCode": "WHATSAPP_BUSINESS",
"providerCode": "DIALOG_WHATSAPP",
"MessageType": 2,
"FileName": "Boleto.pdf",
"MessageText": "data:application/pdf;base64,iVBORw0K...",
"TemplateCode": "25739_01",
"Variables": "[{\"name\":\"{{valor}}\",\"value\":\"321,00\"}, {\"name\":\"{{vencimento}}\",\"value\":\"06/09/2023\"}]",
"ClientPhone": "5519999999999",
"CarteiraId": "278",
"SourceId": 1,
"Caption": "Mensagem adicional ao arquivo / legenda",
"Expires":"01-30-2023 10:58:22",
"Schedule":"01-28-2023 10:58:22"
}RECEIVE EXAMPLE
{
"success": true,
"message": "Em processamento!",
"id": null,
"data": {
"activeId": 8747906,
"walletId": 278,
"walletCode": null,
"clientId": 24541342,
"status": "em processamento",
"messageId": null,
"externalId": null
}
}RECEIVE EXAMPLE
{
"success": false,
"message": "Carteira é obrigatório"
}