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
INTEGRATORSIMindentificação do integrador.
Ex: default
CPF_CNPJSIMCPF/CNPJ para identificação do cliente.
Ex: 999.999.999-99

Variáveis criadas

NomeDescriçãoExemplo
CLIENT_IDID do cliente12345
CONTRACTUNBLOCKID do contrato para desbloqueio19
COUNT_UNBLOCKQuantidade de desbloqueios de contrato1
MAX_UNBLOCKMáximo de desbloqueios possiveis2
RESOLUTION_TIME_HOURHorário de resolução23
AUTHENTICATION_PROBLEMSProblemas de autenticação0
CONTRACTSMensagem com lista de contratos1 - 1234
2 - 9874
CONTRACTS_DATAIDs da lista de contratos[1234, 9874]

Retornos

Cliente encontrado

Quando o cliente for encontrado

Cliente não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Enviar boletos (PDF/Linha digitável)

Este item envia boleto (s) em PDF para o cliente

Itens dependentes

Nome
Consultar cliente

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
CONTRACTS_DATASIMConsultar clienteIDs da lista de contratos.
Ex: [1234, 9874]
SEND_TYPESIMTipo de envio, PDF ou linha digitável.
Ex: pdf|text
DATA_BILLETS_FILTERSIMFiltro de dsdos de boletos.
Ex: 0|1

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 o boleto não for encontrado

Enviar boletos (e-mail)

Este item envia boleto (s) por e-mail para o cliente

Itens dependentes

Nome
Consultar cliente

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
CONTRACTS_DATASIMConsultar clienteIDs da lista de contratos.
Ex: [1234, 9874]
INTEGRATORSIMindentificação do integrador.
Ex: default

Variáveis criadas

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

Retornos

Enviado

Quando o boleto for encontrado e enviado com sucesso

Não enviado

Quando o boleto não for encontrado

Desbloqueio por confiança

Neste item é possível realizar o desbloqueio de um contrato

Itens dependentes

Nome
Consultar cliente

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
INTEGRATORSIMindentificação do integrador.
Ex: default
CONTRACTUNBLOCKSIMConsultar clienteID do contrato para desbloqueio.
Ex: 1020
MAX_UNBLOCKSIMConsultar clienteMáximo de desbloqueios possiveis.
Ex: 2

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 o contrato não for desbloqueado

Listar protocolos

Lista os protocolos de atendimento do cliente

Itens dependentes

Nome
Consultar cliente

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
CLIENT_IDSIMConsultar clienteID do cliente.
Ex: 12345

Variáveis criadas

NomeDescriçãoExemplo
ID_PROTOCOLID do protocolo encontrado1020
PROTOCOLSMensagem com lista de protocolos1 - 1020
2 - 1045
3 - 1049
PROTOCOLS_DATAIDs da lista de protocolos[1020, 1045, 1049]

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_PROTOCOL 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 PROTOCOLS para definir a variável ID_PROTOCOL e então prosseguir com a integração.

Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Selecionar protocolo

Selecionar um protocolo a partir da listagem de protocolos do cliente

Itens dependentes

Nome
Listar protocolos

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
CLIENT_PROTOCOLSIMNúmero do protocolo selecionado pelo cliente.
Ex: 1
PROTOCOLSSIMListar protocolosMensagem com lista de protocolos.
Ex: 1 - 1020 2 - 1045 3 - 1049
PROTOCOLS_DATASIMListar protocolosTIDs da lista de protocolos.
Ex: [1020, 1045, 1049]

Variáveis criadas

NomeDescriçãoExemplo
PROTOCOLNúmero do protocolo encontrado112203
STATUSStatus do protocoloAndamento
SLAData final para vencimento2018-09-13 16:44:00
TEAMSetor ao qual foi direcionadoFinanceiro - Contas a receber
ASSIGNMENT_IDID do trabalho267692

Retornos

Encontrado

Quando o protocolo for encontrado e selecionado com sucesso

Inválido

Quando o cliente digitar um número de protocolo inválido

Não encontrado

Quando o protocolo não for encontrado

Abrir chamado

Este item realiza a abertura de um chamado para o cliente

Itens dependentes

Nome
Consultar cliente

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
CLIENT_IDSIMConsultar clientID do cliente.
Ex: 11569
DESCRIPTIONSIMDescrição do chamado.
Ex: Sem conexão com internet
CLOSESIMFechar chamado automaticamente.
Ex: 0|1

Variáveis criadas

NomeDescriçãoExemplo
PROTOCOLProtocolo resultante da abertura do chamado112203

Retornos

Criado

Quando o chamado for aberto com sucesso

Não criado

Quando não for possível realizar a abertura de chamado

Gerar protocolo CMR

Abrir protocolo no CRM

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
DESCRIPTIONSIMDescrição do chamado.
Ex: Sem conexão com internet

Variáveis criadas

NomeDescriçãoExemplo
PROTOCOLO_CRMNúmero do protocolo gerado no CRM112203

Retornos

Criado

Quando o protocolo for gerado com sucesso

Não criado

Quando não for possível gerar o protocolo

Inserir nova nota

Itens dependentes

Nome
Consultar cliente
Selecionar protocolo

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
CLIENT_IDSIMConsultar clienteID do cliente.
Ex: 12345
ASSIGNMENT_IDSIMSelecionar protocoloID do trabalho.
Ex: 267692
TITLESIMTitulo da nota.
Ex: Falha de conexão
DESCRIPTIONSIMDescrição da nota.
Ex: Falha de conexão

Variáveis criadas

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

Retornos

Encontrado

Quando a nota inserida com sucesso

Não encontrado

Quando nota não for inserida

Solicitar Apontamento

Itens dependentes

Nome
Consultar cliente
Selecionar protocolo

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
CLIENT_IDSIMConsultar clienteID do cliente.
Ex: 12345
ASSIGNMENT_IDSIMSelecionar protocoloID do trabalho.
Ex: 267692
TITLESIMTitulo da nota.
Ex: Falha de conexão
DESCRIPTIONSIMDescrição da nota.
Ex: Falha de conexão

Variáveis criadas

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

Retornos

Encontrado

Quando a solicitação for realizada com sucesso

Não encontrado

Quando não for possível realizar a solicitação

Encerrar protocolo

Itens dependentes

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
CLIENT_IDSIMConsultar clienteID do cliente.
Ex: 12345
ASSIGNMENT_IDSIMSelecionar protocoloID do trabalho.
Ex: 267692
TITLESIMTitulo da nota.
Ex: Falha de conexão
DESCRIPTIONSIMDescrição da nota.
Ex: Falha de conexão

Variáveis criadas

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

Retornos

Encontrado

Quando o protocolo for encerrado com sucesso

Não encontrado

Quando não for possível encerrar o protocolo