Действие ListPlatformApplications
Статья создана
Обновлена 24 сентября 2024 г.
Получает список каналов мобильных Push-уведомлений. Действие всегда выдает одну страницу и не поддерживает пагинацию.
HTTP-запрос
POST https://notifications.yandexcloud.net/
Query-параметры
| Параметр | Описание |
|---|---|
Action |
string Обязательное поле. Параметр для обозначения типа операции. Значение: ListPlatformApplications. |
FolderId |
string Обязательное поле. Идентификатор каталога, в котором размещены каналы уведомлений. Пример: b1gsm0k26v1l********. |
ResponseFormat |
string Формат ответа. Возможные значения:
|
Ответ
Успешный ответ
При отсутствии ошибок Cloud Notification Service отвечает HTTP-кодом 200.
Успешный ответ содержит дополнительные данные в формате XML или JSON в зависимости от указанного параметра ResponseFormat.
Схема данных:
XML
JSON
<?xml version="1.0" encoding="UTF-8"?>
<ListPlatformApplicationsResponseXML>
<ResponseMetadata>
<RequestId>string</RequestId>
</ResponseMetadata>
<ListPlatformApplicationsResult>
<PlatformApplications>
<member>
<PlatformApplicationARN>string</PlatformApplicationARN>
<Attributes>
<entry>
<key>string</key>
<value>string</value>
</entry>
</Attributes>
</member>
</PlatformApplications>
</ListPlatformApplicationsResult>
</ListPlatformApplicationsResponseXML>
Где:
RequestId— идентификатор запроса.PlatformApplicationArn— идентификатор (ARN) канала уведомлений.Attributes— атрибуты канала уведомлений. Поддерживается вывод следующих атрибутов:ApplePlatformTeamID— идентификатор разработчика, только при использовании токена.ApplePlatformBundleID— идентификатор приложения (Bundle ID), только при использовании токена.AppleCertificateExpiryDate— дата истечения срока действия сертификата, только при использовании сертификата.
{
"ResponseMetadata": {
"RequestId": "string"
},
"ListPlatformApplicationsResult": {
"PlatformApplications": [
{
"PlatformApplicationARN": "string",
"Attributes": {
"Attribute": "string"
}
}
]
}
}
Где:
RequestId— идентификатор запроса.PlatformApplicationArn— идентификатор (ARN) канала уведомлений.Attributes— атрибуты канала уведомлений. Поддерживается вывод следующих атрибутов:ApplePlatformTeamID— идентификатор разработчика, только при использовании токена.ApplePlatformBundleID— идентификатор приложения (Bundle ID), только при использовании токена.AppleCertificateExpiryDate— дата истечения срока действия сертификата, только при использовании сертификата.Name— имя канала мобильных Push-уведомлений.Description— описание канала мобильных Push-уведомлений.Platform— платформа для отправки мобильных Push-уведомлений:APNS— Apple Push Notification service.APNS_SANDBOX— Apple Push Notification service для тестирования приложения.FCM— Firebase Cloud Messaging.HMS— Huawei Mobile Services.
CreatedAt— дата и время создания канала мобильных Push-уведомлений.
Ответ с ошибкой
При возникновении ошибки Cloud Notification Service отвечает сообщением с соответствующим HTTP-кодом.
Перечень общих кодов ошибок для всех действий см. в разделе Ошибки.