Действие VerifySMSSandboxPhoneNumber
Статья создана
Обновлена 25 марта 2026 г.
Подтверждает тестовый телефонный номер для канала SMS-уведомлений в песочнице с помощью кода подтверждения.
HTTP-запрос
POST https://notifications.yandexcloud.net/
Query-параметры
| Параметр | Описание |
|---|---|
Action |
string Обязательное поле. Параметр для обозначения типа операции. Значение: VerifySMSSandboxPhoneNumber. |
OneTimePassword |
string Обязательное поле. Код подтверждения, отправленный на тестовый номер телефона. |
PhoneNumber |
string Обязательное поле. Номер телефона в формате E.164 |
SMSChannelArn |
string Обязательное поле. Идентификатор канала SMS-уведомлений. Пример: arn:aws:sns::b1gvlrnlei4l******:sms/channelname. |
ResponseFormat |
string Формат ответа. Возможные значения:
|
Ответ
Успешный ответ
При отсутствии ошибок Cloud Notification Service отвечает HTTP-кодом 200.
Успешный ответ содержит дополнительные данные в формате XML или JSON в зависимости от указанного параметра ResponseFormat.
Схема данных:
XML
JSON
<?xml version="1.0" encoding="UTF-8"?>
<CreateSMSSandboxPhoneNumberResponse>
<ResponseMetadata>
<RequestId>string</RequestId>
</ResponseMetadata>
</CreateSMSSandboxPhoneNumberResponse>
{
"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— описание ошибки.
Перечень общих кодов ошибок для всех действий см. в разделе Ошибки.
Ошибки, специфичные для действия VerifySMSSandboxPhoneNumber:
| HTTP | Код ошибки | Дополнительный код | Описание |
|---|---|---|---|
| 400 | UserError | InvalidOTP | Код подтверждения неверный, устарел или отменен после неудачной попытки подтверждения. |
| 404 | NotFound | SMSSandboxPhoneNumberNotFound | Данный номер не был добавлен в канал SMS-уведомлений для подтверждения. |