Skip to end of banner
Go to start of banner

Listar DIDs - Numeros Entrantes

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Listar DIDs - Numeros Entrantes

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:
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:
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:
Retorno JSON
{
"error":0,
"reason":"OK",
"records":1,
"data":[
{
"id":1,
"nome_fantasia":"NEXTBILLING IP SOLUTIONS",
"status":1,
"records":2,
"data":[
{
"id":2,
"description":"Falemais",
"did_number":"551130900077",
"did_type":"6",
"status":1
},
{
"id":1,
"description":"Falemais",
"did_number":"552130900017",
"did_type":"6",
"status":1
}
]
}
]
}

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

  • No labels