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á api.voipmundotelecom.com.br. Nesse caso, o endereço da API seria:
POST https://suporte.voipmundotelecom.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:
Utilizando essa chamada, você obteria o retorno em JSON semelhante a saída a seguir: