Webhook de Suscripción de Teléfono

POST

Se activa cuando un número de teléfono se suscribe 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.subscribe

data

Phone subscribe webhook data payload

object

phone

required

Número de teléfono que se suscribió

string

user_id

required

ID del usuario asociado con el número de teléfono

integer

created_at

required

Unix timestamp when the subscribe occurred

integer

campaign_code

required

Código de campaña asociado con la suscripción

string

additional_data

required

Datos adicionales relacionados con el evento de suscripción

Array<object>

object

short_link_code

required

Código de enlace corto asociado con la suscripción

string

group_id

required

ID del grupo asociado con la suscripción del teléfono

integer

timestamp

Marca de tiempo Unix cuando ocurrió la suscripción

Examples

Example subscribe

Evento de suscripción de teléfono

{
  "id": "ed18a290-766d-46cf-ab4e-6fa421405fbd",
  "data": {
    "phone": "+99559122567",
    "user_id": 21911,
    "created_at": 1757926648,
    "campaign_code": "1dkGdCC2xnBc",
    "additional_data": [],
    "short_link_code": "baaIoP",
    "group_id": 123
  },
  "name": "phone.subscribe",
  "created_at": 1757926648,
  "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