ListEndpointsByPlatformApplication

Gets a list of endpoints for mobile push notifications or in-browser push notifications.

HTTP requestHTTP request

POST https://notifications.yandexcloud.net/

Query parametersQuery parameters

ResponseResponse

Successful responseSuccessful 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 stored together 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 returns true.

  Note

  For data protection purposes, you can not output the Token attribute.

• NextToken: Token for viewing endpoint records on the next page. It returns when additional records are available. If all records have been viewed, NextToken is not returned.

Error responseError 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.

See alsoSee also

• Yandex Cloud Notification Service HTTP API overview
• Sending an HTTP API request to Yandex Cloud Notification Service
• ListEndpointsByPlatformApplication API action in the AWS documentation.