Consultar cliente

Este item consulta o cliente pelo CPF

Itens dependentes

Este item não depende de nenhum item

Parâmetros

NomeObrigatórioOrigemDescrição
HOSTSIMHost da API do integrador.
Ex: https://domain.com.br/endpoint
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
APPNAMESIMTipo de aplicação selecionada.
Ex: whatsapp|fortics|etc
CONTRACTSIMNúmero de contrato para identificação do cliente.
Ex: whatsapp|fortics|etc
CPF_CNPJSIMCPF/CNPJ para identificação do cliente.
Ex: 999.999.999-99

Variáveis criadas

Este item não cria nenhuma variável porém adiciona os seguintes campos no cadastro do contato:

  • nome
  • cep
  • bairro
  • cidade
  • endereco
  • numero_end

Retornos

Encontrado

Quando o cliente for encontrado com sucesso

Não encontrado

Quando o cliente não for encontrado

Consultar contrato

Consultar por um contrato de um cliente

Itens dependentes

Este item não depende de nenhum item

Parâmetros

NomeObrigatórioOrigemDescrição
HOSTSIMHost da API do integrador.
Ex: https://domain.com.br/endpoint
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
APPNAMESIMTipo de aplicação selecionada.
Ex: whatsapp|fortics|etc
CPF_CNPJSIMCPF/CNPJ para identificação do cliente.
Ex: 999.999.999-99

Variáveis criadas

NomeDescriçãoExemplo
ID_CONTRACTID do contrato encontrado12345
CONTRACTSMensagem com lista de contratosPlano: I-FIBRA_20Mbps
Status: Ativo
Endereço: RUA DOS PROVERBIOS
Nº contrato: 207

Retornos

Encontrado

Quando for encontrado apenas 1 resultado para esta consulta.

Se o retorno for somente 1 contrato encontrado, então a variável ID_CONTRACT já será preenchida automaticamente pelo fluxo.

Encontrado vários

Quando for encontrado mais de 1 resultado para esta consulta.

Caso a consulta retorne vários resultados, deve-se utilizar a variável CONTRACTS para definir a variável ID_CONTRACT e então prosseguir com a integração.

Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Enviar boleto link

Enviar link para download do boleto

Itens dependentes

Nome
Consultar contrato

Parâmetros

NomeObrigatórioOrigemDescrição
HOSTSIMHost da API do integrador.
Ex: https://domain.com.br/endpoint
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
APPNAMESIMTipo de aplicação selecionada.
Ex: whatsapp|fortics|etc
CPF_CNPJSIMCPF/CNPJ para identificação do cliente.
Ex: 999.999.999-99
ID_CONTRACTSIMConsultar contratoID do contrato.
Ex: 12345

Variáveis criadas

Este item não cria nenhuma variável na sessão

Retornos

Encontrado

Quando o link do boleto for enviado

Não encontrado

Quando o boleto não for encontrado

Enviar boleto e-mail e sms

Enviar boleto para o cliente por email ou sms

Itens dependentes

Nome
Consultar contrato

Parâmetros

NomeObrigatórioOrigemDescrição
HOSTSIMHost da API do integrador.
Ex: https://domain.com.br/endpoint
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
APPNAMESIMTipo de aplicação selecionada.
Ex: whatsapp|fortics|etc
URA_CONTACTSIMNúmero da URA.
Ex: 99999999999
ID_CONTRACTSIMConsultar contratoID do contrato.
Ex: 12345
TYPESIMTipo de envio.
Ex: E-mail|SMS

Variáveis criadas

Este item não cria nenhuma variável na sessão

Retornos

Encontrado

Quando o boleto for enviado

Não encontrado

Quando o boleto não for encontrado

Enviar boleto PDF

Enviar boletos em PDF para o cliente

Itens dependentes

Nome
Consultar contrato

Parâmetros

NomeObrigatórioOrigemDescrição
HOSTSIMHost da API do integrador.
Ex: https://domain.com.br/endpoint
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
APPNAMESIMTipo de aplicação selecionada.
Ex: whatsapp|fortics|etc
CPF_CNPJSIMCPF/CNPJ para identificação do cliente.
Ex: 999.999.999-99
ID_CONTRACTSIMConsultar contratoID do contrato.
Ex: 12345

Variáveis criadas

Este item não cria nenhuma variável na sessão

Retornos

Encontrado

Quando o boleto for enviado

Não encontrado

Quando o boleto não for encontrado

Abrir ticket

Realizar abertura de um novo ticket de atendimento para o cliente

Itens dependentes

Nome
Consultar contrato

Parâmetros

NomeObrigatórioOrigemDescrição
HOSTSIMHost da API do integrador.
Ex: https://domain.com.br/endpoint
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
APPNAMESIMTipo de aplicação selecionada.
Ex: whatsapp|fortics|etc
ID_CONTRACTSIMConsultar contratoID do contrato.
Ex: 12345
URA_CONTACTSIMNúmero da URA.
Ex: 99999999999
OCCURENCE_TYPESIMDescrição do chamado.
Ex: Falha de comunicação...
SECTORSIMSetor ao qual será direcionado o atendimento.
Ex: Setor financeiro
REASONSSIMMotivos pelo qual está sendo criado o chamado.
Ex: Problema de conexão...
METHODSIMMétodo que será utilizado na criação do chamado.
Ex: Motivo de abertura de chamado..

Variáveis criadas

Este item não cria nenhuma variável na sessão

Retornos

Encontrado

Quando a abertura de ticket for realizada com sucesso

Não encontrado

Quando não for possível realizar a abertura do ticket

Desbloquear contrato

Desbloqueio por confiança de um contrato do cliente

Itens dependentes

Nome
Consultar contrato

Parâmetros

NomeObrigatórioOrigemDescrição
HOSTSIMHost da API do integrador.
Ex: https://domain.com.br/endpoint
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
APPNAMESIMTipo de aplicação selecionada.
Ex: whatsapp|fortics|etc
ID_CONTRACTSIMConsultar contratoID do contrato.
Ex: 12345

Variáveis criadas

Este item não cria nenhuma variável na sessão

Retornos

Encontrado

Quando o contrato for desbloqueado com sucesso

Não encontrado

Quando não for possível realizar o desbloqueio do contrato