ReceitaNet - ChatBot - API version 1.0.1

https://sistema.receitanet.net/api/novo/chatbot

/empresa

retorna informações da empresa

post

post
Secured by auth

autenticação usando parâmetros token e app

Query Parameters

  • token: required(string)

    token para autenticação, solicitar com o suporte

  • app: required(chatbot)

    nome da aplicação

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • success: required(boolean)
  • nome: required(string)
  • cnpj: required(string)
  • endereco: required(string)
  • numero: required(string)
  • complemento: required(string)
  • bairro: required(string)
  • uf: required(string)
  • cep: required(string)
  • telefone1: required(string)
  • telefone2: required(string)

Example:

{
  "success": true,
  "nome": "...",
  "cnpj": "...",
  "endereco": "...",
  "numero": null,
  "complemento": null,
  "bairro": "...",
  "uf": "..",
  "cep": "...",
  "telefone1": "...",
  "telefone2": "..."
}

HTTP status code 401

não autenticado

Secured by auth

/clientes

busca de clientes usando o CPF/CNPJ

post

post
Secured by auth

autenticação usando parâmetros token e app

Query Parameters

  • token: required(string)

    token para autenticação, solicitar com o suporte

  • app: required(chatbot)

    nome da aplicação

  • cpfcnpj: (string)

    busca por CPF ou CNPJ

  • phone: (string)

    busca por numero de telefone/celular

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • success: required(boolean)
  • msg: required(string)
  • contratos: required(object)
    • idCliente: required(integer)

      código do cliente

    • razaoSocial: required(string)

      nome do cliente

    • contratoStatusDisplay: required(one of Ativo, Suspenso)

      status do cliente

    • isPromessaPagamento: required(boolean)

      promessa de pagamneto excedido (0) ou não (1)

    • contratoValorAberto: required(integer)

      valor do último boleto não pago

    • faturasEmAberto: required(array of assets.ItemFatura)

      itens de faturamento

      Items: ItemFatura

      • valor: required(integer)
      • vencimento: required(string)
    • email: required(string)

      email do cliente

    • cpfCnpj: required(integer)

      cpf/cnpj do cliente

    • contratoStatus: required(integer)

      status do contrato: 1=Ativo, 3=Bloqueado, 4=Cancelado

    • existeChamado: required(boolean)

      existe chamado aberto para o cliente?

    • isChamados: required(object)
      • 1: required(integer)

        quantidade de chamados em aberto para o tipo manutenção

      • 2: required(integer)

        quantidade de chamados em aberto para o tipo instalação

      • 4: required(integer)

        quantidade de chamados em aberto para o tipo retirada de equipamento, cancelamento

      • 5: required(integer)

        quantidade de chamados em aberto para o tipo financeiro

    • isLiberadoConfianca: required(integer)

      Informa se o Cliente esta com Liberação em Confiança ativado (1) ou Não (0)

    • logins: required(array of assets.ClienteLogin)

      lista de logins

      Items: ClienteLogin

      • login: required(string)
      • senha: required(string)
      • isPrincipal: required(boolean)
    • planos: (array of assets.Plano)

      lista de planos

      Items: Plano

      • descricao: required(string)

        descrição do plano

      • quantidade: required(string)

        quantidade de planos

      • valor: required(string)

        valor total do plano

    • tecnologia: required(integer)

      tipo de tecnologia do cliente Cabo Rede Ethernet (1), Radiofrequência (2), Fibra Ótica (3) ou NULL para não especificado.

Example:

{
  "success": true,
  "msg": "Contrato Localizado",
  "contratos": {
    "idCliente": 36,
    "razaoSocial": "Nome Cliente",
    "endereco": {
      "endereco": "AVENIDA SOBE DESCE 35",
      "numero": null,
      "complemento": "",
      "bairro": "Bairro",
      "cidade": "Cidade",
      "referencia": "",
      "uf": "RJ",
      "cep": "11000-000"
    },
    "servidor": {
      "servidor": "SERVIDOR-001",
      "profile": "INTERNET_002_MB",
      "tipo": "PPPOE",
      "ip": null,
      "manutencao": false
    },
    "contratoStatusDisplay": "Ativo",
    "isPromessaPagamento": true,
    "contratoValorAberto": 202.94,
    "faturasEmAberto": [
      {
        "valor": 202.94,
        "vencimento": "2018-11-03",
        "url": "http://...",
        "vencido": true
      }
    ],
    "email": "teste@teste.com",
    "cpfCnpj": "00000000000",
    "contratoStatus": 1,
    "existeChamado": 1,
    "isChamados": {
      "1": 0,
      "2": 0,
      "4": 0,
      "5": 0
    },
    "clienteLiberadoConfianca": 0,
    "usouLiberacaoConfianca": 0,
    "logins": [
      {
        "login": "user",
        "senha": "pass",
        "isPrincipal": true
      }
    ],
    "planos": [
      {
        "descricao": "1MB",
        "quantidade": 2,
        "valor": 119.8
      }
    ],
    "tecnologia": 1
  }
}

HTTP status code 401

não autenticado

HTTP status code 404

cliente não localizado na base de dados

Secured by auth

/boletos

enviar boleto pendente por email/sms

post

post
Secured by auth

autenticação usando parâmetros token e app

Query Parameters

  • token: required(string)

    token para autenticação, solicitar com o suporte

  • app: required(chatbot)

    nome da aplicação

  • idCliente: required(integer)

    valor do campo idCliente do retorno ao busca Cliente

  • contato: required(string - maxLength: 20)

    telefone do cliente usado para fazer a ligação

  • tipo: required(one of email, sms)

    tipo de envio a ser realizado

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • success: required(boolean)

    sucesso ou falha na requisição, em caso de falha analisar o parametro msg

  • idCliente: required(integer)

    código do cliente

  • razaoSocial: required(string)

    nome do cliente

  • cpfCnpj: required(string)

    cpf/cnpj do cliente

  • msg: required(string)

    mensagem

  • contato: required(string)

    parametro contato enviado

  • protocolo: required(string)

    numero de protocolo da OS aberta

  • status: required(boolean)

    sucesso ou falha no envio do boleto

Example:

{
  "success": true,
  "idCliente": 36,
  "razaoSocial": "NOME CLIENTE",
  "cpfCnpj": "000.000.000-00",
  "msg": "Fatura enviada com sucesso",
  "contato": "18999998888",
  "protocolo": "20181116144220",
  "status": true
}

HTTP status code 401

não autenticado

Secured by auth

/verificar-acesso

post

post
Secured by auth

autenticação usando parâmetros token e app

Query Parameters

  • token: required(string)

    token para autenticação, solicitar com o suporte

  • app: required(chatbot)

    nome da aplicação

  • idCliente: required(integer)

    valor do campo idCliente do retorno ao busca Cliente

  • contato: required(string - maxLength: 20)

    telefone do cliente usado para fazer a ligação

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • status: required(one of false, false)

    status do cliente online(1) ou offline(2)

  • idCliente: required(integer)

    código do cliente

  • razaoSocial: required(string)

    nome do cliente

  • cpfCnpj: required(integer)

    cpf/cnpj do cliente

  • msg: required(string)

    mensagem

  • contato: required(string)

    parametro contato enviado

Example:

{
  "status": 2,
  "idCliente": 97,
  "razaoSocial": "RUTH SILVA PENIDO NETO",
  "cpfCnpj": "629.375.537-53",
  "msg": "Cliente Offline",
  "contato": "18999998888"
}

HTTP status code 401

não autenticado

HTTP status code 404

contrato não localizado

Secured by auth

/notificacao-pagamento

post

post
Secured by auth

autenticação usando parâmetros token e app

Query Parameters

  • token: required(string)

    token para autenticação, solicitar com o suporte

  • app: required(chatbot)

    nome da aplicação

  • idCliente: required(integer)

    valor do campo idCliente do retorno ao busca Cliente

  • contato: required(string - maxLength: 20)

    telefone do cliente usado para fazer a ligação

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • status: required(one of 0, 1, 2)

    status da requisição: 0=erro; 1=sucesso; 2=excedido

  • liberado: required(boolean)

    cliente liberado com sucesso ou não

  • razaoSocial: required(string)

    nome do cliente

  • cpfCnpj: required(integer)

    cpf/cnpj do cliente

  • msg: required(string)

    mensagem

  • contato: required(string)

    parametro contato enviado

  • protocolo: required(string)

    número de protocolo

  • liberado_ate: required(string)

    data limite da liberação realizada

Example:

{
  "status": 1,
  "liberado": 1,
  "razaoSocial": "Nome Cliente",
  "cpfCnpj": "00000000000",
  "msg": "Liberação via URA",
  "idCliente": "1",
  "contato": "1199999999",
  "protocolo": "20180623085657",
  "liberado_ate": "01/01/2000"
}

HTTP status code 401

não autenticado

Secured by auth

/abertura-chamado

post

post
Secured by auth

autenticação usando parâmetros token e app

Query Parameters

  • token: required(string)

    token para autenticação, solicitar com o suporte

  • app: required(chatbot)

    nome da aplicação

  • idCliente: required(integer)

    valor do campo idCliente do retorno ao busca Cliente

  • contato: required(string - maxLength: 20)

    telefone do cliente usado para fazer a ligação

  • ocorrenciatipo: required(one of 1, 2, 4, 5)

    tipo de chamados: 1: manutenção 2: instalação 4: retirada de equipamento, cancelamento 5: financeiro

  • motivoos: required(string)

    descrição do chamado

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • status: required(boolean)

    gravado com sucesso ou não

  • razaoSocial: required(string)

    nome do cliente

  • cpfCnpj: required(integer)

    cpf/cnpj do cliente

  • contato: required(string)

    parametro contato enviado

  • protocolo: required(string)

    número do protocolo

  • idSuporte: required(string)

    código do suporte para envio da gravação

Example:

{
  "status": 1,
  "razaoSocial": "Nome Cliente",
  "cpfCnpj": "00000000000",
  "contato": "11999999999",
  "protocolo": "20180623085657",
  "idSuporte": 999999
}

HTTP status code 401

não autenticado

Secured by auth

/chamado-gravacao

post

post
Secured by auth

autenticação usando parâmetros token e app

Query Parameters

  • token: required(string)

    token para autenticação, solicitar com o suporte

  • app: required(chatbot)

    nome da aplicação

  • idSuporte: required(integer)

    ID do suporte, parâmetro retornado ao abrir novo chamado

  • urlgravacao: required(string)

    url para reprodução da gravação da conversa com o cliente

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • success: required(boolean)

Example:

{
  "success": true
}

HTTP status code 401

não autenticado

HTTP status code 404

suporte não localizado

Body

Media type: application/json

Type: object

Properties
  • success: required(boolean)

Example:

{
  "success": false
}

Secured by auth

/chamados

Lista todos os chamados em aberto para o Cliente.

post

post
Secured by auth

autenticação usando parâmetros token e app

Query Parameters

  • token: required(string)

    token para autenticação, solicitar com o suporte

  • app: required(chatbot)

    nome da aplicação

  • idCliente: required(integer)

    ID do Cliente, parâmetro retornado ao buscar informações do Cliente

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Chamado

  • idSuporte: required(integer)

    código do suporte

  • numero: required(integer)

    número do chamado no sistema

  • data: required(string)

    data prevista do Chamado

  • hora: required(string)

    hora prevista do Chamado

  • tipo: required(one of 1, 2, 4, 5)

    tipo do suporte: 1=manutenção, 2=instalação, 4=retirada de equipamento, cancelamento, 5=financeiro

  • descricao: required(string)

    descrição do suporte

  • protocolo: (string)

    número do protocolo caso o chamado seja aberto pelo Chatbot, URA, etc

Example:

[
  {
    "idSuporte": "385121,",
    "data": "2019-04-05"
  }
]

HTTP status code 401

não autenticado

Secured by auth

/planos-cobrancas

post

post
Secured by auth

autenticação usando parâmetros token e app

Query Parameters

  • token: required(string)

    token para autenticação, solicitar com o suporte

  • app: required(chatbot)

    nome da aplicação

HTTP status code 200

Body

Media type: application/json

Type: array of PlanoCobranca

Example:

{
  "idPlano": 27,
  "descricao": "1MB",
  "valor": 45.55
}

HTTP status code 401

não autenticado

Secured by auth

/debitos

post

post
Secured by auth

autenticação usando parâmetros token e app

Query Parameters

  • token: required(string)

    token para autenticação, solicitar com o suporte

  • app: required(chatbot)

    nome da aplicação

  • page: required(string)

    paginação

HTTP status code 200

Body

Media type: application/json

Type: array of Debito

Example:

{
  "id": 27,
  "nome": "1MB",
  "login": 45.55,
  "telefone1": "(11)95555-2222",
  "telefone2": "(11)3222-5555",
  "telefone3": "",
  "boletos": {
    "vencimento": "2019-01-01",
    "valor": 150.55,
    "link": "https://b.receitanet.net/A"
  }
}

HTTP status code 401

não autenticado

Secured by auth