Page tree
Skip to end of metadata
Go to start of metadata

Endereço de Chamada da API

/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:

Endereço da API exemplo

https://sip.nextbilling.com.br/api/recording/API_TOKEN/API_KEY
 ou
https://sip.nextbilling.com.br/api/recording/API_TOKEN/API_KEY?date_ini=2015-03-01&date_end=2015-03-30&start=0&limit=100&time_ini=08:00:00&time_end=23:50:00

Parâmetros:

  • date_ini: Data Inicial
  • time_ini: Hora Inicial
  • date_end: Data Final
  • time_end: Hora Final
  • start: Exibir registros a partir dessa contagem
  • limit: Limitar de registros a ser retornados pela chamada
  • id_record: ID da Gravação a ser listada (opcional)
  • is_download: (Opcional)
    • 1 - Realiza o download da gravação utilizando o método HTTP GET

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:

Exemplo de chamada a API utilizando cURL
$ 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:

Retorno JSON
{
   "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"
      }
   ]
}
CampoDescrição
error1 em caso de erro
reasonDescrição caso tenha ocorrido algum erro
total_recordsTotal de Registros encontrados na pesquisa sem a paginação solicitada
total_timeTempo total das Ligações em segundos
total_sizeTamanho total dos arquivos de gravação
recordsTotal de registrados retornados nessa chamada
data.customer_idID do Assinante
data.sourceQuem originou a ligação
data.destinationDestino da Ligação
data.durationTempo da Ligação
data.sizeTamanho do Arquivo de Gravação

Fazendo o Download de uma Gravação


 

Endereço de Chamada da API

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


 

Endereço de Chamada da API

DELETE /api/recording/API_TOKEN/API_KEY


Este Ponto de Acesso permite que você remova do Sistema um ou mais arquivos de Gravação. 

ATENÇÃO

Após essa operação, NÃO é possível recuperar os arquivos removidos.
Antes de realizar essa chamada, tenha certeza da ação que está realizando!

Endereço da API exemplo

DELETE https://sip.nextbilling.com.br/api/recording/API_TOKEN/API_KEY

Parâmetros:

  • type: [id] remover registros informados no campo ids | [filter]: remover registros baseado no filtro de pesquisa
  • ids: enviar um array com todos os IDs de registros que serão removidos PARA SEMPRE do sistema
  • date_ini: Data Inicial
  • date_end: Data Final
  • limit: Quantidade de registros a serem removidos