ListPlatformApplications
Written by
Updated at October 28, 2024
Gets a list of mobile push notification channels. The action always outputs one page and does not support pagination.
HTTP request
POST https://notifications.yandexcloud.net/
Query parameters
| Parameter | Description |
|---|---|
Action |
string This is a required field. Parameter that indicates the type of operation. Value: ListPlatformApplications. |
FolderId |
string This is a required field. ID of the folder where the notification channels are located. Example: b1gsm0k26v1l********. |
ResponseFormat |
string Response format. Possible values:
|
Response
Successful response
If there are no errors, Cloud Notification Service returns the 200 HTTP code.
A successful response contains additional data in XML or JSON format depending on the specified ResponseFormat parameter.
Data schema:
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>
Where:
RequestId: Request IDPlatformApplicationArn: Notification channel ID (ARN)Attributes: Notification channel attributes. The following attributes are supported:ApplePlatformTeamID: Developer ID, only when using a token.ApplePlatformBundleID: App ID (bundle ID), only when using a token.AppleCertificateExpiryDate: Certificate expiry date, only when using a certificate.
{
"ResponseMetadata": {
"RequestId": "string"
},
"ListPlatformApplicationsResult": {
"PlatformApplications": [
{
"PlatformApplicationARN": "string",
"Attributes": {
"Attribute": "string"
}
}
]
}
}
Where:
RequestId: Request IDPlatformApplicationArn: Notification channel ID (ARN)Attributes: Notification channel attributes. The following attributes are supported:ApplePlatformTeamID: Developer ID, only when using a token.ApplePlatformBundleID: App ID (bundle ID), only when using a token.AppleCertificateExpiryDate: Certificate expiry date, only when using a certificate.Name: Name of the mobile push notification channel.Description: Description of the mobile push notification channel.Platform: Platform for sending mobile push notifications:APNS: Apple Push Notification service.APNS_SANDBOX: Apple Push Notification service for testing the app.FCM: Firebase Cloud Messaging.HMS: Huawei Mobile Services.
CreatedAt: Date and time when the mobile push notification channel was created.
Error response
In case of an error, Cloud Notification Service returns a message with the appropriate HTTP code.
For a list of common error codes for all actions, see Errors.