¶ Enviar mensagem por um grupo de rotas
Para enviar uma mensagem para um grupo de contatos é necessário realizar uma requisição a messages_api
Disponível a partir da versão V3.4.1
REQUEST:
POST:{sua_url}/rcx/ContactCenter/messages_api.php
HEADER:
Content-Type = multipart/form-data
BODY:
{
"action": "send_message_to_contact_group"
"entrance": "string",
"contact_group_code": "number",
"content_text": "string",
"content_file": "binary file",
"agent": "number",
"action_type": "number",
"action_aux": "number",
"template_id": "string",
"fields": "array"
}
¶ Funcionamento
- para utilizar esta funcionalidade é necessário criar um grupo de contatos, a partir do menu
Contact Center/Contatos/Ver Grupos
O sistema irá enviar a mensagem a todas as formas de contato dos contatos pertencentes ao grupo
¶ Campos da requisição
- entrance: identificador da rota de entrada (
Contact Center/ Rotas de Entrada), - contact_group_code: id do grupo de contatos (
Contact Center/Contatos/Ver Grupos) - content_text: conteúdo da mensagem
- content_file: arquivo a ser enviado
- agent: código do agente que será responsável pelo envio
- action_type: ação que deverá ser executada após o envio da mensagem
- action_aux: complemento da ação que será executada após o envio
- template_id: id do template a ser enviado (
somente whatapp api) - fields: campos das variáveis (lacunas) do template
¶ Ações após envio
Os campos action_type e action_aux são utilizados para definir o que deve acontecer com o atendimento após o envio da mensagem ser concluída.
action_type
action_type = 1 - finalizar o atendimento após o envio da mensagem;
action_type = 2 - transferir o atendimento para a fila informada no action_aux;
action_type = 3 - transferir o atendimento para o agente/ bot informado no action_aux;
action_aux
o campo action_aux é obrigatório. Quando o action_type for igual a 1 (finalizar atendimento), 2 (transfeir para fila) ou 3 (transferir para agente/ bot)
o campo action_aux deve ser o código da tabulação quando o action_type for igual a 1
o campo action_aux deve ser o código de uma fila quando o action_type for igual a 2
o campo action_aux deve ser o código de um agente ou bot quando o action_type for igual a 3
¶ Respostas da requisição
200 OK
{
"status": "success",
"message": "your request has been accepted",
"payload": {
"request_id": "b8c36519-e038-4988-9762-527dab1e1823"
},
"code": 200
}
400 BAD REQUEST
{
"status": "error",
"message": "mensagem do erro",
"code": 400
}
¶ 
Configurando os campos de um template
¶ Canal whatsapp
Para enviar um template através de um canal de whatsapp é necessário informar o id do template no campo template_id da requisição.
¶ Demais canais
Para os demais canais de chat não é necessário enviar campo o template_id, apenas o campo content_text e o campo fields
¶ 
Funcionamento
Quando um template possui variáveis (lacunas), é necessário enviar um array contento o nome da varíavel (lacuna) e seu valor:
[
{
"name": "nome da varíavel (lacuna) no template",
"value": "valor da variável (lacuna)"
}
]
¶ Exemplo
content_text: "Ola {{nome}} sua consulta está marcada para o dia {{data_consulta}}"
Para preencher as lacunas você deverá enviar o fields da seguinte forma
[
{
"name": "nome",
"value": "meu cliente"
},
{
"name": "data_consulta",
"value": "sua data preferida"
}
]
¶ Utilizando campos do contato como variável
Você pode preencher as variáveis de um template (lacunas) com campos do contato, para isso você deve informar o valor da variável como um campo do contato, sa seguinte forma:
[
{
"name": "nome",
"value": "{contact_name}" <--
},
{
"name": "data_consulta",
"value": "sua data preferida"
}
]
O sistema irá trocar a chave {contact_name} enviada como valor da variável (lacuna) pelo nome do contato cadastrado no Orpen.
Você pode utilizar os seguintes campod do contato
{contact_name}: nome do contato{contact_uci}: uci do contato{contact_cpf}: cpf do contato{contact_cnpj: cnpj do contato
Como a requisição deve ser enviada por
multipart/form-data, o array defieldsdeverá ter o seguinte formato
fields[0][name] = "nome da variavel"
fields[0][value] = "valor da variavel"
fields[1][name] = "nome da variavel"
fields[1][value] = "valor da variavel"