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á api.voipmundotelecom.com.br. Nesse caso, o endereço da API seria:
Endereço da API exemplo
PUT https://suporte.voipmundotelecom.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)
- tech: Tecnologia da Linha (SIP)
- rate_id: ID do Plano de Prefixos customizado (valor 0 ou não envie o campo para manter o Plano do Assinante)
- codecs: Lista deCodecs liberados para essa Linha, separados por ponto-e-vírgula
- rtp_symmetric: Ativa ou Desativa o envio de RTP Simétrico (0 Inativo, 1 Ativo)
- volume_rx: Volume de Recepção do Equipamento
- volume_tx: Volume de Transmissão do Equipamento
- funcionalidade: Tipo de Funcionalidade da Linha
- 0 - Linha IP / Ramal
- 1 - Portal de Voz
- 2 - Central CallingCard
- 3 - Menu de URA
- 4 - Fila de Atendimento
- 5 - Cabine Telefônica
- funcionalidade_id: ID da Funcionalidade, caso necessário (URA ou Fila de Atendimento)
- id_audio: ID do Arquivo de Áudio a ser reproduzido antes de cada Ligação realizada
- sigame_always_st: Status do Siga-ME Sempre
- sigame_always_dst: Destino a ser chamada no Siga-ME Sempre
- sigame_busy_st: Status do Siga-ME Ocupado
- sigame_busy_dst: Destino a ser chamada no Siga-ME Ocupado
- sigame_noanswer_st: Status do Siga-ME Não Atende
- sigame_noanswer_dst: Destino a ser chamada no Siga-ME Não Antende
- sigame_offline_st: Status do Siga-ME Offline
- sigame_offline_dst: Destino a ser chamada no Siga-ME Offline
- allow_transfer: Ativar / Desativar transferência de Ligações
- allow_record_fixo: Ativar / Desativar gravação para Ligações Fixo
- allow_record_movel: Ativar / Desativar gravação para Ligações Móvel
- reproduzir_erros: Ativar / Desativar reprodução de erros na Linha
- voicemail_status: Ativar / Desativar Correio de Voz
- voicemail_password: Senha do Correio de Voz
- cadeado_status: Ativar / Desativar Cadeado
- cadeado_password: Senha do Cadeado
- portal_password: Senha para utilizar a linha no Portal de Voz
- tipo_tar: Tipo de Tarifação: 0 - Saldo da Linha | 1 - Saldo do Cliente
- id_perfil_horario: ID do Perfil de Horário,
- ddd_local: Código do País + DDD para definir ligações locais da Linha
- linha_ip: Número da Linha IP (inteiro, de 10 a 999999)
- callerid_name: Nome exibido nos equipamentos em ligações internas
- callerid: Número a ser binado em ligações externas
- simultaneas: Quantidade de chamadas simultâneas para essa Linha
- max_ringtime: Tempo máximo chamando antes de considerar Não Atendido
- max_ringtime_voip: Tempo máximo que essa Linha será chamada até ir para Caixa Postal
- max_calltime: Tempo máximo que essa Linha poderá ficar em uma chamada
- voip: Ativar / Desativar ligações de Ramal para Ramal
- fixo_local: Ativar / Desativar ligações para Fixo Local
- fixo_ldn: Ativar / Desativar ligações para Fixo Longa Distância
- movel_local: Ativar / Desativar ligações para Móvel Local
- movel_ldn: Ativar / Desativar ligações para Móvel Longa Distância
- fixo_ddi: Ativar / Desativar ligações para Fixo DDI
- movel_ddi: Ativar / Desativar ligações para Móvel DDI
- habilita_npn_fixo: Habilitar Consutla a Portabilidade para Ligações Fixo
- habilita_npn_movel: Habilitar Consutla a Portabilidade para Ligações Móvel
- ring_falso: Ativar / Desativar a reprodução de Ring Falso nessa Linha
- 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: Endereço IP da Linha (caso auth = 1)
- port: Porta da Linha (caso auth = 1)
- techprefix: Techprefix da Linha (caso auth = 1)
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: