endpoint – Citrus.cx

Integração com cliente

Fabiana Nonjah — Mon, 27 May 2024 12:57:00 +0000

27/05/2024

Confira a Tabela de Versionamento

Acesse a tela Integração com cliente (Administração > Configurações Gerais > Integração com cliente > (botão) +Novo).
Preencha o campo obrigatório "Nome" com um nome que defina a integração com o sistema externo. O campo "Descrição" é opcional, e pode ser preenchido com alguma observação referente a esta integração.
No bloco Dados para Autenticação, preencha os seguintes campos:

- Tipo de autenticação: Selecione "Basic Auth" ou "OAuth2".
- Endpoint de autenticação: A URL que permite acesso ao serviço externo.
- Usuário: Para login na autenticação.
- Senha: Para login na autenticação.
- Nome do token: O token de acesso para autenticação.
- Nome enviado no header: Nome a ser enviado com o token no header.
No bloco Dados para consulta, preencha os seguintes campos obrigatórios:

- URL: URL do endpoint que será feita a consulta dos dados.
- Campo do nome: Atributo do "de-para" ao nome dos clientes.
- Campo do código: Atributo do "de-para" ao código dos clientes.
- Campo de referência: Atributo do "de-para" ao campo código.
- Campo de referência para envio: Atributo do "de-para" ao campo código.
Ainda no bloco Dados para consulta, se desejar preencha os seguintes campos opcionais:

- Label do campo código adicional: Atributo do "de-para" à label do código adicional dos clientes.
- Campo código adicional: Atributo do "de-para" ao código adicional dos clientes.
- Telefone: Atributo do "de-para" ao telefone dos clientes.
- Telefone2: Atributo do "de-para" à segunda opção de telefone dos clientes.
- Celular: Atributo do "de-para" ao celular dos clientes.
- Email: Atributo do "de-para" ao email dos clientes.
- Campo de data de nascimento: Atributo do "de-para" à data de nascimento dos clientes.
- Campo que indica se o cliente está ativo: Atributo do "de-para" à indicação de status dos clientes.
- Nome do filtro para consulta no padrão Query search: Nome do filtro de consulta que permite a redução da quantidade de dados mostrados em uma visualização.
- Nome do parâmetro de pesquisa para o campo Nome: Parâmetro de consulta para o campo Nome passado por URL na requisição.
- Nome do parâmetro de pesquisa para o campo Código: Parâmetro de consulta para o campo Código passado por URL na requisição.
- Objeto com os dados: Atributo indicador que o resultado da chamada do serviço vai ser encapsulado por um objeto e recuperado os dados desse parâmetro.
- WebService de detalhamento: Configuração webservice que será utilizado nos modais de pesquisa de cliente para detalhar uma linha do resultado da consulta.
* Caso deseje selecionar opções neste campo, é necessário cadastrar nas seções Webservices principais e/ou Webservices secundários do bloco Outras integrações. Este bloco é exibido após o passo 7.

- Executa ação: Ao habilitar esta flag é possível configurar um botão de ação.
- Método HTTP: Selecione "Get", "Post" ou "Put"
- Nome da ação: Nome exibido no botão de ação.
- Webservice ação: URL do serviço que será chamado na ação.
- Habilitar o preenchimento automático do Tipo de Cliente: Ao habilitar esta flag é exibido o campo Tipo de cliente com as opções já configuradas na plataforma na tela Tipo de Cliente (Administração > Configurações Gerais > Tipo de Cliente).
* Durante a consulta de dados de um cliente na tela Atendimentos, caso não seja identificado na integração ou na base da plataforma, o "Tipo de cliente" é preenchido automaticamente com a opção configurada no campo Tipo de cliente associado a esta flag.
No bloco Configuração para consultas paginadas, preencha os seguintes campos:

- Objeto da paginação: Nome do objeto para paginação.
- Lista de objetos: A lista no retorno da API.
- Qtde. por página: Quantidade a ser exibida por página.
- Qtde. total: Quantidade total de objetos.
- Próxima página: Número de página.
- Página anterior: Número de página.
* Este recurso pode ser visto pelo Atendente na tela Consultar clientes integração (LemonDesk > Consultar clientes integração > (botão) Filtro). Exemplo: na pesquisa pelo campo "Nome".
Clique no botão Salvar e continuar no topo direito da tela.
Após o passo 7, é exibido abaixo do bloco Dados para Autenticação, o bloco Outras integrações com 02 (duas) seções: "Webservices principais" e 'Webservices secundários".
Clique no botão +Novo Webservice

.
É aberto o popup Webservice. Preencha os seguintes campos obrigatórios:

- Nome: O nome da consulta a ser realizada.
- Nome da aba: O nome da consulta a ser realizada.
- URL: URL do Webservice.
- Tipo de visualização: Selecione "Tabela" ou "Campos".
- Ícone: Escolha a imagem para o ícone da ação.

* O campo Descrição e a flag "Secundário" são opcionais. Permite indicar a observação do serviço externo e se será principal ou secundário, respectivamente.
Clique no botão Salvar e continuar do popup.
É exibido no popup o bloco Campos retorno, peencha os seguintes campos obrigatórios:

- Nome: Atributo do campo no serviço externo.
- Label: Nome para o campo na plataforma.
- Tamanho: O tamanho do campo na tela entre "1" e "12".
- Qtde. Máxima de Caracteres: Quantidade de caracteres para este campo.
- Tipo: Escolha o tipo de entrada de dados para o campo.

* Ao selecionar o Tipo "Select" é exibido o campo obrigatório Tipo de select com as opções: "Fixo", "Webservice" ou "Aninhado".
* Ao selecionar a opção "Webservice" é exibido o campo obrigatório Webservice para preenchimento. Ao selecionar a opção "Aninhado" são exibidos os campos obrigatórios Chave e Valor.

* A flag "Ação" e os campos: WebService para ação e Campos a serem atualizados são de preenchimento opcional, caso deseje configurar uma ação para o campo de retorno.
Clique no botão Salvar do bloco para este campo de retorno ser exibido na configuração. Na coluna "Ordem" é possível clicar nas setas e ajustar a ordenação. Se desejar fazer alguma alteração, clique no ícone Lixeira e repita o passo 12.
Ainda no popup, abaixo do bloco Campos retorno, se desejar configurar botões de ação e campos para filtro, utilize as abas: Ações e/ou Filtros de pesquisa.
Na aba Ações do popup, preencha os seguintes campos obrigatórios:

- Título: Nome do botão.
- Campo chave: Atributo no serviço externo.
- Tipo de ação: Escolha a ação do botão.
- Ícone: Imagem para o ícone de ação.
- Webservices secundário: O webservice habilitado como secundário.
- Expressão: Utilizada para validar a apresentação da ação. É feita seguindo a regra: CAMPO_COM_INFORMAÇÃO VALIDAÇÃO VALOR_A_SER_COMPARADO.
Clique no botão Salvar da aba para ser exibido ao lado esta configuração. Na coluna "Ordem" é possível clicar nas setas e ajustar a ordenação. Se desejar fazer alguma alteração, clique no ícone Lixeira e repita o passo 15.
Na aba Filtros de pesquisa do popup, preencha os seguintes campos obrigatórios:

- Campo: Atributo no serviço externo.
- Label: Nome do campo na plataforma.
- Tamanho: O tamanho do campo na tela entre "1" e "12".
- Tipo: Escolha o tipo de entrada de dados para o campo.

* Ao selecionar o Tipo "Select" é exibido o campo obrigatório Tipo de select com as opções: "Fixo", "Webservice" ou "Aninhado".

* Ao selecionar a opção "Webservice" é exibido o campo obrigatório Webservice para preenchimento. Ao selecionar a opção "Aninhado" são exibidos os campos obrigatórios Chave e Valor.
Clique no botão Salvar da aba para ser exibido ao lado esta configuração. Na coluna "Ordem" é possível clicar nas setas e ajustar a ordenação. Se desejar fazer alguma alteração, clique no ícone Lixeira e repita o passo 17.
Clique no botão Salvar no canto inferior direito do popup. O popup será fechado automaticamente.

DICA
Estas configurações realizadas no bloco Outras integrações são exibidas para o Atendente nas seguintes telas:
1. Atendimentos (LemonDesk > Atendimentos > (selecione na listagem) > ícone Integração > clique no (+) da aba).
2. Consultar clientes integração (LemonDesk > Consultar clientes integração > (botão) Filtro > (preencha os dados necessários) > (botão) Pesquisar > (clique no "Nome") > clique no (+) da aba).
Ainda na tela Integração com cliente, role a tela para baixo até o bloco Campos adicionais. Se desejar adicionar campos na plataforma para retorno de outros dados dos clientes, além dos dados principais do bloco Dados para consulta, preencha os seguintes campos obrigatórios:

- Label: Nome do campo na plataforma.
- Chave: Atributo no serviço externo.

* Utilize a flag "Visível na tabela de consulta" se desejar que os dados dos clientes sejam exibidos para os Atendentes nas telas:
1. Atendimentos (LemonDesk > Atendimentos > (selecione na listagem) > Dados do cliente).
2. Consultar clientes integração (LemonDesk > Consultar clientes integração > (botão) Filtro > (preencha os dados necessários) > (botão) Pesquisar).

* Se desejar, marque a flag "Imprimir campo no relatório" para que os dados sejam exibidos na tela Relatórios (Estatísticas > Relatórios).
Clique no botão +Adicionar para serem exibidos abaixo os campos configurados. Na coluna "Ordem" é possível clicar nas setas e ajustar a ordenação. Se desejar fazer alguma alteração, clique no ícone Lixeira e repita o passo 20.
Ao final da tela Integração com cliente, no bloco Dados para adicionar ao header da requisição, preencha os seguintes campos obrigatórios:

- Chave: Atributo no serviço externo.
- Valor: Dado a ser enviado a requisição.

* Ao lado, podem ser utilizadas as Tags que serão substituídas por dados do usuário logado no envio da requisição.
Clique no botão Salvar para serem exibidos os dados configurados. Se desejar fazer alguma alteração, clique no ícone Lixeira e repita o passo 22.
Volte ao topo direito da tela, e clique no botão Salvar.

Tabela de Versionamento

Fabiana Nonjah — Mon, 27 May 2024 12:57:00 +0000

27/05/2024

Versão	Última Atualização
2.98.0	27/05/2024

Por esta tabela é possível acompanhar todas as atualizações reportadas em Tutoriais e Manuais.

Nas telas de documentações que exibem a informação “Confira a Tabela de Versionamento”, pressione sobre a mensagem para ser encaminhado para esta tela com todas as versões contempladas. A seguir, basta abrir a versão indicada para acompanhar as atualizações correspondentes.

Pré-requisitos/Permissões

Fabiana Nonjah — Mon, 27 May 2024 12:56:00 +0000

27/05/2024

Confira a Tabela de Versionamento

O Administrador deve possuir permissões de acesso concedidas para o seu Perfil pelos times de Implantação ou Suporte da Smartspace.

O Administrador deve possuir conhecimento técnico do funcionamento da API e dos Webservices externos que deseja integrar, e configurar os dados de: autenticação, consulta, URL e método de requisição.

O Administrador deve verificar o que precisa constar na API para que a plataforma possa consultar com sucesso os dados dos clientes.

* Confira em Configurar API externa à Integração com cliente.

Para configurar Integração com cliente, o Administrador precisa ter as seguintes permissões habilitadas em seu Perfil:

– Administração

– Configurações Gerais

– Consultar clientes integração

– Listar integrações com cliente

– Criar integração com cliente

– Editar integração com cliente

– Excluir integração com cliente

* Confira como configurar Perfis de acesso.

Configurar API externa à Integração com cliente

Fabiana Nonjah — Mon, 27 May 2024 12:13:00 +0000

27/05/2024

Confira a Tabela de Versionamento

Uma das funcionalidades da plataforma é se integrar com uma API externa para buscar dados cadastrais de clientes, o que otimiza o processo de atendimento ao fornecer o maior número de informações possível sobre o cliente.

Nessa integração, a empresa (cliente Smartspace) fornece os dados através de uma API que será lida pela plataforma na tela Integração com cliente (Administração > Configurações Gerais > Integração com cliente > (botão) +Novo). Além de buscar as informações fornecidas pela API, também pode editá-las no sistema externo sem precisar acessá-lo.

Pré-requisitos

As informações necessárias devem ser especificadas utilizando um formato JSON e em protocolo HTTPS.

O path para chamadas deve ser disponibilizado pela empresa incluindo o de autenticação.

Autenticação

A API deve ter um dos seguintes tipos de autenticação:

Basic Auth: Autenticação básica no formato usuário e senha.
OAuth2: Protocolo de autenticação que fornece um access token.

Configuração

É possível detalhar informações sobre o cliente, como: nome, código, data de nascimento, email, telefone, estado civil, RG, CPF, CNPJ, gênero, e outros dados que sejam relevantes para o usuário.

Para que a plataforma o possa ler essas informações os campos devem estar em um array com propriedades de nível um. Se existirem hierarquias mais extensas não é possível resgatar os dados corretamente.

Se for necessário descrever o endereço do cliente por exemplo, os atributos devem ser inseridos na seguinte estrutura:

				
					"enderecoLogradouro": "string", 

"enderecoNumero": "string", 

"enderecoComplemento": "string",

"enderecoBairro": "string", 

"enderecoCidade": "string", 

"enderecoEstado": "string", 

"enderecoCep": "string", 

"enderecoPontoReferencia": "string"

Exemplo de payload com vários campos, incluindo os obrigatórios:

				
					[ 
  { 

     "nome": "JOÃO DA SILVA”, 

     “cpf”: “00000000000”, 

     “data_nascimen”: “00/00/0000”, 

     “crm”: "000000", 

     “email”: “email@email.com”, 

     “telefone”: “00000000000”, 

     “telefone_2”: “00000000000”, 

     “tipo_prestador”: “PESSOA FÍSICA”, 

     “especialidade”: “DERMATOLOGISTA”, 
     
     “endereco_logradouro”: “RUA ENDEREÇO, 100”, 
     
     “endereco_complemento”: “1 A”, 
     
     “endereco_cep”: “00000000”, 
     
     “endereco_bairro” “BAIRRO ENDEREÇO”, 
     
     “endereco_cidade”: “JOAO PESSOA”, 
     
     "endereco_estado”: “PB” 
     
     "pos_graduacao": "SIM”, 
     
     “ativo”: “TRUE” 

  } 
]

Integração com cliente

Fabiana Nonjah — Mon, 27 May 2024 12:12:00 +0000

27/05/2024

Confira a Tabela de Versionamento

A plataforma foi desenvolvida com o conceito de integração com outros sistemas. Um dos pontos chaves para que uma solução de gestão em atendimento omnichannel tenha sucesso é o processo de integração com sistemas externos ERP (Enterprise Resource Planning – Sistema Integrado de Gestão Empresarial). Assim é possível buscar e/ou atualizar informações dos clientes para que se tenha um processo de atendimento com o maior número de informações possíveis.

A plataforma possui a tela Integração com cliente (Administração > Configurações Gerais > Integração com cliente) onde é possível o Administrador configurar serviços externos e o Atendente realizar a busca pelas informações dos clientes na tratativa dos Atendimentos.

O recurso permite cadastrar diversos Webservices. Esta etapa de configuração de integrações é um processo mais técnico onde o Administrador precisa ter os dados da API. Existe o bloco Dados para Autenticação para autorizar a consulta dos dados, e o bloco Dados para consulta para configurar o Webservice principal de dados dos clientes.

Esse Webservice principal é utilizado para que a plataforma consulte os dados do cliente como: “Nome”, “Código”, “CPF”, “Telefone”, “Celular”, e “Email”, e já preencha automaticamente esses campos no registro de um novo atendimento. Em complemento a esses dados principais é possível configurar mais Webservices no bloco Outras integrações.

Dessa forma, o Administrador pode cadastrar todo tipo de serviço de API externa que ele deseje para realizar a busca de dados dos clientes que são atendidos através da plataforma. É um recurso muito importante porque uma das grandes dificuldades das empresas hoje é de manter atualizado o cadastro de seus clientes.

A Integração com cliente facilita a busca de dados em API’s e Webservices externos, com o retorno de informações que os Atendentes utilizam na gestão dos atendimentos. Este processo de integração possibilita que o Atendente, por qualquer tipo de canal de atendimento, consiga atualizar o cadastro dos clientes no sistema externo sem precisar acessá-lo.

Informações reunidas nesta documentação

Versão 2.86.0

Fabiana Nonjah — Fri, 01 Dec 2023 21:00:00 +0000

Monitoria de qualidade: Implementadas melhorias no processo de avaliação pelo Supervisor

A funcionalidade de Formulários de monitoria de qualidade (menu Administração > Monitoria de qualidade > Formulários de monitoria de qualidade) passou por melhorias para aprimorar o processo de avaliação pelos Supervisores. Com as mudanças, a realização da Monitoria da Qualidade torna-se possível em qualquer tipo de atendimento.

No caso de atendimentos encaminhados para membros de equipes que tratam Soluções com Etapas, por exemplo, passa a ser possível ao Supervisor avaliar o atendimento do Atendente que recepcionou e encaminhou o atendimento, mesmo quando ele ainda não tiver sido finalizado.

Nesse sentido, a avaliação da monitoria da qualidade não será feita sobre as Etapas de um chamado aberto, mas sobre o atendimento realizado pelo seu Criador, pelo Responsável pelo atendimento e pelos Responsáveis do atendimento nas Etapas executadas. Para tanto, a listagem da aba de Monitoria de qualidade, na tela de cadastro de um atendimento, que antes exibia todas as Etapas a serem avaliadas, passa a agrupá-las pelos nomes dos Atendentes que as realizaram.

Além disso, o e-mail de notificação será enviado ao Atendente somente após o Supervisor avaliá-lo e liberar o seu aceite clicando na caixa de seleção ao lado do formulário na listagem da aba Monitoria de qualidade na tela de cadastro de um atendimento. Do mesmo modo, uma cópia do e-mail de notificação será enviada ao Supervisor quando ele liberar o aceite do Atendente.

Quadro de avisos: Avisos passam a ser ordenados de acordo com datas de criação e edição

O Quadro de avisos do Dashboard da tela do Atendente (menu lateral > Atendente), que antes exibia seus itens considerando a data de expiração, recebeu melhorias para que a ordem de exibição dos Avisos passe a considerar as suas datas de criação e edição.

Para possibilitar essa ordenação, foi criado um campo de data de criação na base de dados, que será preenchido automaticamente no cadastro dos novos Avisos e atualizado nos registros já existentes na data em que for efetuada uma edição.

Na prática, o último Aviso criado sempre aparecerá no topo da lista, que priorizará os Avisos com data de criação mais recente. Do mesmo modo, quando um Aviso for editado por último, sua data de criação será atualizada e ele passará para o topo da lista. A mudança visa a facilitar a localização das informações mais recentes e relevantes para o acompanhamento das últimas atualizações realizadas na plataforma.

Estatísticas: Informações de usuários associados a mais de um Grupo de monitoramento estão carregando normalmente na tela de Monitoramento

Usuários cadastrados na plataforma, configurados como “Atendente”, “Supervisor” ou “Atendente e Supervisor”, pertencentes a mais de um Grupo de atendente e/ou mais de um Grupo de monitoramento, estão tendo suas informações carregadas normalmente nas telas de Monitoramento (menu Estatísticas > Monitoramento) ao logar nos canais de Chat e/ou Voz.

Foi corrigido o cenário de erro em que, caso um usuário configurado como Atendente e Supervisor simultaneamente (menu Administração > Usuários > Usuário > (selecionar) Usuário > (aba) Atendimento), e vinculado a Filas de atendimento de Chat e de Voz, logasse ao mesmo tempo nos canais de WhatsApp e de Voz, as telas de Monitoramento de que fazia parte deixavam de carregar corretamente.

Também foram observadas falhas nas telas de Monitoramento nos casos em que um usuário somente Atendente ou somente Supervisor, que estivesse em mais de um Grupo de monitoramento apenas com filas de Chat associadas, logava no canal de WhatsApp.

Verificou-se que o problema ocorria quando se tentava montar o nome de usuários logados nas Filas de Voz para exibi-los na tela de Monitoramento. Feitos os ajustes, as telas de Monitoramento voltam a ser carregadas normalmente e a exibir corretamente as informações relativas aos usuários.

Consulte o Guia de Monitoramento

Atendimentos: Implementadas melhorias de usabilidade na tela de cadastro

Com o objetivo de padronizar o layout das telas e melhorar a legibilidade dos campos, foram realizados ajustes no formulário de cadastro de Atendimentos, acessado pelo menu LemonDesk > Atendimentos > +Novo ou pela abertura automática pelos canais de Voz, WhatsApp e WebChat, bem como na tela de Pré-atendimentos (menu LemonDesk > Pré-atendimentos).

Para tanto, os títulos dos campos tiveram o tamanho de sua fonte aumentado. Do mesmo modo, as opções dos campos multiselect passaram por ajustes, com a mudança da cor e do peso da fonte.

As alterações consistem em uma adequação dos recursos da plataforma às diretrizes estabelecidas pela W3C (World Wide Web Consortium) para a manutenção dos padrões de acessibilidade na internet, assegurando uma navegação acessível a todos os usuários, independentemente de suas capacidades visuais.

Os ajustes foram aplicados às telas de cadastro de Atendimentos de Voz, WebChat e WhatsApp, e de Pré-atendimentos.

Campo “Região” do formulário de cadastro será automaticamente preenchido quando houver uma única opção configurada

Foram implementadas melhorias no preenchimento do campo “Região” do formulário de cadastro de Atendimentos, acessado após se aceitar um card na tela do Atendente (menu lateral > Atendente) ou ao criar um novo atendimento a partir do módulo LemonDesk (menu LemonDesk > Atendimentos > + Novo).

Com a melhoria realizada, a plataforma passa a realizar uma validação quando houver apenas uma opção de Região configurada (menu Administração > Configurações Gerais > Região), o que fará com que essa Região seja automaticamente selecionada na tela de cadastro do novo Atendimento, otimizando o tempo de preenchimento em tela.

Agendamentos: Atendimentos abertos automaticamente a partir de campanhas ativas e com status Finalizado estão apresentando data de fechamento

Os Atendimentos abertos automaticamente a partir de Agendamentos (menu Administração > Atendimentos > Agendamentos) de campanhas ativas e com status Finalizado estão apresentando suas respectivas datas de abertura e fechamento corretamente.

Foi corrigido o cenário em que campanhas ativas de SMS (Campanha de SMS) e E-mail (Envio de email) parametrizadas para abertura automática de atendimento (flags de Abertura de atendimento automática na resposta ou no envio) e com “Status do atendimento” Finalizado, não estavam registrando suas datas de fechamento no banco de dados, o que fazia com que o campo dessa informação ficasse em branco na tela dos Atendimentos abertos automaticamente (menu LemonDesk > Atendimentos > (selecionar) Protocolo de atendimento).

Na resolução, foi adicionado o dado de data de fechamento para Atendimentos criados a partir de Agendamentos de campanhas de SMS e E-mail quando o status estiver configurado como Finalizado.

Feitas as correções, todos os atendimentos abertos automaticamente originados de campanhas ativas, independentemente do canal de atendimento, ao serem criados com status Finalizado, apresentarão suas datas de Abertura e Fechamento.

Atendimentos: Botão de download de Anexos de Pré-atendimentos convertidos está visível e funcional

O botão para download de Anexos (), localizado na área de campos extras da aba Solução da tela dos Protocolos de Atendimentos, está funcionando normalmente.

Foi corrigido o cenário em que, após a conversão em Atendimento de um Pré-atendimento gerado a partir de um Formulário web, caso houvesse campos extras do Tipo Anexo configurados, não era possível baixar os anexos salvos no Pré-atendimento na tela do Protocolo do Atendimento convertido, pois o botão de download não ficava visível.

Feitas as correções, agora, quando um Atendente abrir um Pré-atendimento (menu LemonDesk > Pré-atendimentos), criado a partir de um formulário web, e convertê-lo em Atendimento, ao acessar o seu Protocolo pelo submenu Atendimentos (menu LemonDesk > Atendimentos), nos campos extras da aba Solução, os botões para download de Anexos serão exibidos e funcionarão conforme o esperado.

Consultar status de Atendimentos via API

Fabiana Nonjah — Mon, 13 Nov 2023 19:24:22 +0000

Confira a documentação de uso da API para consultar o status de um protocolo de atendimento.

Pré-requisitos

Para utilizar esta API existe a seguinte regra:

O usuário precisa ter em seu perfil a permissão Consultar status de atendimento via api.
Para liberar o acesso basta acessar: Administração > Usuários > Perfil, escolher o perfil desejado e então habilitar a permissão Consultar status de atendimento via API.

Autenticação de usuário

Para autenticar um usuário na plataforma, utilize o seguinte endpoint: /api/usuario/login

No retorno com sucesso para o método post será exibido uma mensagem contendo o token de acesso aos demais endpoints dessa API.

Parâmetros no JSON	Descrição
login	Credencial de acesso do usuário na plataforma com permissão para alterar status de atendimentos
senha	Credencial de autenticação do usuário na plataforma com permissão para alterar status de atendimentos

Body

{

“login”: “user.api”,
“senha”: “1234”

}

O retorno da chamada para o endpoint poderá ser um dos status a seguir:

SUCESSO

Access token: código do token

ERRO

Usuário não encontrado
Senha inválida
Houve um problema para gerar um token
Este campo é obrigatório – login
Este campo é obrigatório senha
Access denied (Usuário sem permissão)
Token is missing (Request sem token)
JWT expired at ano-mes-data-hora Current Time: ano-mes-data-hora, a difference of number milliseconds. Allowed clock skew: number miliseconds. (Token expirado)
*JWT signature does not match locally computed signature. JWT validity cannot be asserted and should not be trusted. (Token com falha)

Consultar status de um Protocolo do Atendimento

Para consultar status de um protocolo de atendimento na plataforma, utilize o seguinte endpoint: api/atendimentos/status/numerodoprotocolo

No endpoint numerodoprotocolo deve ser informado o número do protocolo do Citrus para realizar a consulta.

Este endpoint poderá ser usado para consultar protocolos de atendimento com os seguintes status:

Aberto
Em atendimento
Cancelado
Improcedente
Finalizado
Aguardando retorno

Exemplo de Requisição

Exemplo de Retorno

{
“protocolo”: “202301024000001”,
“status”: “Finalizado”,
}

O retorno da chamada para o endpoint poderá ser um dos status a seguir:

SUCESSO

[200] Message: Atendimento atualizado com sucesso

ERRO

[404] Atendimento não encontrado
[403] Access denied

Alterar status de Atendimentos via API

Fabiana Nonjah — Mon, 13 Nov 2023 17:53:05 +0000

Confira a documentação de uso da API para alterar um Status de Atendimento.

Pré-requisitos

Para utilizar esta API existem as seguintes regras:

O usuário precisa ter em seu perfil a permissão Alterar status de atendimento via api.
Para liberar o acesso basta acessar: Administração > Usuários > Perfil, escolher o perfil desejado e então habilitar a permissão Alterar status de atendimento via API.
Para que seja possível visualizar essa permissão de acesso, um usuário Administrador (com permissões root) deve habilitá-la para os demais usuários na hierarquia.
É preciso possuir motivos cadastrados na tela Motivo (Administração > Configurações Gerais > Motivo)

Autenticação de usuário

Para autenticar um usuário na plataforma, utilize o seguinte endpoint: /api/usuario/login

No retorno com sucesso para o método post será exibido uma mensagem contendo o token de acesso aos demais endpoints dessa API.

Parâmetros no JSON	Descrição
login	Credencial de acesso do usuário na plataforma com permissão para alterar status de atendimentos
senha	Credencial de autenticação do usuário na plataforma com permissão para alterar status de atendimentos

Body

{

“login”: “user.api”,
“senha”: “1234”

}

O retorno da chamada para o endpoint poderá ser um dos status a seguir:

SUCESSO

Access token: código do token

ERRO

Usuário não encontrado
Senha inválida
Houve um problema para gerar um token
Este campo é obrigatório – login
Este campo é obrigatório senha
Acess denied (Usuário sem permissão)
Token is missing (Request sem token)
JWT expired at ano-mes-data-hora Current Time: ano-mes-data-hora, a difference of number milliseconds. Allowed clock skew: number miliseconds. (Token expirado)
*JWT signature does not match locally computed signature. JWT validity cannot be asserted and should not be trusted. (Token com falha)

Alterar status de um Protocolo de Atendimento

Para alterar status de um protocolo de atendimento na plataforma, utilize o seguinte endpoint: api/atendimentos/status

Este endpoint poderá ser usado para alterar status de um atendimento para:

Aberto
Em atendimento
Cancelado
Improcedente
Finalizado

Para os status Cancelado, Improcedente e para reabrir um atendimento que já estava com o status Finalizado deve ser enviado o parâmetro de Motivo para realizar a ação.

Os Motivos são utilizados para justificar determinadas ações executadas pelos usuários na plataforma, como alterações, exclusões e restrições.

Parâmetros no JSON	Descrição
protocolo	Informe o número do protocolo do atendimento no Citrus que terá o status alterado
status	Informe o nome do status que deve alterado
motivoStatus	Informe o nome do motivo cadastrado na plataforma para os status “Cancelado”, “Improcedente” e a reabertura de um atendimento com o status “Finalizado”

Body

{

“protocolo”: “20221104000001”,
“status”: “Finalizado”,
“motivoStatus:”Atendimento já finalizado”

}

O retorno da chamada para o endpoint poderá ser um dos status a seguir:

SUCESSO

[200] Message: Atendimento atualizado com sucesso

ERRO

[404] Atendimento não encontrado
[404] Status não encontrado
[400] motivoStatus – esse campo é obrigatório

Incluir comentários nos Protocolos de Atendimento

A partir da versão 2.63.0 será possível adicionar comentários nos protocolos durante a atualização de status de atendimento. Devem ser enviados os parâmetros de comentario e visivelCliente para realizar a ação.

O comentário será utilizado para inserir as informações desejadas pelo usuário e o visivelCliente é necessário para informar se este é visível para o cliente.

Parâmetros no JSON	Descrição
protocolo	Informe o número do protocolo do atendimento no Citrus que terá o status alterado
status	Informe o nome do status que deve alterado
motivoStatus	Informe o nome do motivo cadastrado na plataforma para os status “Cancelado”, “Improcedente” e a reabertura de um atendimento com o status “Finalizado”
comentario	Informe o comentário que será adicionado ao protocolo de atendimento
visivelCliente	Informe com “True” ou “False” se o comentário estará visível para o cliente

Body

{

“protocolo”: “20221104000001”,
“status”: “Finalizado”,
“motivoStatus:” “
“comentario:”Comentário de atendimento”
“visivelCliente:”true”

}

O retorno da chamada para o endpoint poderá ser um dos status a seguir:

SUCESSO

[200] Message: Atendimento atualizado com sucesso

ERRO

[404] Atendimento não encontrado
[404] Status não encontrado
[400] motivoStatus – esse campo é obrigatório

Versão 2.41.0

Fabiana Nonjah — Wed, 21 Jun 2023 11:52:40 +0000

Formatação de mensagem

Foi adicionada a funcionalidade que permite ao atendente e ao usuário enviar e receber mensagens com quebra de linha via Webchat e Whatsapp. Para adicionar a quebra de linha clique Shift + Enter no fim de uma frase.

Interpretar tags HTML

Agora no Citrus.cx o chat de atendimento interpreta as tags HTML inseridas no chat.

Exemplos de uso:

- Negrito: Texto
- Itálico: Texto
- Sublinhado: Texto

Novo endpoint

Foi criado um endpoint que retorna as informações da plataforma como a descrição do build e a versão atual, para facilitar o monitorando da solução.

Melhora na performance

Agora as informações dos clientes, ações de troca de mensagens e interações na tela do atendimento carregam mais rápido, pois foram desenvolvidas APIs que facilitam a execução desses serviços.

Notificação de um novo Lead

Corrigimos o erro que impedia que o vendedor recebesse o e-mail informando que foi atribuído um Lead a ele.

Alteração do vendedor em Oportunidade

Foi corrigido o cenário em que a alteração do vendedor em LimeSales > Oportunidades não estava funcionando.

Usuário bloqueado recebendo e-mail

Foi corrigido o cenário em que um usuário bloqueado recebia e-mails de notificação dos protocolos de atendimento.

Exclusão de usuário

Ajuste realizado para que ao tentar excluir um usuário com algum procedimento vinculado a ele, seja informado na mensagem de alerta que pode haver vínculo com algum(ns) procedimento(s).

Campo de telefone na simulação de venda

Foi corrigido o cenário em que no módulo LimeSales, a terceira etapa — Dados do Cliente na simulação de venda, o código e o telefone não eram carregados a partir do cadastro do Lead.

Agendamento de pesquisa de satisfação por SMS

Efetuada a correção no agendamento de pesquisa de satisfação, para ser considerado todos os registros importados via CSV. Além disso, foi adicionado uma mensagem de alerta ao usuário para ter ciência de que o SMS não pode exceder o limite de 160 caracteres, incluindo o conteúdo variável das Tags nessa contagem.

Informações do cliente

Efetuada a correção para que na tela do atendimento seja carregada a partir do cadastro cliente, o tipo de cliente e/ou região e/ou código.

Fluxo do HSM

Corrigimos o erro no fluxo do HSM que impedia a verificação se o usuário possui mensagem enviada nas últimas 24 h.