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

Endereço de Chamada da API

/api/listAudio/API_TOKEN/API_KEY(/id_assinante)

 

Este Ponto de Acesso irá fornecer uma listagem dos Arquivos de Áudio cadastrados por cada Assinante. 
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 um arquivo de Áudio 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:

Endereço da API exemplo


https://sip.nextbilling.com.br/api/listAudio/API_TOKEN/API_KEY(/id_assinante)
 ou
https://sip.nextbilling.com.br/api/listAudio/API_TOKEN/API_KEY(/id_assinante)?id_record=1

Parâmetros HTTP:

  • id_record: Opcional: ID específico do Áudio desejado

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

Retorno JSON
{
   "error":0,
   "reason":"OK",
   "records":1,
   "data":[
      {
         "id":3,
         "nome_fantasia":"NEXTBILLING",
         "status":1,
         "records":2,
         "data":[
            {
               "id":3,
               "description":"Audio espera",
               "size":"5,20 Mb",
               "duration":"3 min 46 seg",
               "type":"MOH",
               "status":1
            },
            {
               "id":1,
               "description":"Audio Principal",
               "size":"948,88 Kb",
               "duration":"0 min 00 seg",
               "type":"AUDIO",
               "status":1
            }
         ]
      }
   ]
}
CampoDescrição
error1 em caso de erro
reasonDescrição caso tenha ocorrido algum erro
recordsTotal de registrados retornados nessa chamada
data.idID do Cliente
data.nome_fantasiaNome do Cliente
data.recordsQuantidade de Áudios para esse Cliente
data.dataArray contendo os registros deste Assinante
data.data.idID da Linha
data.data.typeAUDIO: Arquivo de Áudio | MOH: Música de Espera
data.data.statusStatus atual do Registro
  • No labels