Consultar cliente

Neste item da integração podemos consultar os dados de um determinado cliente.

Itens dependentes

Este item não depende de nenhum item

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
LOGINSIMLogin de acesso a API.
Ex: integracao@exemplo.com
PASSWORDSIMSenha de autenticação.
Ex: senha_de_autenticacao
CPF_CNPJSIMDocumento para consulta de cliente.
Ex: 000.000.000-00
CHANGESSIMDefine se irá alterar dados do usuário ao salvar.
Ex: sim; nao
REMOVE_CANCSIMAltera dados do cliente de acordo com o tipo (CPF/CNPJ).
Ex: SIM; NAO

Variáveis criadas

Lista das variáveis que serão criadas na sessão apos a execução deste item

NomeExemplo de valor retornado
CODCLIRetorna o código do cliente.
Ex: 1234
CODSERCLIRetorna o código do serviço do cliente.
Ex: GU8O0VM2J2
MSGCONTRACTSLista de contratos.
Ex:
Digite 1 para
Descrição: Descrição do contrato

Retornos

Encontrado

Quando for encontrado apenas 1 resultado para esta consulta.

Se o retorno for somente 1 cliente encontrado, então as variáveis CODCLICODSERCLI j serão preenchidas automaticamente.

Encontrado vários

Quando for encontrado mais de 1 resultado para esta consulta.

Caso a consulta retorne vários resultados, então a variável MSGCONTRACTS será preenchida e poderá ser utilizada posteriormente no fluxo.

Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Consultar cliente bloqueado

Neste item da integração podemos consultar os dados de um determinado cliente bloqueado.

Itens dependentes

Este item não depende de nenhum item

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
LOGINSIMLogin de acesso a API.
Ex: integracao@exemplo.com
PASSWORDSIMSenha de autenticação.
Ex: senha_de_autenticacao
CPF_CNPJSIMDocumento para consulta de cliente.
Ex: 000.000.000-00
CHANGESSIMDefine se irá alterar dados do usuário ao salvar.
Ex: sim; nao
REMOVE_CANCSIMAltera dados do cliente de acordo com o tipo (CPF/CNPJ).
Ex: SIM; NAO

Variáveis criadas

Lista das variáveis que serão criadas na sessão apos a execução deste item

NomeExemplo de valor retornado
CODCLIRetorna o código do cliente.
Ex: 1234
CODSERCLIRetorna o código do serviço do cliente.
Ex: GU8O0VM2J2
MSGCONTRACTSBLOCLista de contratos.
Ex:
Digite 1 para
Descrição: Descrição do contrato

Retornos

Encontrado

Quando for encontrado apenas 1 resultado para esta consulta.

Se o retorno for somente 1 cliente encontrado, então as variáveis CODCLICODSERCLI j serão preenchidas automaticamente.

Encontrado vários

Quando for encontrado mais de 1 resultado para esta consulta.

Caso a consulta retorne vários resultados, então a variável MSGCONTRACTSBLOC será preenchida e poderá ser utilizada posteriormente no fluxo.

Não encontrado

Quando não for encontrado nenhum resultado para esta consulta

Enviar boleto (PDF)

Neste item pode-se enviar boleto(s) via PDF ao cliente

Itens dependentes

Este item não depende de nenhum item

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
LOGINSIMLogin de acesso a API.
Ex: integracao@exemplo.com
PASSWORDSIMSenha de autenticação.
Ex: senha_de_autenticacao
CPF_CNPJSIMDocumento para consulta de cliente.
Ex: 000.000.000-00
ID_INVOICESIMNúmero do boleto a ser enviado.
Ex: 654321

***ID_INVOICE é preenchido automaticamente pelo item de integração

Variáveis criadas

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

Retornos

Encontrado

Quando o(s) boleto(s) referente(s) for(em) enviado(s) com sucesso

Não encontrado

Quando nenhum boleto for encontrado

Enviar linha digitável

Neste item pode-se enviar linha(s) digitável(is) ao cliente

Itens dependentes

Este item não depende de nenhum item

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
LOGINSIMLogin de acesso a API.
Ex: integracao@exemplo.com
PASSWORDSIMSenha de autenticação.
Ex: senha_de_autenticacao
CPF_CNPJSIMDocumento para consulta de cliente.
Ex: 000.000.000-00
ID_INVOICESIMNúmero do boleto a ser enviado.
Ex: 654321

***ID_INVOICE é preenchido automaticamente pelo item de integração

Variáveis criadas

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

Retornos

Encontrado

Quando a(s) linha(s) digitável(is) for(em) enviado(s) com sucesso

Não encontrado

Quando nenhuma linha digitável for encontrado

Tipos de atendimento

Neste item pode-se listar os tipos de atendimento

Itens dependentes

Nome
Consultar cliente
Consultar cliente bloqueado

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
LOGINSIMLogin de acesso a API.
Ex: integracao@exemplo.com
PASSWORDSIMSenha de autenticação.
Ex: senha_de_autenticacao
CONTRACTSIMDocumento para consulta de cliente.
Ex: 000.000.000-00
CONTRACTSSIMNúmero do boleto a ser enviado.
Ex: 654321

Variáveis criadas

Lista das variáveis que serão criadas na sessão apos a execução deste item

NomeExemplo de valor retornado
TYPES_SEVICESLista de serviços.
Ex:
Código 1
Descrição: Descrição 01
Código 2
Descrição: Descrição 02

Retornos

Encontrado

Quando for encontrado um ou mais serviços.

Não encontrado

Quando nenhum serviço for encontrado.

Desbloqueio por confiança

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

Itens dependentes

Nome
Consultar cliente
Consultar cliente bloqueado

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
LOGINSIMLogin de acesso a API.
Ex: integracao@exemplo.com
PASSWORDSIMSenha de autenticação.
Ex: senha_de_autenticacao
CODSERCLISIMCódigo do serviço do cliente.
Ex: GU8O0VM2J2
CONTRACTSSIMLista de contratos.
Ex:
Digite 1 para
Descrição: Descrição do contrato

Variáveis criadas

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

Retornos

Encontrado

Quando o desbloqueio for realizado com sucesso

Não encontrado

Quando não for possível realizar o desbloqueio

Enviar histórico

Neste item é possível enviar o histórico da conversa ao cliente

Itens dependentes

Nome
Consultar contrato

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
LOGINSIMLogin de acesso a API.
Ex: integracao@exemplo.com
PASSWORDSIMSenha de autenticação.
Ex: senha_de_autenticacao
CPF_CNPJSIMDocumento para consulta de cliente.
Ex: 000.000.000-00
ID_CONTRACTSIMNúmero do contrato a ser desbloqueado.
Ex: 1234
HISTORICSIMHistórico da conversa.
Ex: Conversa registrada que será enviada

Variáveis criadas

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

Retornos

Encontrado

Quando o desbloqueio for realizado com sucesso

Não encontrado

Quando não for possível realizar o desbloqueio

Abertura de chamado

Neste item pode-se abrir chamado

Itens dependentes

Nome
Consultar cliente
Consultar cliente bloqueado

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
LOGINSIMLogin de acesso a API.
Ex: integracao@exemplo.com
PASSWORDSIMSenha de autenticação.
Ex: senha_de_autenticacao
CODCLISIMCódigo do cliente.
Ex: 1234
CONTRACTSSIMNúmero do boleto a ser enviado.
Ex: 654321
CODSERCLISIMCódigo do serviço do cliente.
Ex: GU8O0VM2J2
CODOCOPSIMDescrição (gerada altomática pelo sistema).
Ex: Esou abrindo esse chamado porque...
DESCRIPTIONSIMDescrição da abertura de chamado.
Ex: Esou abrindo esse chamado porque...

Variáveis criadas

NomeExemplo de valor retornado
CODOCOCódigo do atendimento.
Ex:
S65QSD43Q
NUMERO_OCONúmro do atendimento do cliente.
Ex:
123456

Retornos

Encontrado

Quando o chamado é aberto com sucesso

Não encontrado

Quando não é possível abrir o chamado.

Abertura de OS

Neste item pode-se abrir OS

Itens dependentes

Nome
Consultar cliente
Consultar cliente bloqueado

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
LOGINSIMLogin de acesso a API.
Ex: integracao@exemplo.com
PASSWORDSIMSenha de autenticação.
Ex: senha_de_autenticacao
CODCLISIMCódigo do cliente.
Ex: 1234
CODSERCLISIMCódigo do serviço do cliente.
Ex: GU8O0VM2J2
CODOCOPSIMDescrição (gerada altomática pelo sistema).
Ex: Esou abrindo esse chamado porque...
DESCRIPTIONSIMDescrição da abertura de chamado.
Ex: Esou abrindo esse chamado porque...

Variáveis criadas

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

Retornos

Encontrado

Quando a OS é aberto com sucesso

Não encontrado

Quando não é possível abrir a OS.

Abertura de ticket

Neste item pode-se abrir ticket

Itens dependentes

Nome
Consultar cliente
Consultar cliente bloqueado

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
LOGINSIMLogin de acesso a API.
Ex: integracao@exemplo.com
PASSWORDSIMSenha de autenticação.
Ex: senha_de_autenticacao
CODCLISIMCódigo do cliente.
Ex: 1234
CONTRACTSSIMNúmero do boleto a ser enviado.
Ex: 654321
CODSERCLISIMCódigo do serviço do cliente.
Ex: GU8O0VM2J2
DESCRIPTIONSIMDescrição da abertura de chamado.
Ex: Esou abrindo esse chamado porque...

Variáveis criadas

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

Retornos

Encontrado

Quando o ticket é aberto com sucesso

Não encontrado

Quando não é possível abrir o ticket.

Abertura de ticket departamento

Neste item pode-se abrir ticket

Itens dependentes

Nome
Consultar cliente
Consultar cliente bloqueado

Parâmetros

NomeObrigatórioExemplo
HOSTSIMHost da API do integrador.
Ex: http://exemplo.com
LOGINSIMLogin de acesso a API.
Ex: integracao@exemplo.com
PASSWORDSIMSenha de autenticação.
Ex: senha_de_autenticacao
CODCLISIMCódigo do cliente.
Ex: 1234
CODSERCLISIMCódigo do serviço do cliente.
Ex: GU8O0VM2J2
CODOCOPSIMDescrição (gerada altomática pelo sistema).
Ex: Esou abrindo esse chamado porque...

Variáveis criadas

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

Retornos

Encontrado

Quando o ticket é aberto com sucesso

Não encontrado

Quando não é possível abrir o ticket.