ListEndpointsByPlatformApplication
Gets a list of endpoints for push notifications.
HTTP request
POST https://notifications.yandexcloud.net/
Query parameters
| Parameter | Description |
|---|---|
Action |
string Required field. Parameter to indicate the operation type. Value: ListEndpointsByPlatformApplication. |
PlatformApplicationArn |
string Required field. Mobile push notification channel ID. Example: arn:aws:sns::aoegtvhtp8ob********:app/GCM/test-cns-9990. |
NextToken |
string Token for viewing endpoint records after the first page. |
ResponseFormat |
string Response format. The possible values include:
|
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 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"
}
}
Where:
-
RequestId: Request ID. -
EndpointArn: Mobile endpoint ID (ARN). -
Attributes: Mobile endpoint attributes. The following attributes are supported:CustomUserData: Other user data that is stored with the endpoint. Cloud Notification Service does not use this data in any way.Enabled: Attribute for enabling and disabling endpoint notifications, currently not supported. It always returnstrue.
Note
The
Tokenattribute is not output for additional data protection. -
NextToken: Token for viewing endpoint records on the next page. It returns when additional records are available. If all records have been viewed,NextTokendoes not return.
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.