Para utilizar a API é necessário um Token de API.
| API URL | /api/v1/call |
|---|---|
| Method | POST |
Esta API faz com que a central ligue para uma origem. Após a origem atender a chamada, a central conecta com o destino.
A API responde uma mensagem em formato JSON como retorno.
Parâmetros
| from | Telefone de Origem no formato DDD+NUMERO |
|---|---|
| to | Telefone de Destino no formato DDD+NUMERO |
| transfer | Transferir a chamada para um destino interno no Evolux (opcional) |
| extension_group | Nome do Grupo a ser usado para bilhetagem |
| audio_id | ID do Áudio para ser tocado para a Origem antes de chamar (opcional) |
max_duration | Duração máxima da chamada em segundos (opcional) |
| call_info | Informações adicionais sobre a chamada que podem ser tratadas em uma URA. (Opcional) |
| token | Token de autenticação da API |
Retorno
| source_uuid | Identificador para consultar o registro detalhado da chamada (CDR) posteriormente. |
|---|---|
| destination_uuid | Identificador para consultar o registro detalhado da chamada (CDR) posteriormente. |
Exemplos de requisição
Estes exemplos partem do princípio que existe um grupo de PABX chamado "PABX Group".
POST
URL: https://example.evolux.net.br/api/v1/call BODY: from=<DDD+NUMBER> to=<DDD+NUMBER> extension_group=<GROUP_NAME> token=<API_TOKEN>
POST - Exemplo sem Transfer
URL: https://example.evolux.net.br/api/v1/call HEADER: token=23598db235ba7293572395d87c2a35 BODY: from=1133334444 to=2122225555 extension_group=PABX%20Group
POST - Exemplo com Transfer
URL: https://example.evolux.net.br/api/v1/call HEADER: token=23598db235ba7293572395d87c2a35 BODY: to=2122225555 transfer=10000 extension_group=PABX%20Group
POST - Exemplo com Call INFO
URL: https://example.evolux.net.br/api/v1/call
HEADER:
token=23598db235ba7293572395d87c2a35
BODY:
to=2122225555
transfer=10000
extension_group=PABX%20Group
call_info=[{"type": "text","value": "exemplo_evolux","label": "cliente"}]
Os dados dos parâmetros devem ser codificados no formato de URL.
cURL - Exemplo sem Transfer
curl -H "Token: 23598db235ba7293572395d87c2a35" -d "from=1133334444&to=2122225555&extension_group=PABX%20Group&token=23598db235ba7293572395d87c2a35" https://example.evolux.net.br/api/v1/call
cURL - Exemplo com Transfer
curl -H "Token: 23598db235ba7293572395d87c2a35" -d "to=2122225555&transfer=10000&extension_group=PABX%20Group" https://example.evolux.net.br/api/v1/call
Exemplos de respostas
Sucesso
{"meta": {"status": 200, "message": "OK"}, "data": {"source_uuid": "f950b305-eC1D-4b02-ba7d-ef1eb4fcad42", "destination_uuid": "aa0226c1-fac5-53fe-c4d9-75d6442cfe66"}}
Falhas
{"meta": {"status": 400, "message": "Missing token."}}
{"meta": {"status": 400, "message": "Extension Group not found."}}
{"meta": {"status": 400, "message": "Cant't find route to destination"}}
{"meta": {"status": 422, "message": "Invalid file"}}
Perguntas Frequentes
Como obter o id do áudio?
Para obter o id do áudio é necessário navegar no menu "Monitoramento > Áudios"
Enviar um novo áudio ou clicar em 
para ver os detalhes do áudio desejado.
O id é o número que aparece na barra do navegador no formato /audio/edit/{id}.