Действие GetSMSChannelAttributes

Получает параметры канала 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"?>
<GetSMSChannelAttributesResponseXML>
    <ResponseMetadata>
    	<RequestId>string</RequestId>
	</ResponseMetadata>
	<GetSMSChannelAttributesResult>
    	<Attributes>
  	  	<entry>
  	  		<key>string</key>
  			  <value>string</value>
  		  </entry>
  	  </Attributes>
    </GetSMSChannelAttributesResult>
</GetSMSChannelAttributesResponseXML>

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "GetSMSChannelAttributesResult": {
    "Attributes": {
      "Attribute": "string"
    }
  }
}

Где:

• RequestId — идентификатор запроса.
• SMSChannelArn — идентификатор (ARN) канала SMS-уведомлений.
• Attributes — атрибуты канала SMS-уведомлений:
  • SenderID:
    • для каналов с индивидуальным отправителем — содержит текстовое имя отправителя, переданное при создании канала.
    • для канала с общим отправителем — содержит значение cns.shared.
  • IsDefault — указывает, является ли данный канал каналом по умолчанию при отправке SMS в этом облаке.
  • IsBanned — указывает, заблокирован ли канал сервисом.
  • ChannelState — состояние канала. Возможные значения:
    • Registering — регистрируется.
    • Sandbox — в песочнице.
    • Active — активен.
    • Disabled — отключен.
    • Deregistering — снимается с регистрации.
    • Deregistered — снят с регистрации.
  • Description — описание канала SMS-уведомлений.

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

При возникновении ошибки 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