Saltar al contenido principal
POST
/
webhooks
/
on-optout
Webhook - Cuando un usuario se da de baja (opt-out)
curl --request POST \
  --url https://tudominio.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": "Hi! Thanks for attending our webinar today. We would like to have a feedback about our session and we would be very grateful if you could help us with that. ",
    "answers": [
      {
        "text": "Sure"
      },
      {
        "text": "No, thanks"
      },
      {
        "text": "DEFAULT"
      }
    ]
  },
  "sent_at": "2021-10-22 00:15:39.044704",
  "sent_text": "Hi! Thanks for attending our webinar today. We would like to have a feedback about our session and we would be very grateful if you could help us with that. \n1) Sure\n2) No, thanks\n3) DEFAULT",
  "user_session_keys": [],
  "classified_answer": {
    "text": "No, thanks"
  },
  "reason": "OPTOUT"
}'
{}

Body

application/json

Información del evento de opt-out

Evento que se dispara cuando un usuario decide darse de baja o salir de la conversación

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 al usuario

classified_answer
object
required

Respuesta clasificada basada en la respuesta del usuario

reason
enum<string>
required

Razón de la salida del usuario, en este caso 'OPTOUT' para indicar que el usuario decidió darse de baja

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

Respuesta para actualizar o agregar información a la sesión

Objeto JSON con la nueva información que será reemplazada o agregada a la sesión para uso futuro. El servicio debe responder en menos de 10 segundos.

I