Alterando uma Conta de Assinante
Endereço de Chamada da API
POST /api/manageCustomers/API_TOKEN/API_KEY/id_assinante
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
POST https://sip.nextbilling.com.br/api/manageCustomers/API_TOKEN/API_KEY/id_assinante
Parâmetros:
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
inscricao_municipal: Inscrição Municipal do Cliente (Necessário para emissão de NFS-e)
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
status: Status atual do Cadastro
tem_report: Habilita acesso ao Relatório de Desconexão no nível Assinante
tem_cdr_err: Ativa a geração de CDR de Desconexão
tem_asr: Ativa a geração de informações de ASR
tem_asr_prefix: Ativa a geração de informações de ASR por Prefixo
tem_sip_codes: Ativa a geração de informações do Retorno de SIPCodes
menu_asr: Ativa o acesso ao menu de Relatório de ASR no nível Assinante
finance: Objeto contendo os dados Financeiros do Assinante
finance.tipo_tar: Tipo de Tarifação / 0 - PRE-PAGO | 1 - POS-PAGO
finance.id_plano: ID do Plano de Prefixos
finance.limite_credito: Limite de Crédito (Caso assinante for POS-PAGO)
finance.dia_vencimento: Dia de Vencimento para POS-PAGO, FRANQUIA
finance.inicio_ciclo: Para POS-PAGO: 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.max_cps: Máximo de Ligações por Segundo 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.sipcode_no_prefix: Código SIP retornado caso não exista o prefixo no Plano do Assinante
A chamada para alterar os dados de um Assinante é realizada utilizando um HTTP POST para o endereço de consumo da API. Um exemplo de chamada a essa API seria:
$ curl -X POST -d '{"nome_fantasia": "Teste de Cadastro Alterado", "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/3'
Utilizando essa chamada, você obteria o retorno em JSON semelhante a saída a seguir:
Retorno JSON
{
"error":0,
"reason":"OK",
"saved":1,
"saved_finance":1,
}Campo | Descrição |
|---|---|
error | 1 em caso de erro |
reason | Descrição caso tenha ocorrido algum erro |
saved | 0 - em Caso de Erro | 1 - se o Cadastro foi salvo corretamente |
saved_finance | 0 - em Caso de Erro | 1 - se o Cadastro Financeiro foi salvo corretamente |