...
| Tip |
|---|
| title | Endereço de Chamada da API |
|---|
|
/api/listDid/API_TOKEN/API_KEY(/id_assinante) |
Este Ponto de Acesso irá fornecer uma listagem de todos os DIDs do Sistema, separados pelo seu Dono.
Você poderá filtrar os DIDs de um Assinante em especifico ou até mesmo filtrar um DID pelo Assinante e pelo ID do DID;
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 |
|---|
| title | Endereço da API exemplo |
|---|
|
https://sip.nextbilling.com.br/api/listDid/API_TOKEN/API_KEY(/id_assinante)?id_record= |
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 |
|---|
| title | Exemplo de chamada a API utilizando cURL |
|---|
|
$ curl -X GET 'https://sip.nextbilling.com.br/listDid/7cb40d54-4ebf-55a6-875a-5f57234e97cc-9990/b12c87a7-6dd6-5f99-9b47-c7c3be66fe73-8629/3?id_record=1' |
Utilizando essa chamada, você obteria o retorno em JSON semelhante a saída a seguir:
| Code Block |
|---|
| language | groovy |
|---|
| theme | Midnight |
|---|
| title | Retorno JSON |
|---|
|
{ |
...
...
...
...
...
...
"nome_fantasia":"NEXTBILLING IP SOLUTIONS", |
...
...
...
...
...
"description":"Falemais", |
...
"did_number":"551130900077", |
...
...
...
...
"description":"Falemais", |
...
"did_number":"552130900017", |
...
...
...
| Campo | Descrição |
|---|
| error | 1 em caso de erro |
|---|
| reason | Descrição caso tenha ocorrido algum erro |
|---|
| records | Total de registrados retornados nessa chamada |
|---|
| data.id | ID do Cliente |
|---|
| data.records | Quantidade de Registros para o Cliente |
|---|
| data.data | Array com todos os Registros do Cliente |
|---|
| data.data.id | ID do DID |
|---|
| data.data.description | Descrição do DID no Sistema |
|---|
| data.data.did_type | - 0 - Número Entrante
- 1 - Chamar Linha IP
- 2 - Portal de Voz
- 3 - Menu de CallingCard
- 4 - Menu de Ramal
- 5 - Fila de Atendimento
- 6 - Menu de URA (IVR)
- 7 - CallBack Livre
- 8 - CallBack com Auth
- 9 - Menu de URA Reversa
|
|---|
| data.data.status | Status do DID |
|---|