Saltar para o conteúdo principal
POST
/
webhooks
/
on-response
Webhook - Quando um usuário responde a uma pergunta
curl --request POST \
  --url https://seudominio.com/webhooks/on-response \
  --header 'Content-Type: application/json' \
  --data '{
  "country_code": "+57",
  "cellphone": "3161234567",
  "session_id": "1234",
  "conversation_id": "5678",
  "question": {
    "type": "closed",
    "text": "texto-da-pergunta-da-conversa",
    "answers": [
      {
        "text": "texto-da-resposta"
      }
    ]
  },
  "sent_at": "2019-01-01 00:00:00",
  "responded_at": "2019-01-01 00:00:00",
  "sent_text": "texto-enviado-ao-usuário",
  "actual_response": "Sim, preciso",
  "classified_answer": {
    "text": "texto-da-resposta"
  },
  "user_session_keys": [
    {
      "key": "name",
      "value": "João",
      "type": null
    },
    {
      "key": "user_id",
      "value": "12345",
      "type": null
    },
    {
      "key": "loc",
      "value": "{\"latitude\": 4.5935443, \"longitude\": -72.0345404, \"address\": \"Carrera 7 #100-06\"}",
      "type": "location"
    }
  ]
}'
{}

Body

application/json

Informações do evento de resposta

Evento que é disparado quando um usuário responde a uma pergunta na conversa

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
string
required

ID da conversa

question
object
required
sent_at
string<date-time>
required

Data e hora em que a pergunta foi enviada

responded_at
string<date-time>
required

Data e hora em que o usuário respondeu à pergunta

sent_text
string
required

Texto enviado ao usuário

actual_response
string
required

Resposta literal fornecida pelo usuário

classified_answer
object
required

Resposta classificada baseada na resposta do usuário

user_session_keys
object[]
required

Claves de sesión del usuario recopiladas durante la conversación o proporcionadas durante el despliegue

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