Действие SetSMSChannelAttributes
Статья создана
Обновлена 25 марта 2026 г.
Задать параметры канала SMS-уведомлений.
HTTP-запрос
POST https://notifications.yandexcloud.net/
Query-параметры
| Параметр | Описание |
|---|---|
Action |
string Обязательное поле. Параметр для обозначения типа операции. Значение: SetSMSChannelAttributes. |
SMSChannelArn |
string Обязательное поле. Идентификатор канала SMS-уведомлений. Пример: arn:aws:sns::b1gvlrnlei4l******:sms/channelname. |
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 Формат ответа. Возможные значения:
|
Атрибуты
| Атрибут | Описание |
|---|---|
IsDefault |
Указывает, является ли данный канал каналом по умолчанию при отправке SMS в этом облаке. Установить IsDefault можно только для канала в состоянии Sandbox или Active. Из-за особенностей Cloud Notification Service этот атрибут нельзя передавать вместе с другими атрибутами. |
ChannelState |
Целевое состояние канала. Возможные состояния:
|
Description |
Описание канала SMS-уведомлений. Пример: Test-sms-channel. |
Ответ
Успешный ответ
При отсутствии ошибок Cloud Notification Service отвечает HTTP-кодом 200.
Успешный ответ содержит дополнительные данные в формате XML или JSON в зависимости от указанного параметра ResponseFormat.
Схема данных:
XML
JSON
<?xml version="1.0" encoding="UTF-8"?>
<SetSMSChannelAttributesResponse>
<ResponseMetadata>
<RequestId>string</RequestId>
</ResponseMetadata>
</SetSMSChannelAttributesResponse>
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Где RequestId — идентификатор запроса.
Ответ с ошибкой
При возникновении ошибки 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— описание ошибки.
Перечень общих кодов ошибок для всех действий см. в разделе Ошибки.
Ошибки, специфичные для действия SetSMSChannelAttributes:
| HTTP | Код ошибки | Дополнительный код | Описание |
|---|---|---|---|
| 400 | UserError | InvalidSMSChannelStateTransition | Невозможно перейти в указанное состояние канала. |
| 400 | UserError | InvalidSMSChannelStateToSetDefault | Невозможно установить канал в текущем состоянии в качестве канала по умолчанию. |
| 400 | UserError | InvalidSMSChannelAttributeCombination | Атрибут IsDefault нельзя передавать вместе с другими атрибутами. |