Saltar para o conteúdo principal
POST
/
webhooks
/
on-optout
Webhook - Quando um usuário cancela a inscrição (opt-out)
curl --request POST \
  --url https://seudominio.com/webhooks/on-optout \
  --header 'Content-Type: application/json' \
  --data '{
  "country_code": "+57",
  "cellphone": "3176477608",
  "session_id": "85b398ef5bcb20c355f3710c4509349784c907673c9118fb7a89c7a8",
  "conversation_id": 54263,
  "question": {
    "type": "closed",
    "text": "Oi! Obrigado por participar do nosso webinar hoje. Gostaríamos de ter um feedback sobre nossa sessão e ficaríamos muito gratos se você pudesse nos ajudar com isso. ",
    "answers": [
      {
        "text": "Claro"
      },
      {
        "text": "Não, obrigado"
      },
      {
        "text": "PADRÃO"
      }
    ]
  },
  "sent_at": "2021-10-22 00:15:39.044704",
  "sent_text": "Oi! Obrigado por participar do nosso webinar hoje. Gostaríamos de ter um feedback sobre nossa sessão e ficaríamos muito gratos se você pudesse nos ajudar com isso. \n1) Claro\n2) Não, obrigado\n3) PADRÃO",
  "user_session_keys": [],
  "classified_answer": {
    "text": "Não, obrigado"
  },
  "reason": "OPTOUT"
}'
{}

Body

application/json

Informações do evento de cancelamento de inscrição

Evento que é disparado quando um usuário decide cancelar a inscrição ou sair da conversa

country_code
string
required

Código de país del usuario

cellphone
string
required

Número de teléfono del usuario sin el código de país

session_id
string
required

ID de la sesión del usuario

conversation_id
integer
required

ID de la conversación

question
object
required
sent_at
string<date-time>
required

Fecha y hora en que se envió la pregunta

sent_text
string
required

Texto enviado ao usuário

classified_answer
object
required

Resposta classificada baseada na resposta do usuário

reason
enum<string>
required

Razão da saída do usuário, neste caso 'OPTOUT' para indicar que o usuário decidiu cancelar a inscrição

Available options:
OPTOUT
user_session_keys
object[]

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