Saltar para o conteúdo principal
POST
/
webhooks
/
on-read
Webhook - Quando uma mensagem é lida
curl --request POST \
  --url https://seudominio.com/webhooks/on-read \
  --header 'Content-Type: application/json' \
  --data '{
  "country_code": "+57",
  "cellphone": "3176477608",
  "session_id": "d2fa98d29a2670dfa119335df1b0371720d674f1677302aba228876a",
  "conversation_id": 34820,
  "question": {
    "type": "open",
    "text": "Olá! Bom dia. Espero que esteja tudo bem. Gostaria de continuar nossa conversa para resolver todos os seus problemas e preocupações?"
  },
  "sent_at": "2021-06-22 15:19:06.473256",
  "sent_text": "Olá! Bom dia. Espero que esteja tudo bem. Gostaria de continuar nossa conversa para resolver todos os seus problemas e preocupações?",
  "user_session_keys": [],
  "read_at": "2021-06-22 15:19:08"
}'
{}

Body

application/json

Informações do evento de leitura

Evento que é disparado quando uma mensagem é lida pelo usuário

​
country_code
string
required

Código do país do usuário

​
cellphone
string
required

Número de telefone do usuário sem o código do país

​
session_id
string
required

ID da sessão do usuário

​
conversation_id
integer
required

ID da conversa

​
question
object
required
​
sent_at
string<date-time>
required

Data e hora em que a mensagem foi enviada

​
sent_text
string
required

Texto da mensagem enviada

​
read_at
string<date-time>
required

Data e hora em que a mensagem foi lida pelo usuário

​
user_session_keys
object[]

Chaves de sessão do usuário coletadas durante a conversa ou fornecidas durante a implantação

Response

200 - application/json

Resposta para atualizar ou adicionar informações à sessão

Objeto JSON com as novas informações que serão substituídas ou adicionadas à sessão para uso futuro. O serviço deve responder em menos de 10 segundos.

⌘I