API - Fazer Chamada de um Agente Logado para um Numero de Destino
Para utilizar a API é necessário um Token de API
API URL | /api/v1/call |
|---|---|
Method | POST |
Esta API utiliza um agente logado para conectar uma ligação a um destino. A chamada é gerada automaticamente na tela do agente, sem a necessidade que ele faça um atendimento prévio para que a ligação comece a ser discada para o destino.
Parâmetros
Os parâmetros devem ser enviados no corpo da requisição POST - request body (payload).
from | Login do agente logado |
|---|---|
to | Telefone de Destino no formato DDD+NUMERO |
token | Token de autenticação da API |
call_info | Informações que serão exibidas na tela do operador (Veja padrão na documentação da API Call Info) |
Exemplos de requisição
POST
URL: https://<SERVER NAME>.evolux.net.br/api/v1/call
BODY:
from=<AGENT_LOGIN>
to=<DDD+NUMBER>
call_info=<Informações em JSON>
HEADER:
Token: <API_TOKEN>POST
URL: https://example.evolux.net.br/api/v1/call
BODY:
from=john.snow
to=2122225555
call_info= [{
"label": "label-para-dado-desejado",
"type": "text",
"value": "{{ variavel-que-possui-o-dado }}"
}]
HEADER:
Token: 23598db235ba7293572395d87c2a35
cURL
curl --location --request POST 'https://evolux.evolux.io/api/v1/call' \
--header 'token: 23598db235ba7293572395d87c2a35' \
--form 'to="2122225555"' \
--form 'from="john.snow"' \
--form 'call_info="[{
\"label\": \"CPF\",
\"type\": \"text\",
\"value\": \"111.111.111-11\"
}]"' Exemplos de respostas
Sucesso
{"meta": {"status": 200, "message": "OK"}}Falhas
{"meta": {"status": 400, "message": "Missing token."}}
{"meta": {"status": 400, "message": "Missing to param."}}
{"meta": {"status": 400, "message": "Missing from param."}}
{"meta": {"status": 400, "message": "Json_string param must be a valid json string: No JSON object could be decoded"}}