...
...
...
| Tip | ||
|---|---|---|
| ||
/api/recording/API_TOKEN/API_KEY(/id_assinante) |
...
Este Ponto de Acesso irá fornecer uma listagem das Gravações de Chamadas presentes no Sistema.
Se estiver utilizando Tokens de Acesso do Nível Master ou Nível Revenda, poderá especificar o ID DO CLIENTE como último parâmetro da URL para obter a listagem de um Cliente de ID especifico.
Caso essa API seja chamada utilizando os Tokens de Acesso do Nível Assinante, não é necessário informar o ID e será retornado a listagem do Assinante em questão.
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 | ||
|---|---|---|
| ||
https://sip.nextbilling.com.br/api/recording/API_TOKEN/API_KEY Parâmetros:
|
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/recording/7cb40d54-4ebf-55a6-875a-5f57234e97cc-9990/b12c87a7-6dd6-5f99-9b47-c7c3be66fe73-8629?date_ini=2018-01-01&date_end=2018-02-01&time_ini=&time_end=' |
Utilizando essa chamada, você obteria o retorno em JSON semelhante a saída a seguir:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{ |
...
"error":0, |
...
"reason":"OK", |
...
"total_records":539, |
...
"total_time":89207, |
...
"total_time_text":"1.486 min 47 seg", |
...
"total_size":"333,95 Mb", |
...
"limit":1, |
...
"offset":0, |
...
"records":1, |
...
"data":[ |
...
{ "record_id":1976, |
...
"customer_id":3, |
...
"calldate":"2018-03-14 14:03:46", |
...
"clid":"sup9001", |
...
"source":"sup9001", |
...
"destination":"9003", |
...
"duration":68, |
...
"duration2":"1 min 08 seg", |
...
"size":"267,86 Kb" |
...
} ] } |
| Campo | Descrição |
|---|---|
| error | 1 em caso de erro |
| reason | Descrição caso tenha ocorrido algum erro |
| total_records | Total de Registros encontrados na pesquisa sem a paginação solicitada |
| total_time | Tempo total das Ligações em segundos |
| total_size | Tamanho total dos arquivos de gravação |
| records | Total de registrados retornados nessa chamada |
| data.customer_id | ID do Assinante |
| data.source | Quem originou a ligação |
| data.destination | Destino da Ligação |
| data.duration | Tempo da Ligação |
| data.size | Tamanho do Arquivo de Gravação |
Fazendo o Download de uma Gravação
...
| Tip |
|---|
...
| ||
GET /api/recording/API_TOKEN/API_KEY/?id_record=XX&is_download=1 |
Este Ponto de Acesso permite que você realize o download de uma gravação de chamada no Sistema. Os arquivos baixados sempre são arquivos no formato MP3.
Uma vez que essa API é chamada, o sistema irá retornar o arquivo em modo RAW, portanto, após essa chamada você deve tratar o retorno como o arquivo de gravação.
Caso ocorra um erro na tratativa e o sistema não consiga fornecer o arquivo, você receberá um erro HTTP 404.
Para realizar o download, basta utilizar o método GET enviando os parâmetros na query: id_record=XX e is_download=1
Exclusão de Gravações de Chamadas
...
| Tip | ||
|---|---|---|
| ||
DELETE /api/recording/API_TOKEN/API_KEY |
Este Ponto de Acesso permite que você remova do Sistema um ou mais arquivos de Gravação.
| Warning | ||
|---|---|---|
| ||
Após essa operação, NÃO é possível recuperar os arquivos removidos. |
| Info | ||
|---|---|---|
| ||
DELETE https://sip.nextbilling.com.br/api/recording/API_TOKEN/API_KEY
|