sms.inbound.received

Usa sms.inbound.received para gestionar este evento en tu endpoint de webhook.

Desencadenadores

Se produce cuando se recibe un mensaje SMS entrante, lo que significa que un usuario responde a tu mensaje. Suscríbete a sms.inbound.received cuando configures tu endpoint de webhook.

Sintaxis

YCloud envía una solicitud HTTP POST a la URL de webhook que hayas configurado. La siguiente estructura muestra una variante de la carga útil. Los valores entre corchetes angulares son marcadores de posición; sus tipos se indican en Parámetros. Los campos opcionales y otras variantes se describen a continuación.

{
  "id": "<ID>",
  "type": "sms.inbound.received",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "smsInbound": {
    "id": "<ID>",
    "from": "<FROM>",
    "to": "<TO>",
    "text": "<TEXT>",
    "sendTime": "<SEND_TIME>"
  }
}

Parámetros

Valida el encabezado HTTP YCloud-Signature antes de procesar el cuerpo JSON. Consulta la validación de firmas.

Envoltorio del evento

Parámetro	Tipo	Obligatorio	Descripción
`id`	string	Sí	ID único del evento. Longitud mínima: `6`. Longitud máxima: `128`.
`type`	string	Sí	Siempre `sms.inbound.received`.
`apiVersion`	string	Sí	La versión de la API utilizada para generar este evento.
`createTime`	string (date-time)	Sí	Hora en la que se creó este evento, con formato RFC 3339. Por ejemplo, `2022-06-01T12:00:00.000Z`.

Carga útil del evento

Parámetro	Tipo	Obligatorio	Descripción
`smsInbound`	object	No	Carga útil de `smsInbound` específica del evento.

Los cuatro campos comunes del envoltorio son obligatorios. Los campos de la carga útil dependen de la variante del evento. En cada tabla de objetos, Obligatorio se aplica cuando su objeto principal está presente. Los campos opcionales pueden omitirse; que aparezcan en un ejemplo no hace que sean obligatorios.

smsInbound

Parámetro	Tipo	Obligatorio	Descripción
`id`	string	No	ID único del mensaje.
`from`	string	No	Número de teléfono del usuario que envió el mensaje a tu sender ID registrado, formateado en E.164.
`to`	string	No	Número de teléfono del receptor, que corresponde a uno de tus Sender IDs registrados.
`text`	string	No	Texto de este mensaje.
`sendTime`	string (date-time)	No	Hora en la que se envió este mensaje, con formato RFC 3339. Por ejemplo, `2022-06-01T12:00:00.000Z`.

Ejemplo

El siguiente JSON es el cuerpo entregado a tu receptor. Los ID, los números de teléfono y otros valores de cuenta son ilustrativos.

{
  "id": "evt_example_sms_inbound_received",
  "type": "sms.inbound.received",
  "apiVersion": "v2",
  "createTime": "2026-05-26T12:00:00.000Z",
  "smsInbound": {
    "id": "sms_inbound_12345678",
    "from": "+12025550124",
    "to": "+12025550123",
    "text": "Please send the order details.",
    "sendTime": "2026-05-26T11:59:00.000Z"
  }
}

Tras verificar la firma y aceptar de forma duradera el evento, devuelve una respuesta 2xx. Procesa las tareas lentas de forma asíncrona.

HTTP/1.1 200 OK

Para ver guías paso a paso de situaciones prácticas, consulta los ejemplos comentados.

Primeros pasos

Guías

Endpoints

Webhook reference

Desencadenadores

Sintaxis

Parámetros

Envoltorio del evento

Carga útil del evento

smsInbound

Ejemplo

​Desencadenadores

​Sintaxis

​Parámetros

​Envoltorio del evento

​Carga útil del evento

​smsInbound

​Ejemplo

Desencadenadores

Sintaxis

Parámetros

Envoltorio del evento

Carga útil del evento

smsInbound

Ejemplo