SetSMSChannelAttributes
Written by
Updated at April 13, 2026
Setting parameters for the SMS notification channel.
HTTP request
POST https://notifications.yandexcloud.net/
Query parameters
| Parameter | Description |
|---|---|
Action |
string Required field. Operation type parameter. Value: SetSMSChannelAttributes. |
SMSChannelArn |
string This is a required field. SMS notification channel ID. Example: arn:aws:sns::b1gvlrnlei4l******:sms/channelname. |
Attributes.entry.N.key |
string Required field. Attribute key. N is a numeric value.Example: Attributes.entry.1.key=Description. |
Attributes.entry.N.value |
string Required field. Attribute value. N is a numeric value.Example: Attributes.entry.1.value=Test-sms-channel. |
ResponseFormat |
string Response format. The possible values are:
|
Attributes
| Attribute | Description |
|---|---|
IsDefault |
Specifies whether the channel is the default channel for outgoing SMS in this cloud. You can only set IsDefault for a channel in the Sandbox or Active state. Due to how Cloud Notification Service operates, this attribute cannot be provided along with other attributes. |
ChannelState |
Channel's target state. Possible states:
|
Description |
Description of the SMS notification channel. Example: Test-sms-channel. |
Response
Successful response
If there are no errors, Cloud Notification Service returns the 200 HTTP code.
A successful response contains additional data in XML or JSON format depending on the specified ResponseFormat parameter.
Data schema:
XML
JSON
<?xml version="1.0" encoding="UTF-8"?>
<SetSMSChannelAttributesResponse>
<ResponseMetadata>
<RequestId>string</RequestId>
</ResponseMetadata>
</SetSMSChannelAttributesResponse>
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Where RequestId is the request ID.
Error response
In case of an error, Cloud Notification Service returns a message with the appropriate HTTP code and its additional description in XML or JSON format depending on the specified ResponseFormat parameter.
Data schema:
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"
}
}
}
Where:
RequestId: Request ID.Code: Error code.Message: Error description.
For a list of common error codes for all actions, see Errors.
Errors specific for SetSMSChannelAttributes:
| HTTP | Error code | Extended code | Description |
|---|---|---|---|
| 400 | UserError | InvalidSMSChannelStateTransition | Unable to enter the specified channel state. |
| 400 | UserError | InvalidSMSChannelStateToSetDefault | In its current state, the channel cannot be set as the default channel. |
| 400 | UserError | InvalidSMSChannelAttributeCombination | The IsDefault attribute cannot be provided along with other attributes. |