> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ycloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# sms.message.updated

> Происходит, когда статус SMS-сообщения обновляется и меняется на `delivered` или `undelivered`.

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

## Триггеры

Происходит, когда статус SMS-сообщения обновляется и меняется на `delivered` или `undelivered`.

Подпишитесь на `sms.message.updated`, когда будете [настраивать конечную точку Webhook](https://docs.ycloud.com/ru/api-reference/guides/api-fundamentals/configure-webhooks.md).

## Синтаксис

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

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "id": "<ID>",
  "type": "sms.message.updated",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "sms": {
    "id": "<ID>",
    "to": "<TO>",
    "status": "<STATUS>",
    "externalId": "<EXTERNAL_ID>"
  }
}
```

## Параметры

Проверяйте HTTP-заголовок `YCloud-Signature` перед обработкой тела JSON. См. раздел [проверка подписи](https://docs.ycloud.com/ru/api-reference/guides/api-fundamentals/configure-webhooks.md).

### Конверт события

| Параметр | Тип | Обязательно | Описание |
| - | - | - | - |
| `id` | string | Да | Уникальный идентификатор события. Минимальная длина: `6`. Максимальная длина: `128`. |
| `type` | string | Да | Всегда `sms.message.updated`. |
| `apiVersion` | string | Да | Версия API, использованная для формирования этого события. |
| `createTime` | string (date-time) | Да | Время создания этого события в формате [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). Например, `2022-06-01T12:00:00.000Z`. |

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

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

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

#### sms

| Параметр | Тип | Обязательно | Описание |
| - | - | - | - |
| `id` | string | Да | Уникальный идентификатор объекта.Минимальная длина: `6`. Максимальная длина: `128`. |
| `to` | string | Да | Номер телефона получателя в формате [E.164](https://en.wikipedia.org/wiki/E.164). |
| `text` | string | Нет | Текст этого сообщения. |
| `senderId` | string | Нет | Используемый Sender ID. |
| `regionCode` | string | Нет | [Двухбуквенный код страны ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) |
| `totalSegments` | integer (int32) | Нет | Количество сегментов сообщения. Дополнительную информацию см. в разделе [Кодировка символов SMS](https://helpdocs.ycloud.com/help-center/integrations/channels/global-sms/sms-basic-principles#sms-encoding).Минимум: `1`. |
| `totalPrice` | number (double) | Нет | Общая стоимость этого сообщения. |
| `currency` | string | Нет | Валюта цены. [Код валюты ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). |
| `status` | string | Нет | Статус доставки. Одно из следующих значений: `accepted`, `sent`, `delivered`, `undelivered` или `failed`.<ul><li>`accepted`: запрос на отправку сообщения принят нашей системой.</li><li>`failed`: не удалось отправить сообщение из нашей системы.</li><li>`sent`: сообщение отправлено из нашей системы.</li><li>`delivered`: наша система получила отчет о доставке, подтверждающий, что сообщение доставлено.</li><li>`undelivered`: наша система получила отчет о доставке, указывающий, что сообщение не доставлено.</li></ul> |
| `errorCode` | string | Нет | Код ошибки, если сообщение невозможно доставить. |
| `createTime` | string (date-time) | Нет | Время создания этого сообщения в формате [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). Например, `2022-03-01T12:00:00.000Z`. |
| `updateTime` | string (date-time) | Нет | Время обновления отчета о доставке для этого сообщения в формате [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). Например, `2022-03-01T12:00:00.000Z`. |
| `externalId` | string | Нет | Уникальная (рекомендуется) строка для идентификации объекта. Это может быть номер заказа или аналогичный идентификатор, который можно использовать для сверки объекта с вашими внутренними системами. |
| `callbackUrl` | string | Нет | URL отчета о доставке. Вы можете указать URL, и мы своевременно отправим обновленный отчет о статусе на ваш сервер. Например, [https://httpbin.org/anything?tag=api](https://httpbin.org/anything?tag=api). Примечание: вместо этого мы рекомендуем настроить Webhook Endpoints. |
| `bizType` | string | Нет | Может быть пустым либо принимать одно из значений: `sms` или `verify`. По умолчанию: `sms`.<ul><li>`sms`: указывает на то, что сообщение отправлено через продукт **SMS**.</li><li>`verify`: указывает на то, что сообщение отправлено через продукт **Verify**.</li></ul> |
| `verificationId` | string | Нет | Идентификатор верификации. Включается только в том случае, если `bizType` имеет значение `verify`. |

## Пример

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

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "id": "evt_example_sms_message_updated",
  "type": "sms.message.updated",
  "apiVersion": "v2",
  "createTime": "2026-05-26T12:00:00.000Z",
  "sms": {
    "id": "sms_12345678",
    "to": "+12025550123",
    "status": "delivered",
    "externalId": "order_123"
  }
}
```

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

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```

Пошаговые сценарии приведены в разделе [примеры с пояснениями](https://docs.ycloud.com/ru/api-reference/guides/examples/webhook-examples/whatsapp-message-updated-webhook-examples).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.