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

Endereço de Chamada da API

POST /api/assignDid/API_TOKEN/API_KEY

Este Ponto de Acesso irá permitir que você vincule um Número Entrante (DID) existente para um Assinante.
Com esta API, você poderá realizar a listagem de números entrantes (DID) e exibir em seu App, seu cliente escolherá um produto e já vinculará automaticamente a ele, tornando o processo de compra de DIDs completamente automatizado.

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

POST https://sip.nextbilling.com.br/api/assignDid/API_TOKEN/API_KEY

Parâmetros:

  • id: ID do DID que será vinculado
  • customer_id: ID do cliente que irá receber o DID
  • type: Tipo do DID (vide tabela no final desta página) (opcional)
    • 0 - Número Entrante (necessário informar pelo menos ip_address e port1)
    • 1 - Chamar Linha IP (necessário informar type_data com o ID da Linha que irá receber a chamada)
    • 2 - Portal de Voz
    • 3 - CallingCard
    • 4 - Menu de Ramal
    • 5 - Fila de Atendimento (necessário informar type_data com o ID da Fila de Atendimento)
    • 6 - Menu de Ura (necessário informar type_data com o ID do Bloco de URA)
    • 7 - Callback Livre (necessário informar type_data com o ID da Linha que pagará a chamada)
    • 8 - Callback com Autenticação
    • 9 - Menu de Ura Reversa (necessário informar type_data com o ID do Bloco de URA)
  • type_data: ID referente ao Tipo de DID (ID referente ao registro referente ao campo type do DID)
  • techprefix1: Techprefix para envio em caso de Número Entrante (opcional)
  • ip_address1: Endereço IP principal para envio em caso de Número Entrante (opcional)
  • port1: Porta do IP principal (opcional)
  • techprefix2: Techprefix do IP de Backup (opcional)
  • ip_address2: IP de Backup caso IP de envio principal falhe (opcional)
  • port2: Porta do IP de Backup (opcional)

 

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 POST -d '{"id": 1, "customer_id": 23}' 'https://sip.nextbilling.com.br/api/assignDid/7cb40d54-4ebf-55a6-875a-5f57234e97cc-9990/b12c87a7-6dd6-5f99-9b47-c7c3be66fe73-8629'


Utilizando essa chamada, você obteria o retorno em JSON semelhante a saída a seguir:

Retorno JSON
{
   "error":0,
   "reason":"OK",
   "did_id":1,
   "description":"DID Number (11) 3090-0077",
   "record_status":1,
   "did_status":1
}
CampoDescrição
error1 em caso de erro
reasonDescrição caso tenha ocorrido algum erro
did_idID do Número Entrante
descriptionDescrição do DID
record_statusStatus do DID na Plataforma
did_status0 - DISPONÍVEL | 1 - VENDIDO