Действие CreateSMSChannel
Статья создана
Обновлена 25 марта 2026 г.
Создает канал SMS-уведомлений.
HTTP-запрос
POST https://notifications.yandexcloud.net/
Query-параметры
| Параметр | Описание |
|---|---|
Action |
string Обязательное поле. Параметр для обозначения типа операции. Значение: CreateSMSChannel. |
SenderID |
string Текстовое имя отправителя. Если имя не задано, создается канал SMS-уведомлений с общим отправителем в песочнице. В облаке может быть только один канал с общим отправителем. |
FolderId |
string Обязательное поле при аутентификации через IAM-токен. Идентификатор каталога, в котором создается канал SMS-уведомлений. При аутентификации через статический ключ сервисного аккаунта, если FolderId не указан, канал создается в одном каталоге с сервисным аккаунтом. Пример: b1gsm0k26v1l********. |
Attributes.entry.N.key |
string Обязательное поле. Ключ атрибута. N — числовое значение.Пример: Attributes.entry.1.key=Description. |
Attributes.entry.N.value |
string Обязательное поле. Значение атрибута. N — числовое значение.Пример: Attributes.entry.1.value=Test-sms-channel. |
ResponseFormat |
string Формат ответа. Возможные значения:
|
Атрибуты
| Атрибут | Описание |
|---|---|
Description |
string Описание канала SMS-уведомлений. Пример: Test-sms-channel. |
Ответ
Успешный ответ
При отсутствии ошибок Cloud Notification Service отвечает HTTP-кодом 200.
Успешный ответ содержит дополнительные данные в формате XML или JSON в зависимости от указанного параметра ResponseFormat.
Схема данных:
XML
JSON
<?xml version="1.0" encoding="UTF-8"?>
<CreateSMSChannelResponse>
<ResponseMetadata>
<RequestId>string</RequestId>
</ResponseMetadata>
<CreateSMSChannelResult>
<SMSChannelArn>string</SMSChannelArn>
</CreateSMSChannelResult>
</CreateSMSChannelResponse>
{
"ResponseMetadata": {
"RequestId": "string"
},
"CreateSMSChannelResult": {
"SMSChannelArn": "string"
}
}
Где:
RequestId— идентификатор запроса.SMSChannelArn— идентификатор (ARN) канала SMS-уведомлений.
Ответ с ошибкой
При возникновении ошибки Cloud Notification Service отвечает сообщением с соответствующим HTTP-кодом и дополнительным описанием в формате XML или JSON в зависимости от указанного параметра ResponseFormat.
Схема данных:
XML
JSON
<?xml version="1.0" encoding="UTF-8"?>
<ErrorResponseXML>
<RequestId>string</RequestId>
<Error>
<Code>string</Code>
<Message>string</Message>
</Error>
</ErrorResponseXML>
{
"ErrorResponse": {
"RequestId": "string",
"Error": {
"Code": "string",
"SubCode": "string",
"Message": "string"
}
}
}
Где:
RequestId— идентификатор запроса.Code— код ошибки.Message— описание ошибки.
Перечень общих кодов ошибок для всех действий см. в разделе Ошибки.
Ошибки, специфичные для действия CreateSMSChannel:
| HTTP | Код ошибки | Дополнительный код | Описание |
|---|---|---|---|
| 400 | UserError | SMSChannelLimitExceeded | Превышен лимит на число каналов SMS-уведомлений в облаке. |
| 400 | UserError | ChannelAlreadyExists | В облаке есть канал SMS-уведомлений с таким же текстовым именем отправителя. |