Alterar status de Atendimentos via API Leitura estimada: 4 minutos 388visualizações 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 Marcado:APIAtendimentoAtendimentosCitrusendpointProtocoloStatus
