Действие ListEndpointsByPlatformApplication

Получает список эндпоинтов для мобильных Push-уведомлений или Push-уведомлений в браузере.

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

POST https://notifications.yandexcloud.net/

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

ОтветОтвет

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

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

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

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

<?xml version="1.0" encoding="UTF-8"?>
<ListEndpointsByPlatformApplicationResponseXML>
    <ResponseMetadata>
  	  <RequestId>string</RequestId>
    </ResponseMetadata>
    <ListEndpointsByPlatformApplicationResult>
  	  <Endpoints>
  		  <member>
  			  <EndpointArn>string</EndpointArn>
  			  <Attributes>
  				  <entry>
  					  <key>string</key>
  					  <value>string</value>
  				  </entry>
  			  </Attributes>
  		  </member>
  	  </Endpoints>
  	  <NextToken>string</NextToken>
    </ListEndpointsByPlatformApplicationResult>
</ListEndpointsByPlatformApplicationResponseXML>

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "ListEndpointsByPlatformApplicationResult": {
    "Endpoints": [
      {
        "EndpointARN": "string",
        "Attributes": {
          "Attribute": "string"
        }
      }
    ],
    "NextToken": "string"
  }
}

Где:

• RequestId — идентификатор запроса.

• EndpointArn — идентификатор (ARN) мобильного эндпоинта.

• Attributes — атрибуты мобильного эндпоинта. Поддерживается вывод следующих атрибутов:

  • CustomUserData — прочие пользовательские данные, которые хранятся вместе с эндпоинтом. Cloud Notification Service никак не использует эти данные.
  • Enabled — атрибут для включение и выключение уведомлений в эндпоинт, в настоящее время не поддерживается. Всегда возвращается значение true.

  Примечание

  Вывод атрибута Token не осуществляется для дополнительной защиты данных.

• NextToken — токен для просмотра записей об эндпоинтах на следующей странице. Возвращается, когда доступны дополнительные записи. Если все записи были просмотрены, NextToken не возвращается.

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

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

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

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

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