...
Tip | ||
---|---|---|
| ||
/api/cdrIvr/API_TOKEN/API_KEY/id_cliente |
...
Este Ponto de Acesso irá fornecer uma listagem das Notas de Avaliação de Atendimento fornecidas pelos clientes nas ligações Entrantes - DID.
Para consumir esses dados, informar o ID do Cliente é obrigatório. Você poderá informar na query http o parâmetro id_record para filtrar por uma URA em especifico.
Para nosso exemplo, iremos deduzir que o endereço do servidor será sip.nextbilling.com.br. Nesse caso, o endereço da API seria:
Info | ||
---|---|---|
| ||
Parâmetros HTTP:
|
A chamada para obter os dados da consulta, é realizado utilizando um HTTP GET para o endereço de consumo da API. Um exemplo de chamada a essa API seria:
Panel | ||
---|---|---|
| ||
$ curl -X GET 'https://sip.nextbilling.com.br/api/cdrIvr/7cb40d54-4ebf-55a6-875a-5f57234e97cc-9990/b12c87a7-6dd6-5f99-9b47-c7c3be66fe73-8629/3?id_record=366' |
Utilizando essa chamada, você obteria o retorno em JSON semelhante a saída a seguir:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ |
...
"error":0, |
...
"reason":"OK", |
...
"limit":1, |
...
"offset":0, |
...
"records":1, |
...
"data":[ |
...
{ "ivr_id": 3, |
...
"ivr_name": "URA DE TESTE - SUPORTE" |
...
"calldate":"2018-03-14 11:41:12", |
...
"callerid":"2199000000", |
...
"type":"TIPO", |
...
"data1":"INFO1", |
...
"data2":"INFO2", |
...
"data3":"INFO3", |
...
"dtmf":"4" |
...
} ] } |
Campo | Descrição |
---|---|
error | 1 em caso de erro |
reason | Descrição caso tenha ocorrido algum erro |
records | Total de registrados retornados nessa chamada |
data.ivr_id | ID da Ura |
data.ivr_name | Nome da Ura |
data.type | Tipo da Informação |
data.data1 | Informações Adicionais |
data.data2 | Informações Adicionais |
data.data3 | Informações Adicionais |
data.dtmf | Dígito pressionado pelo Cliente na avaliação |