Criando-Alterando um DID

Criando-Alterando um DID

Endereço de Chamada da API

PUT /api/manageDID/API_TOKEN/API_KEY

Este Ponto de Acesso permite que você crie um novo DID (Núm. Entrante) na Plataforma.

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

PUT https://sip.nextbilling.com.br/api/manageDID/API_TOKEN/API_KEY

Parâmetros:

  • customer_id: ID do Assinante dono do DID (Deixe 0 para DID disponível para venda)

  • description: Nome / Descrição do DID

  • rate_id: ID do Plano de Venda se aplicável

  • rate_cost_id: ID do Plano de Custo se aplicável

  • did_number: Número do DID

  • did_type: Tipo de Funcionalidade do DID

    • 0 - Número Entrante por IP (informar device_id com ID da Linha que pagará a chamada)

    • 1 - Chamar uma Linha IP (informar device_id com ID da Linha que pagará a chamada)

    • 4 - Menu de Ramal (informar device_id com ID da Linha que pagará a chamada)

    • 5 - Fila de Atendimento (informar did_type_id com ID da Fila de Atendimento)

    • 6 - Menu de Ura (IVR) (informar did_type_id com ID do Bloco de URA (IVR))

    • 8 - Callback Reverso

    • 9 - Menu de Ura Reversa (informar device_id com ID da Linha que pagará a chamada)

    • 10 - Módulo de Teste de Áudio do DID

  • did_type_id: ID da Funcionalidade caso aplicável (ID da Ura ou Fila)

  • device_id: ID da Linha IP quando aplicável

  • host: Endereço IP do Fornecedor do DID

  • port: Porta do Fornecedor

  • username: Usuário de autenticação se aplicável

  • password: Senha de autenticação se aplicável

  • techprefix1: Techprefix a ser enviado se Tipo DID for IP

  • ip_address1: Endereço IP para enviar a chamada se Tipo DID for IP

  • port1: Porta para enviar a chamada se Tipo DID for IP

  • techprefix2: Techprefix a ser enviado se Tipo DID for IP (backup)

  • ip_address2: Endereço IP para enviar a chamada se Tipo DID for IP (backup)

  • port2: Porta para enviar a chamada se Tipo DID for IP (backup)

  • callerid_add: CallerID para adicional ao CallerID original

  • max_calls: Máximo de chamadas simultâneas

  • play_audio: Reproduzir áudio de Ocupado, Não atende, Não existe, etc

  • hide_from_reseller: Ocultar as informações do Fornecedor na Revenda

  • enable_fixed: Habilitar recebimento de Fixo Nacional

  • enable_mobile: Habilitar recebimento de Móvel Nacional

  • enable_ddi: Habilitar recebimento de Números Internacionais

  • register: Registrar o DID no Fornecedor

  • status: Status atual do registro no Sistema

  • annotations: Anotações e observações sobre o Registro

  • host_additional: Endereços IP adicionais para o Fornecedor Ex: "host_additional": ["192.168.3.1","192.168.5.30"]

 

A chamada para criar um novo DID, é realizado utilizando um HTTP PUT 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 PUT -d '{"customer_id": 13, "description": "Número Entrante", "did_number": "1166", "host": "192.168.0.2", "port": 5060, "host_additional": ["192.168.0.1","192.168.0.3"]' 'https://sip.nextbilling.com.br/api/manageDID/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", "new_record":13, }

 

A chamada para alterar um DID, é realizado utilizando um HTTP POST para o endereço de consumo da API, enviando o ID do DID na Url de envio. Um exemplo de chamada a essa API seria:

Exemplo de chamada a API utilizando cURL

$ curl -X POST -d '{"description": "Número Entrante Editado", "host": "192.168.0.2", "port": 5060, "host_additional": ["192.168.0.1","192.168.0.3"]' 'https://sip.nextbilling.com.br/api/manageDID/7cb40d54-4ebf-55a6-875a-5f57234e97cc-9990/b12c87a7-6dd6-5f99-9b47-c7c3be66fe73-8629/12'

Campo

Descrição

Campo

Descrição

error

1 em caso de erro

reason

Descrição caso tenha ocorrido algum erro

new_record

ID do novo DID