Действие ListSMSSandboxPhoneNumbers

Получает список тестовый телефонных номеров для канала SMS-уведомлений в песочнице.

HTTP-запросHTTP-запрос

POST https://notifications.yandexcloud.net/

Query-параметрыQuery-параметры

ОтветОтвет

Успешный ответУспешный ответ

При отсутствии ошибок Cloud Notification Service отвечает HTTP-кодом 200.

Успешный ответ содержит дополнительные данные в формате XML или JSON в зависимости от указанного параметра ResponseFormat.

Схема данных:

<?xml version="1.0" encoding="UTF-8"?>
<ListSMSSandboxPhoneNumbersResponseXML>
    <ResponseMetadata>
    	<RequestId>string</RequestId>
	</ResponseMetadata>
	<ListSMSSandboxPhoneNumbersResult>
    	<PhoneNumbers>
    		<member>
  	  		<PhoneNumber>string</PhoneNumber>
  	  		<Status>Pending</Status>
  	  	</member>
    	</PhoneNumbers>
    </ListSMSSandboxPhoneNumbersResult>
</ListSMSSandboxPhoneNumbersResponseXML>

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "ListSMSSandboxPhoneNumbersResult": {
    "PhoneNumbers": [
      {
        "PhoneNumber": "string",
        "Status": "Pending",
        "IsDeletable": true
      }
    ]
  }
}

Где:

• RequestId — идентификатор запроса.
• PhoneNumber — номер телефона.
• Status — статус номера:
  • Pending — ожидается подтверждение.
  • Verified — подтвержден.
• IsDeletable — возможность удалить номер телефона. Тестовый номер можно удалить только спустя 24 часа после его добавления.

Ответ с ошибкойОтвет с ошибкой

При возникновении ошибки Cloud Notification Service отвечает сообщением с соответствующим HTTP-кодом и дополнительным описанием в формате XML или JSON в зависимости от указанного параметра ResponseFormat.

Схема данных:

<?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 — описание ошибки.

Перечень общих кодов ошибок для всех действий см. в разделе Ошибки.

См. такжеСм. также

• Обзор HTTP API Yandex Cloud Notification Service
• Отправить запрос HTTP API к Yandex Cloud Notification Service
• ListSMSSandboxPhoneNumbers в документации AWS.