Troca de Mensagens

Para a troca de mensagens entre a mesa de análise manual e o atendente da loja, são disponibilizados dois endpoints:

• POST https://api.caas.qitech.app/car_rental/rental_agreement/{rental_agreement_id}/message
• GET https://api.caas.qitech.app/car_rental/rental_agreement/{rental_agreement_id}/messages

Todas as mensagens são vinculadas a uma análise, utilizando o id enviado no momento do envio da análise.

Envio de Mensagem

Para que seja realizado o envio de uma mensagem, é necessário realizar a requisição utilizando o método POST no endpoint message, com uma payload que possui os seguintes campos:

nome	tipo	descrição
author_document_number	string	CPF formatado de quem está enviando a mensagem
author_name	string	Nome de quem está enviando a mensagem
message	string	Mensagem sendo enviada

Exemplo de payload para envio de uma mensagem:

{
  "author_name": "John Sample",
  "author_document_number": "000.000.000-00",
  "message": "Alerta de fraude"
}

Recebimento de Mensagens

Para que as mensagens possam ser exibidas para o atendente, basta realizar a recuperação das mensagens trocadas por meio do endpoint de GET. O endpoint pode receber um query parameter chamado only_messages_to_show, que ao receber o valor true retorna somente as mensagens que devem ser exibidas na tela do atendente.

Os dados do autor somente são devolvidos quando a mensagem foi produzida por um ser humano.

Retorno no endpoint de recuperação de mensagens:

[
  {
    "author_name": "John Sample",
    "author_document_number": "000.000.000-00",
    "source": "analysis_screen",
    "message": "Análise finalizada",
    "message_date": "2019-11-05T13:34:12-03:00"
  },
  {...}
]