TIP - Inclusão de conta

De RBX ISP - Manual do Usuário
Revisão de 10h53min de 4 de junho de 2021 por Felipe (discussão | contribs) (Criou página com 'O objetivo deste serviço é realizar a inclusão de uma nova conta na TIP. Abaixo, segue exemplo do json de envio: <syntaxhighlight lang="json" line="1"> { "tip_account_in...')
(dif) ← Edição anterior | Revisão atual (dif) | Versão posterior → (dif)

O objetivo deste serviço é realizar a inclusão de uma nova conta na TIP. Abaixo, segue exemplo do json de envio:

{
  "tip_account_insert":
  {
    "customer_id": 123,
    "contract_id": 165,
    "username": 2731910101,
    "password": "x6s52c1s6",
    "email": "email@provedor.com", 
    "activate_date": "2020-10-25",
    "credit_limit": 125.99,
    "due_date": 10,
    "tech_prefix": "44", 
    "block_collect_call": true,
    "block_vc1": true,
    "block_ldn": true,
    "block_ldi": true,
    "do_not_disturb": true,
    "transfer_busy": true,
    "transfer_always": true,
    "transfer_no_answer": true
  }
}

Detalhamento dos campos

ID Campo Obrigatório Pai Tipo Observações
A01 tip_account_insert Sim Raiz -  
A02 customer_id Sim A01 Inteiro (15)

Código do cliente.

A03 contract_id Sim A01 Inteiro (12)

Número do contrato. Deve estar em uma das seguintes situações:

  • Ativo
  • Em Instalação
  • Aguardando Instalação
A04 username Sim A01 Inteiro (12)

Número NAP para vincular o cliente. Deve estar disponível ou reservado para o cliente.

A05 password Sim A01 Texto (50)

Senha da conta.

A06 email Não A01 Texto (200)

E-mail da conta.

A07 activate_date Não A01 Data

Data de ativação no formato AAAA-MM-DD. Se não informada, será considerada a data atual.

A08 credit_limit Não A01 Decimal (15.2)

Limite de crédito da conta. Aceita valores positivos.

A09 due_date Sim A01 Inteiro (2)

Dia de vencimento da conta. Aceita valores entre 1 e 31.

A10 tech_prefix Não A01 Texto (4)

Tech prefix da conta. Aceita apenas caracteres numéricos.

A11 block_collect_call Não A01 Booleano

Configuração do bloqueio de chamadas a cobrar:

  • true: ativa o bloqueio
  • false: desativa o bloqueio

Ao não informar este campo será considerado o valor false.

A12 block_vc1 Não A01 Booleano

Configuração do bloqueio de chamadas para celular:

  • true: ativa o bloqueio
  • false: desativa o bloqueio

Ao não informar este campo será considerado o valor false.

A13 block_ldn Não A01 Booleano

Configuração do bloqueio de chamadas LDN:

  • true: ativa o bloqueio
  • false: desativa o bloqueio

Ao não informar este campo será considerado o valor false.

A14 block_ldi Não A01 Booleano

Configuração do bloqueio de chamadas LDI:

  • true: ativa o bloqueio
  • false: desativa o bloqueio

Ao não informar este campo será considerado o valor false.

A15 do_not_disturb Não A01 Booleano

Configuração do recurso Não Perturbe:

  • true: ativa o recurso
  • false: desativa o recurso

Ao não informar este campo será considerado o valor false.

A16 transfer_busy Não A01 Booleano

Configuração do recurso Transferência em ocupado:

  • true: ativa o recurso
  • false: desativa o recurso

Ao não informar este campo será considerado o valor false.

A17 transfer_always Não A01 Booleano

Configuração do recurso Transferência sempre:

  • true: ativa o recurso
  • false: desativa o recurso

Ao não informar este campo será considerado o valor false.

A18 transfer_no_answer Não A01 Booleano

Configuração do recurso Transferência em não responde:

  • true: ativa o recurso
  • false: desativa o recurso

Ao não informar este campo será considerado o valor false.

 

Mensagem de retorno

Em caso de sucesso, será retornado um json conforme o exemplo abaixo:

{
  "status": 1,
  "error_code": 0,
  "error_description": "",
  "result": 
  {
    "tip_customer_id": 1526, 
    "tip_profile_id": 100202
  }
}

Em caso de falha, será retornado um json conforme o exemplo abaixo:

{
  "status": 0,
  "error_code": 19,
  "error_description": "Unknown error!",
  "result": ""
}