CreateSMSChannel
Written by
Updated at July 20, 2026
Creates an SMS notification channel.
HTTP request
POST https://notifications.yandexcloud.net/
Query parameters
| Parameter | Description |
|---|---|
Action |
string Required field. Operation type parameter. Value: CreateSMSChannel. |
SenderID |
string Sender's text name. If not set, creates an SMS notification channel with a common sender in the sandbox. A cloud can contain only one such channel with a common sender. |
FolderId |
string Required field when authenticating via an IAM token. ID of the folder the SMS notification channel will be created in. When authenticating via a static service account key with FolderId not specified, the channel will be created in the same folder as the service account.Example: b1gsm0k26v1l********. |
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 |
|---|---|
Description |
string 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"?>
<CreateSMSChannelResponse>
<ResponseMetadata>
<RequestId>string</RequestId>
</ResponseMetadata>
<CreateSMSChannelResult>
<SMSChannelArn>string</SMSChannelArn>
</CreateSMSChannelResult>
</CreateSMSChannelResponse>
{
"ResponseMetadata": {
"RequestId": "string"
},
"CreateSMSChannelResult": {
"SMSChannelArn": "string"
}
}
Where:
RequestId: Request ID.SMSChannelArn: ID (ARN) of the SMS notification channel.
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 CreateSMSChannel:
| HTTP | Error code | Extended code | Description |
|---|---|---|---|
| 400 | UserError | SMSChannelLimitExceeded | Limit on the number of SMS notification channels in the cloud has been exceeded. |
| 400 | UserError | ChannelAlreadyExists | There is an SMS notification channel with the same sender text name in the cloud. |