Mensagens Programadas

Nossa integração é feita automaticamente conforme a configuração da Mensagem Programada.

A resposta para o contato deve ser feita no RESPONSE de cada REQUEST enviada para as URLs configuradas.

É possível acompanhar todas as integrações no painel do gestor, em: Relatórios > Integrações.

IMPORTANTE: Caso aconteça algum erro na integração o sistema não enviará a mensagem.

FLUXO DA INTEGRAÇÃO

Após a configuração da Integração e dos parâmetros da Mensagem Programada, o sistema inicia o envio. Será feito um REQUEST do tipo POST para a URL configurada, enviando o JSON com todos os dados do contato. No RESPONSE deverá ser retornado o JSON com um dos padrões abaixo, dependendo do que deseja responder para ele.

REQUESTS

O corpo da solicitação HTTP é enviado no formato JSON e atende o padrão abaixo.

Os atributos com asterisco, são obrigatórios.

● *id: código da solicitação.

● *clientId: identificação do cliente na plataforma.

● *origin: origem da integração. Valor fixo “SCHEDULED_MESSAGE” para identificar que é uma mensagem programada.

● *contact: informações do contato em nosso sistema.

○ *uid: código do contato.

○ *type: origem do contato. Por enquanto só disponibilizamos integração de mensagem programada para WHATSAPP.

○ *key: número do telefone do cliente

○ *name: nome do contato.

● data: o conteúdo desse atributo será dinâmico, pois você irá informar no campo “Payload” no cadastro de sua integração.

Veja um exemplo do corpo da solicitação que será enviada no início da integração:

{
"id": 3589818,
"clientId": 72,
"origin": "SCHEDULED_MESSAGE",
"contact": {
"uid": "15295",
"type": "WHATSAPP",
"key": "5513999999999",
"name": "João da Silva",
},
"data": {
"exemplo": "teste",
}
}

RESPONSE

As mensagens que são retornadas de seus sistema, deverão seguir alguns critérios para tudo funcionar perfeitamente.

O formato vai variar dependendo se você usa o sistema por QRCode ou API Oficial. QRCode O corpo da solicitação HTTP é enviado no formato JSON e atende ao padrão abaixo.

Os atributos com asterisco, são obrigatórios.

● *type: O tipo definirá o que nosso sistema enviará para o contato, podendo ser:

○ TEXT: Uma mensagem de texto

○ FILE: Um arquivo qualquer

○ IMAGE: Uma imagem

○ AUDIO: Um arquivo de áudio

● *value: texto que será enviado para o contato. No caso do tipo TEXT, enviar o texto que será exibido para o contato. Nos casos de FILE, IMAGE e AUDIO, enviar a URL onde está salvo. Você pode enviar uma lista (Array) com itens contendo essas informações para enviar mensagens em sequência.

Veja um exemplo do JSON que deverá vir no RESPONSE:

[
{
"type": "TEXT",
"value": "Olá!",
},
{
"type": "TEXT",
"value": "Segue seu boleto anexo",
},
{
"type": "FILE",
"value": "https://www.caceres.mt.gov.br/fotos_institucional_downloads/2.pdf",
},
{
"type": "IMAGE",
"value":
"https://upload.wikimedia.org/wikipedia/commons/thumb/1/11/Test-Logo.svg/783px-TestLogo.svg.png",
},
{
"type": "AUDIO",
"value":
"https://v2-8.mz-css.net/f4d9fd7419864476bb123b795298837a/a5ca0b5894324f8bb54b
b9fffad29d1e.mp3",
},
{
"type": "TEXT",
"value": "Fim!",
}
]