List Messenger Subscription Tokens with RAM Auth - Chat App Message Service

Queries custom audiences and subscription tokens.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cams:ListMessengerSubscriptionToken

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CustSpaceId	string	Yes	The space ID of the ISV sub-customer or the instance ID. View the ID on the Channel Management page.	cams-**
PageId	string	Yes	The page ID for Messenger.	239***
TokenType	string	Yes	The token type. Valid values: customAudience : The custom audience.	customAudience
CustomAudienceId	string	No	The custom audience ID.	233**
PageKey	string	No	The pagination key.	2ie**
Limit	integer	No	The number of entries to return. Valid values: 1 to 1000.	67

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	Details about the access denial.	None
Message	string	The error message.	OK
RequestId	string	The request ID.	ei**
Data	array<object>	The returned data.
	object	The returned data.
PageId	string	The page ID for Messenger.	239***
TopicTitle	string	The message's title	Example
CustomAudienceId	string	The custom audience ID.	Example
RecipientId	string	The customer's Page-scoped ID (PSID)	Example
TokenExpiryTimestamp	integer	The expiration time of the security token.	172546854885
CreationTimestamp	integer	The time when the security token was created.	172546854885
NotificationMessagesToken	string	The page-scoped ID of the customer.	Example
NotificationMessagesReoptin	string	The re-subscription status.	Example
NextEligibleTime	integer	The time when the application can send the next marketing message to the recipient.	172546854885
NotificationMessagesTimezone	string	The customer's time zone.	Example
UserTokenStatus	string	The status of the security token.	Example
Code	string	The status code of the request. A return value of OK indicates that the request was successful. For a list of other error codes, see Error codes.	OK
NextPage	string	The identifier for the next page. Pass this value to query the next page.	3399***
Success	boolean	Indicates whether the operation was successful. Valid values: true: successful. false: failed.	true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "Message": "OK",
  "RequestId": "ei**",
  "Data": [
    {
      "PageId": "239***",
      "TopicTitle": "Example",
      "CustomAudienceId": "Example",
      "RecipientId": "Example",
      "TokenExpiryTimestamp": 172546854885,
      "CreationTimestamp": 172546854885,
      "NotificationMessagesToken": "Example",
      "NotificationMessagesReoptin": "Example",
      "NextEligibleTime": 172546854885,
      "NotificationMessagesTimezone": "Example",
      "UserTokenStatus": "Example"
    }
  ],
  "Code": "OK",
  "NextPage": "3399***",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.