sms.inbound.received

Используйте sms.inbound.received, чтобы обрабатывать это событие на вашей конечной точке Webhook.

Триггеры

Происходит при получении входящего SMS-сообщения, то есть когда пользователь отвечает на ваше сообщение. Подпишитесь на sms.inbound.received, когда будете настраивать конечную точку Webhook.

Синтаксис

YCloud отправляет HTTP-запрос POST на ваш настроенный URL-адрес Webhook. Ниже представлена одна из структур полезной нагрузки. Значения в угловых скобках являются плейсхолдерами; их типы перечислены в разделе Параметры. Необязательные поля и другие варианты описаны ниже.

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

Параметры

Проверяйте HTTP-заголовок YCloud-Signature перед обработкой тела JSON. См. раздел проверка подписи.

Оболочка события

Параметр	Тип	Обязательный	Описание
`id`	string	Да	Уникальный идентификатор события. Минимальная длина: `6`. Максимальная длина: `128`.
`type`	string	Да	Всегда `sms.inbound.received`.
`apiVersion`	string	Да	Версия API, использованная для формирования этого события.
`createTime`	string (date-time)	Да	Время создания события в формате RFC 3339. Например, `2022-06-01T12:00:00.000Z`.

Полезная нагрузка события

Параметр	Тип	Обязательный	Описание
`smsInbound`	object	Нет	Полезная нагрузка `smsInbound`, специфичная для события.

Четыре общих поля оболочки обязательны. Поля полезной нагрузки зависят от варианта события. В каждой таблице объектов значение Обязательный применяется, если присутствует родительский объект. Необязательные поля можно опускать; наличие поля в примере не делает его обязательным.

smsInbound

Параметр	Тип	Обязательный	Описание
`id`	string	Нет	Уникальный идентификатор сообщения.
`from`	string	Нет	Номер телефона пользователя, отправившего сообщение на ваш зарегистрированный Sender ID, в формате E.164.
`to`	string	Нет	Номер телефона получателя, который является одним из ваших зарегистрированных Sender ID.
`text`	string	Нет	Текст этого сообщения.
`sendTime`	string (date-time)	Нет	Время отправки сообщения в формате RFC 3339. Например, `2022-06-01T12:00:00.000Z`.

Пример

Ниже представлен JSON тела запроса, доставляемого вашему получателю. Идентификаторы, номера телефонов и другие значения учетной записи приведены для наглядности.

{
  "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"
  }
}

После проверки подписи и надежного подтверждения приема события верните ответ 2xx. Длительные операции обрабатывайте асинхронно.

HTTP/1.1 200 OK

Пошаговые сценарии см. в разделе примеры с пояснениями.

Начало работы

Руководства

Конечные точки

Webhook reference

Триггеры

Синтаксис

Параметры

Оболочка события

Полезная нагрузка события

smsInbound

Пример

​Триггеры

​Синтаксис

​Параметры

​Оболочка события

​Полезная нагрузка события

​smsInbound

​Пример

Триггеры

Синтаксис

Параметры

Оболочка события

Полезная нагрузка события

smsInbound

Пример