Chats

​
Através do chats é possível buscar todas as interações que ocorreram no pedido, seja ela entre loja e marketplace, loja e cliente, e cliente e marketplace.
Além disso, é possível responder o chat e verificar o status que se encontra.
Como listar chats de um pedido?
Ao listar chats é possível verificar todas as interações que ocorreram para o pedido informado em {code}.
As interações são identificadas no campo parts e incluem:
CUSTOMER_B2W: Interação do cliente com a Americanas
B2W_SELLER: Interação entre a Americanas e seller
CUSTOMER_SELLER: Interação entre cliente e seller
Além do campo parts mencionado acima, o retorno na listagem trará no campo role a identificação de quem realizou tal interação e contém possíveis valores:
CUSTOMER: Cliente
SELLER: A loja que está atuando na solicitação
EMPLOYEE: Atendente Americanas que está auxiliando no chat "Ajuda Americanas"
Para listar os chats deve ser utilizado o método GET no endpoint  abaixo:
1
https://api.skyhub.com.br/sac/{code}/chats/
Copied!
​
Request Headers:
Name
Type
Required
Description
Example
accept
String
Required
O formato que você deseja receber o retorno da requisição
application/json
x-user-email
String
Required
E-mail da loja
[email protected]_EMAIL.COM
x-api-key
String
Required
Token da loja
  SUA API KEY
x-accountmanager-key
String
Required
código identificado da integração
SUAXACCOUNT
Example Request:
1
curl --location --request GET 'https://api.skyhub.com.br/sac/{code}/chats' \
2
--header 'x-api-key: YOUR API KEY HERE' \
3
--header 'x-user-email: [email protected]_EMAIL.COM' \
4
--header 'content-type: application/json' \
5
--header 'accept: application/json' \
6
--header 'x-accountmanager-key: SUAXACCOUNT'
Copied!
Responses:
200 - Success
1
{
2
  "status": "ACTIVE",
3
  "seller_status": "UNREAD",
4
  "parts": "CUSTOMER_SELLER",
5
  "messages": [
6
    {
7
      "replyed_at": "2019-10-03T14:20:41",
8
      "part": {
9
        "role": "CUSTOMER",
10
        "name": "John John",
11
        "email": "[email protected]",
12
        "code": 123456
13
      },
14
      "created_at": "2019-10-02T11:39:23",
15
      "content": "Bom dia! Produto não chegou!"
16
    }
17
  ],
18
  "last_message": "2019-10-07T18:56:22"
19
}
Copied!
404 - Not found
1
{
2
  "errors": {
3
    "detail": "Error message"
4
  }
5
}
Copied!
500 - Internal server error
1
{
2
  "errors": {
3
    "detail": "Error message"
4
  }
5
}
Copied!
Como interagir no chamado?
Para interagir, ou seja, responder um ticket, será necessário utilizar o método POST o endpoint a baixo:
1
https://api.skyhub.com.br/sac/{code}/chats/:parts
Copied!
Parâmetros obrigatórios:
Name
Type
Required
Description
Example
code
string
Required
será o marketplace + pedido
Lojas Americanas-9999900001
parts
string
Required
possíveis valores
CUSTOMER_SELLER
B2W_SELLER
​
CUSTOMER_SELLER
Example Request:
1
curl --location --request POST 'https://api.skyhub.com.br/sac/{code}/chats/' \
2
--header 'x-api-key: YOUR API KEY HERE' \
3
--header 'x-user-email: [email protected]_EMAIL.COM' \
4
--header 'content-type: application/json' \
5
--header 'accept: application/json' \
6
--header 'x-accountmanager-key: SUAXACCOUNT' \
7
--data-raw '{
8
  "deliveryId": "3",
9
  "identityId": "00007604079750",
10
  "messageTo": "TO_CUSTOMER",
11
  "messageType": "TEXT_MESSAGE",
12
  "orderId": "1234567",
13
  "message": "Tralalá trililí"
14
}'
Copied!
Example Body:
1
{
2
  "deliveryId": "3",
3
  "identityId": "00007604079750",
4
  "messageTo": "TO_CUSTOMER",
5
  "messageType": "TEXT_MESSAGE",
6
  "orderId": "1234567",
7
  "message": "Tralalá trililí"
8
}
Copied!
Valores:
"deliveryId": numero do entrega
 "identityId": "identificador do documento", 
"messageTo": "TO_CUSTOMER", 
"messageType": "TEXT_MESSAGE" 
"orderId": "numero da entrega", 
"message": Mensagem a ser enviado
Responses:
 200 - Success
422 - Unprocessable Entity
O retorno do HTTP 422 pode ocorrer quando o status do chat é igual a "PAUSED". Não é possível interagir em chats com esse status, onde as interações são realizadas pelo SAC do marketplace.
1
{
2
  "errors": [
3
    {
4
      "links": [],
5
      "logref": "log",
6
      "message": "Você Não pode mandar mensagem nesse chat, possíveis motivos: Mediação em Andamento ou SAC é o responsável pelo atendimento dessa entrega."
7
    }
8
  ]
9
}
Copied!
500 - Internal server error
1
{
2
  "errors": {
3
    "detail": "Error message"
4
  }
5
}
Copied!
Como atualizar o status do chat?
Para atualizar o status de um chat, será necessário utilizar o método PATCH e a endpoint abaixo:
1
https://api.skyhub.com.br/sac/{code}/chats/:parts
Copied!
Example Request:
1
curl --location --request PATCH 'https://api.skyhub.com.br/sac/{code}/chats/' \
2
--header 'x-api-key: YOUR API KEY HERE' \
3
--header 'x-user-email: [email protected]_EMAIL.COM' \
4
--header 'x-accountmanager-key: SUAXACCOUNT' \
5
--header 'accept: application/json' \
6
--header 'content-type: application/json' \
7
--data-raw '{
8
  "status": "READ"
9
}'
Copied!
Example Body:
1
{
2
  "status": "READ"
3
}
Copied!
Valores que serão informados no body:
READ
ARCHIVED
UNREAD
Parâmetros obrigatórios:
Name
Type
Required
Description
Example
code
string
Required
será o marketplace + pedido
Lojas Americanas-9999900001
parts
string
Required
possíveis valores
CUSTOMER_SELLER
B2W_SELLER
​
CUSTOMER_SELLER
Responses:
204 - No content
500 - Internal server error
1
{
2
  "errors": {
3
    "detail": "Error message"
4
  }
5
}
Copied!

Listar SAC

Items

Last modified 5mo ago

Copy link

Contents

Como listar chats de um pedido?

Como interagir no chamado?

Como atualizar o status do chat?