[ API ] Gerenciar Arquivos de Audio
- Thiago dos Santos Rodrigues
Endereço de Chamada da API
GET /api/manageAudio/API_TOKEN/API_KEY/0
Este Ponto de Acesso permite que você Gerenciar todos os Arquivos de Áudio utilizados em URAs e Filas de Atendimento.
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
GET https://sip.nextbilling.com.br/api/manageAudio/API_TOKEN/API_KEY/0
Parâmetros:
id_record: Obter o cadastro de um registro em específico
is_download: (Opcional)
1 - Realiza o download do Arquivo 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/manageAudio/7cb40d54-4ebf-55a6-875a-5f57234e97cc-9990/b12c87a7-6dd6-5f99-9b47-c7c3be66fe73-8629/0
|
Utilizando essa chamada, você obteria o retorno em JSON semelhante a saída a seguir:
Campo | Descrição |
|---|---|
error | 1 em caso de erro |
reason | Descrição caso tenha ocorrido algum erro |
records | Total de Registros encontrados na pesquisa sem a paginação solicitada |
data.id_cliente | ID do Assinante |
data.size | Tamanho do Arquivo de Audio em bytes |
data.duration | Duração do Arquivo em Segundos |
data.is_moh | 0 - Arquivos de Audio | 1 - Música de Espera |
Fazendo o Download de um Arquivo de Audio
Este Ponto de Acesso permite que você realize o download de um arquivo de audio do 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 audio.
Caso ocorra um erro na tratativa e o sistema não consiga fornecer o arquivo, você receberá um erro HTTP 404.
Exclusão de Arquivos de Audio
Endereço de Chamada da API
DELETE /api/manageAudio/API_TOKEN/API_KEY/0?id_record=23
Este Ponto de Acesso permite que você remova do Sistema um Arquivo de Audio.