Endereço de Chamada da API

PUT /api/manageDevices/API_TOKEN/API_KEY/1

Este Ponto de Acesso permite que você crie uma nova Linha IP. Repare que no final da URL, é necessário informar o numeral 1 (um).

Se você estiver utilizando Tokens de Acesso do Nível Assinante, você não precisará informar o campo customer_id no conteúdo da requisição, caso contrário, esse campo deverá ser obrigatório.

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/manageDevices/API_TOKEN/API_KEY/1

Parâmetros:

customer_id: ID do Cliente dono da Linha (Tokens de Nível Assinante não precisam enviar esse campo)
rate_id: ID do Plano de Prefixos customizado (valor 0 ou não envie o campo para manter o Plano do Assinante
callerid: Número a ser binado em ligações externas
simultaneas: Quantidade de chamadas simultâneas para essa Linha
max_cps: Máximo de chamadas por Segundos
max_ringtime: Tempo máximo chamando antes de considerar Não Atendido
max_calltime: Tempo máximo que essa Linha poderá ficar em uma chamada
fixo: Ativar / Desativar ligações para Fixo
movel: Ativar / Desativar ligações para Móvel
fixo_ddi: Ativar / Desativar ligações para Fixo DDI
movel_ddi: Ativar / Desativar ligações para Móvel DDI
status: Status atual da Linha / 0 - Inativo | 1 - Ativo
auth: Tipo de Autentição da Linha
- 0 - Usuário e Senha
- 1 - IP + Techprefix
username: Login/Usuário da Linha (caso auth = 0)
password: Senha da Linha (caso auth = 0)
domain: Array com os endereços IPs da Linha (caso auth = 1) Ex: ["1.1.1.1", "8.8.8.8"]
port: Porta da Linha (caso auth = 1)
techprefix: Techprefix da Linha (caso auth = 1)
check_spoofing: Ativar/Desativar a checagem de Spoofing
proxy_media: Tratamento de Audio (0 DIRECT MEDIA | 1 RTP PROXY | 2 TRANSCODER)
callerid_change: Bina Inteligente
- 0 NAO ALTERAR
- 1 ALTERAR DDD P/ REGIAO DESTINO
- 2 ALTERAR DDD E ÚLT. 4 DÍGITOS NO BACKUP
- 3 BINA DINAMICA COM DDD DESTINO
- 4 BINA ALEATORIA: DDD DESTINO+PREFIXO+NUM
- 5 BINA COM BASE DE NUMEROS INVALIDOS
callerid_type: De onde obter o CallerID (0 Header From | 1 Remote-Party-ID | 2 P-Asserted-Identity | 3 P-Preferred-Identity)
callerid_invalid_block: Ativar Bloqueio de CallerID Inválido
habilita_npn_fixo: Ativar/Desativar consulta a Portabilidade para Fixo
habilita_npn_movel: Ativar/Desativar consulta a Portabilidade para Móvel
rewrite_sipcodes: Reescrever código SIP (Ex: 401=503;408=486;603=503)
blacklist_sipcode: Código SIP caso o número discado esteja em BlackList
billing_round: Tipo de Arredondamento (0 TRUNCADO | 1 PARA BAIXO | 2 PARA CIMA | 3 APENAS OS SEGUNDOS)
use_blacklist_cid: Usar BlackList de CallerID
use_blacklist_404: Usar BlackList de números inválidos

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 PUT -d '{"customer_id": 1, "auth": 0, "username": "teste", "password": "123.123"}' 'https://sip.nextbilling.com.br/api/manageDevices/7cb40d54-4ebf-55a6-875a-5f57234e97cc-9990/b12c87a7-6dd6-5f99-9b47-c7c3be66fe73-8629/1'

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

Retorno JSON

{
   "error":0,
   "reason":"OK",
   "new_record":13
}

Campo	Descrição
error	1 em caso de erro
reason	Descrição caso tenha ocorrido algum erro
new_record	ID da nova Linha

Browser not supported