Webhook de Cancelación de Suscripción de Teléfono

POST

Se activa cuando un número de teléfono se da de baja mediante el envío de un formulario

Authorizations

• token

Request Body ^required

Media type application/json

object

id

UUID único de entidad

string

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

api_version

Versión de la estructura de datos de notificación

string

name

Nombre del evento de Webhook

string

created_at

Fecha en la que se añadió la entidad al sistema por el usuario

integer

attempt_total

Número total de intentos de entrega de webhooks de notificación

integer

>= 1 <= 4

attempt_number

Número de intento de notificación webhook actual

integer

>= 1

notification_task_id

Notification task identifier (request identifier)

string format: uuid

name

Allowed values: phone.unsubscribe

data

object

phone

required

Phone number that unsubscribed

string

user_id

required

ID of the user associated with the phone number

integer

created_at

required

Unix timestamp when the unsubscribe occurred

integer

campaign_code

required

Campaign code associated with the unsubscribe

string

additional_data

required

object

reason

required

object

id

required

Reason ID for unsubscribe. Possible values:

• 1: I never subscribed
• 2: Too many messages
• 3: I am not interested
• 4: Content is incomprehensible
• 5: I don’t like your company
• 6: Other

integer

Allowed values: 1 2 3 4 5 6

label

required

Human-readable reason for unsubscribe

string

additional_text

required

Additional text provided by the user

string

short_link_code

required

Short link code associated with the unsubscribe

string

unsubscribe_request_id

required

ID of the unsubscribe request

integer

group_id

ID of the group associated with the phone unsubscribe

integer

Examples

Example unsubscribe

Evento de cancelación de suscripción de teléfono

{
  "id": "ef58b437-1319-4b0c-961b-17214cf1cf32",
  "data": {
    "phone": "+4911113333444",
    "user_id": 2,
    "created_at": 1757849748,
    "campaign_code": "3KCKb5nMD",
    "additional_data": {
      "reason": {
        "id": 4,
        "label": "Es ist unverständlich"
      },
      "additional_text": "zusätzlicher Benutzertext mit Erklärung"
    },
    "short_link_code": "baaIou",
    "unsubscribe_request_id": 59
  },
  "name": "phone.unsubscribe",
  "created_at": 1757849748,
  "api_version": "2022-05-25",
  "attempt_number": 1,
  "attempts_total": 4
}

Responses

200

Webhook recibido

400

Estructura del cuerpo de la solicitud de webhook no válida

401

Solicitud de webhook no autorizada

403

Acceso Webhook prohibido

404

No se ha encontrado el punto final del webhook

500

Error del servidor