[ API ] Gravacao de Chamadas - Relatório

Owned by Thiago dos Santos Rodrigues
Last updated: Oct 22, 2021
2 min read

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:

Campo

Descrição

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

Endereço de Chamada da API

POST /api/recording/API_TOKEN/API_KEY/id_gravacao

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.

Exclusão de Gravações de Chamadas

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