Consultar cliente

Este item consulta o cliente pelo CPF

Itens dependentes

Este item não depende de nenhum item

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: https://domain.com.br/endpoint
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
SELFSIGNEDSIMFlag para informar se será auto assinado.
Ex: 0|1
CPF_CNPJSIMCPF/CNPJ para identificação do cliente.
Ex: 999.999.999-99

Variáveis criadas

NomeExemplo de valor retornado
CLIENT_IDID do cliente. Ex: 12345

Retornos

Cliente encontrado

Quando o cliente for encontrado

Cliente não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Consultar contrato

Neste item pode-se consultar contrato do cliente

Itens dependentes

Nome
Consultar cliente
Abrir ticket

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: https://domain.com.br/endpoint
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
SELFSIGNEDSIMFlag para informar se será auto assinado.
Ex: 0|1
CLIENT_IDSIMID do cliente.
Ex: 12345

Variáveis criadas

NomeExemplo de valor retornado
ID_CONTRACTID do contrato encontrado
Ex: 4333
CONTRACTSMensagem com lista de contratos
Ex: **Descrição**: FIBRA20MEGA PROMO
**Código**: 4333

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 ja 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 variavel 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

Este item envia os boletos para o cliente

Itens dependentes

Nome
Consultar cliente

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: https://domain.com.br/endpoint
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
SELFSIGNEDSIMFlag para informar se será auto assinado.
Ex: 0|1
CPF_CNPJSIMCPF/CNPJ para identificação do cliente.
Ex: 999.999.999-99

Variáveis criadas

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

Retornos

Encontrado

Quando o boleto for encontrado e enviado com sucesso

Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Cliente não encontrado

Quando o cliente não for encontrado

Enviar código de barras

Este item envia o código de barras de um determinado boleto para o cliente

O mesmo pode ser enviado por e-mail ou SMS

Itens dependentes

Nome
Consultar cliente

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: https://domain.com.br/endpoint
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
SELFSIGNEDSIMFlag para informar se será auto assinado.
Ex: 0|1
CPF_CNPJSIMCPF/CNPJ para identificação do cliente.
Ex: 999.999.999-99
SEND_TYPESIMTipo de envio do código de barras.
Ex: mail|sms

Variáveis criadas

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

Retornos

Enviado

Quando o código de barras for enviado e enviado com sucesso

Não enviado

Quando não for possivel enviar o código de barras para o cliente

Gerar protocolo

Gerar protocolo de atendimento para o cliente

Itens dependentes

Este item não depende de nenhum item

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: https://domain.com.br/endpoint
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
SELFSIGNEDSIMFlag para informar se será auto assinado.
Ex: 0|1

Variáveis criadas

NomeExemplo de valor retornado
IXC_PROTOCOLNúmero do protocolo gerado.
Ex: 112203

Retornos

Criado

Quando o protocolo for gerado com sucesso

Não criado

Quando não for possivel gerar o protocolo

Desbloquear contrato

Desbloqueio de confiança de um contrato do cliente

Itens dependentes

Nome
Consultar contrato

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: https://domain.com.br/endpoint
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
SELFSIGNEDSIMFlag para informar se será auto assinado.
Ex: 0|1
ID_CONTRACTSIMID do contrato.
Ex: 4333

Variáveis criadas

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

Retornos

Desbloqueado

Quando o contrato for desbloqueado com sucesso

Não desbloqueado

Quando não for possível desbloquear o contrato

Abrir ticket

Realizar abertura de um novo ticket para o cliente

Itens dependentes

Nome
Consultar cliente
Consultar contrato

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: https://domain.com.br/endpoint
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
SELFSIGNEDSIMFlag para informar se será auto assinado.
Ex: 0|1
CLIENT_IDSIMID do cliente.
Ex: 12345
ID_CONTRACTSIMID do contrato.
Ex: 123456
DEPARTMENTSIMID do departamento.
Ex: 1
SUBJECT_IDSIMAssunto do chamado.
Ex: Descreva o assunto...
DESCRIPTIONSIMDescrição do chamado.
Ex: A descrição deste chamado é...
PRIORITYSIMPrioridade do chamado.
Ex: B|M|A
MESSAGESIMID do cliente.
Ex: O motivo desta ordem de seviço é...

Variáveis criadas

NomeExemplo de valor retornado
IXC_PROTOCOLNúmero do protocolo gerado.
Ex: 112203
TICKET_IDNúmero do ticket gerado.
Ex: 12345

Retornos

Criado

Quando o ticket for aberto com sucesso

Não criado

Quando não for possível abrir o ticket

Abrir Ordem de Serviço

Cria uma nova ordem de serviço para o cliente

Itens dependentes

Nome
Consultar cliente

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: https://domain.com.br/endpoint
TOKENSIMToken necessário para autenticação.
Ex: 10:13ibo135bo1y5bo145biergmcoer8g93
SELFSIGNEDSIMFlag para informar se será auto assinado.
Ex: 0|1
CLIENT_IDSIMID do cliente.
Ex: 12345
PRIORITYSIMPrioridade do chamado.
Ex: B|M|A
DEPARTMENTSIMID do departamento.
Ex: 1
SUBJECT_IDSIMAssunto do chamado.
Ex: Descreva o assunto...
HOURSIMHorario para realização do serviço.
Ex: Manhã|Tarde|Noite|Qualquer
MESSAGESIMID do cliente.
Ex: O motivo desta ordem de seviço é...
TICKET_IDSIMNúmero do ticket gerado.
Ex: 12345

Variáveis criadas

NomeExempExemplo de valor retornado
IXC_PROTOCOLNúmero do protocolo gerado.
Ex: 112203

Retornos

Criado

Quando o a ordem de serviço for criada com sucesso

Não criado

Quando não for possível criar a ordem de serviço