GetPlatformApplicationAttributes
Written by
Updated at October 28, 2024
Gets parameters of the mobile push notification channel.
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: GetPlatformApplicationAttributes . |
PlatformApplicationArn |
string This is a required field. ID of a mobile push notification channel. Example: arn:aws:sns::aoegtvhtp8ob********:app/GCM/test-cns-9990 . |
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"?>
<GetPlatformApplicationAttributesResponseXML>
<ResponseMetadata>
<RequestId>string</RequestId>
</ResponseMetadata>
<GetPlatformApplicationAttributesResult>
<Attributes>
<entry>
<key>string</key>
<value>string</value>
</entry>
</Attributes>
</GetPlatformApplicationAttributesResult>
</GetPlatformApplicationAttributesResponseXML>
Where:
RequestId
: Request IDAttributes
: 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"
},
"GetPlatformApplicationAttributesResult": {
"Attributes": {
"Attribute": "string"
}
}
}
Where:
RequestId
: Request IDAttributes
: 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 app testing.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.