Skip to end of banner
Go to start of banner

Criando um novo Assinante

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Current »


Endereço de Chamada da API

PUT /api/manageCustomers/API_TOKEN/API_KEY

Este Ponto de Acesso permite que você crie um novo Assinante 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/manageCustomers/API_TOKEN/API_KEY

Parâmetros:

  • id_hie: ID da Revenda dona do Cliente

  • id_origem: ID do Tipo de Origem do Cliente

  • id_vinculo: ID do Vinculo do Cliente

  • id_vendedor: ID do Vendedor

  • nome_fantasia: Nome do Assinante

  • razao_social: Razão Social / Nome do Assinante

  • cpf: CNPJ / CPF

  • rg: Inscrição Estadual / RG

  • website: Site do Assinante

  • cep: CEP do Endereço

  • endereco

  • complemento

  • bairro

  • cidade

  • uf

  • pais

  • telefone

  • ramal

  • telefone2

  • celular

  • fax

  • contato: Nome de Contato

  • email: Email principal

  • email_st: Ativa o email para notificações do Sistema

  • email2: Email alternativo

  • email2_st: Ativa o email para notificações do Sistema

  • email_financeiro: Email para Assuntos Financeiros

  • email_financeiro_st: Ativa o email para notificações do Sistema

  • tem_ramal: Permite que o Assinante gerencie Linhas e Ramais

  • tem_did: Permite que o Assinante gerencie Números Entrantes

  • tem_sms: Permite que o Assinante gerencie Envio de SMS

  • tem_escuta: Permite que o Assinante realize Escuta de Ligações

  • tem_ip_global: Permite que o Assinante realize ligações para outros Ramais da Plataforma

  • tem_gravacao: Permite que o Assinante ative/desative gravação de Ligações

  • tem_sigame: Permite que o Assinante gerencie Siga-ME

  • tem_fila: Permite que o Assinante gerencie Filas de Atendimento

  • tem_ura: Permite que o Assinante gerencie Menus de URA

  • tem_portal: Permite que o Assinante gerencie Portal de Voz

  • tem_callingcard: Permite que o Assinante gerencie CallingCards

  • tem_grupo_captura: Permite que o Assinante gerencie Grupos de Captura

  • tem_grupo_chamada: Permite que o Assinante gerencie Grupos de Chamada

  • tem_campanha_sms: Permite que o Assinante gerencie Campanhas de SMS

  • tem_campanha_voz: Permite que o Assinante gerencie Campanhas de Voz

  • tem_conferencia: Permite que o Assinante gerencie Salas de Conferencia

  • tem_provisionamento: Permite que o Assinante gerencie Provisionamento de Equipamentos

  • allow_change_callerid: Permite que o Assinante altere o CallerID das suas Linhas

  • check_intra_network_call: Ativa/Desativa as chamadas Intra-Rede para o Assinante

  • moeda: ID da Moeda utilizada pelo Assinante

  • status: Status atual do Cadastro

  • user: Objeto contendo o usuário Master deste Assinante

    • user.username: Nome de Usuário do Painel

    • user.password: Senha de Acesso do Painel

  • finance: Objeto contendo os dados Financeiros do Assinante

    • finance.tipo_tar: Tipo de Tarifação / 0 - PRE-PAGO | 1 - POS-PAGO | 2 - FRANQUIA

    • finance.id_plano: ID do Plano de Prefixos

    • finance.id_plano_sms: ID do Plano de SMS

    • finance.limite_credito: Limite de Crédito (Caso assinante for POS-PAGO)

    • finance.dia_vencimento: Dia de Vencimento para POS-PAGO, FRANQUIA

    • finance.dias_bloqueio: Para POS-PAGO, FRANQUIA: Início do Ciclo Mensal

    • finance.alerta_status: Ativa / Desativa o Alerta de Saldo Baixo

    • finance.alerta_valor: Valor para aviso de Saldo Baixo

    • finance.simultaneas: Máximo de Ligações Simultâneas para esse Assinante (0 - Ilimitado)

    • finance.ini_f: Tarifação Mínima para Fixo

    • finance.inc_f: Incremento para Fixo

    • finance.tmp_f: Tolerância para Fixo

    • finance.ini_c: Tarifação Mínima para Móvel

    • finance.inc_c: Incremento para Móvel

    • finance.tmp_c: Tolerância para Móvel

    • finance.ini_f_ddi: Tarifação Mínima para Fixo DDI

    • finance.inc_f_ddi: Incremento para Fixo DDI

    • finance.tmp_f_ddi: Tolerância para Fixo DDI

    • finance.ini_c_ddi: Tarifação Mínima para Móvel DDI

    • finance.inc_c_ddi: Incremento para Móvel DDI

    • finance.tmp_c_ddi: Tolerância para Móvel DDI

    • finance.allow_loss_call: Permitir valor de Venda menor que o Valor de Custo

    • finance.id_perfil: ID do Perfil Financeiro

    • finance.franquia_fixo_local: ID da Franquia para Fixo Local

    • finance.franquia_movel_local: ID da Franquia para Móvel Local

    • finance.franquia_fixo_ldn: ID da Franquia para Fixo Longa Distância

    • finance.franquia_movel_ldn: ID da Franquia para Móvel Longa Distância

    • finance.franquia_fixo_ddi: ID da Franquia para Fixo DDI

    • finance.franquia_movel_ddi: ID da Franquia para Móvel DDI

    • finance.disk_space: Espaço em Disco em MB (0 - Ilimitado)

    • finance.call_only_local: Permitir ligações apenas de Ramais do Cliente (1 - Apenas Local | 0 - Pode ligar para qualquer Ramal da Plataforma)

    • finance.max_devices: Máximo de Linhas para o Assinante

    • finance.max_ivr: Máximo de Uras para o Assinante

    • finance.max_queues: Máximo de Filas de Atendimento para o Assinante


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 '{"id_hie": 1, "nome_fantasia": "Teste de Cadastro", "user": { "username": "teste", "password": "123.123.123.123"}, "finance": {"tipo_tar": 1, "limite_credito": 300.00}}' 'https://sip.nextbilling.com.br/api/manageCustomers/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_id":13,
   "username":"teste",
   "password":"123.123.123.123",
   "saved":1,
   "saved_user":1,
   "saved_finance":1,
}


Campo

Descrição

error

1 em caso de erro

reason

Descrição caso tenha ocorrido algum erro

new_id

ID do novo Assinante

username

Usuário de Acesso do Painel

password

Senha de Acesso do Painel

saved

0 - em Caso de Erro | 1 - se o Cadastro foi salvo corretamente

saved_user

0 - em Caso de Erro | 1 - se o Usuário foi salvo corretamente

saved_finance

0 - em Caso de Erro | 1 - se o Cadastro Financeiro foi salvo corretamente


  • No labels