Chats
Nesta seção é apresentada a consulta das interações em tickets gerados para o serviço de SAC, assim como são fornecidas as orientações para criar uma interação e atualizar o status do chat
Na guia Listar SAC é possível observar que o retorno para o endpoint /sac
traz informações gerais sobre o ticket, porém nele não constam as interações realizadas.
Para verificar as mensagens presentes em um SAC é necessário utilizar a URI /sac/{code}/chats
, que permite a consulta das interações, sejam elas entre seller e marketplace, seller e cliente e cliente e marketplace.
GET - Consultando chats de um pedido
A consulta dos chats para um pedido permite verificar todas as interações que ocorreram para a entrega informada em {code}
, conforme endpoint observado a seguir:
Para este endpoint serão necessários os headers padronizados na API e descritos abaixo:
Request headers:
X-User-Email
email_de_usuario
X-Api-Key
token_de_integracao de sua conta SkyHub
X-Accountmanager-Key
token_account único de cada Plataforma/ERP
Accept
application/json
Content-Type
application/json
Example request:
Response esperado:
200 [Success] - OK: Como resposta haverão as interações para o SAC gerado para o pedido referido na consulta:
Através do retorno acima é possível observar que as interações são identificadas no campo parts e consistem em:
CUSTOMER_B2W: Interação entre o cliente e a Americanas;
B2W_SELLER: Interação entre a Americanas e o seller;
CUSTOMER_SELLER: Interação entre o cliente e o seller.
Além do parts, o retorno apresentado na consulta trará o campo role, que será preenchido com a identificação de quem foi responsável pela interação e poderá conter os seguintes valores:
CUSTOMER: Cliente;
SELLER: A loja que está atuando na solicitação;
EMPLOYEE: Agentes do marketplace estão auxiliando no chat "Ajuda Americanas".
POST - Interagindo em um atendimento
Para responder a um ticket, será necessário utilizar os headers padronizados na API para executar uma requisição contendo o método POST para o endpoint abaixo:
Request body:
Example request:
Response esperado:
201 [Success] - Created
É comum ser retornado o status 422 ao tentar interagir em um chat com status PAUSED.
Isto ocorre porquê não é possível interagir em chats contendo este status, uma vez que o PAUSED destina-se a atendimentos que estão sendo mediados pelo marketplace.
PATCH - Atualizando o status do chat
É possível atualizar o status de um chat, seguindo a mesma estrutura vista na interação com o atendimento. Para tal, será necessário utilizar os headers padronizados na API para executar uma requisição contendo o método PATCH para o endpoint abaixo:
Request body:
Example request:
Response esperado:
204 [Success] - No content
Last updated