Call ListCustomAudience API to Retrieve Audience Data - Chat App Message Service

Queries a list of custom audiences.

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:ListCustomAudience

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CustSpaceId	string	Yes	The Space ID of the Independent Software Vendor (ISV) sub-customer or the instance ID of the direct customers. This is the channel ID. Find the ID on the Channel Management page.	cams-**
PageId	string	Yes	The Page ID for Messenger.	3939**
AdAccountId	string	No	The Meta ad account ID.	339**
TokenType	string	No	The token type.	custom
CustomAudienceName	string	No	The name of the custom audience.	name
Page	object	Yes	The pagination settings.
Size	integer	Yes	The number of entries to return on each page.	95
Index	integer	Yes	The page number.	40
CustomAudienceId	string	No	The ID of the custom audience.	239**

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.	39**
Total	integer	The total number of records.	69
Data	array<object>	The returned data.
	object	The returned data.
PageId	string	The Page ID for Messenger.	239**
Status	string	The status.	None
CustomAudienceId	string	The ID of the custom audience.	339**
CustomAudienceName	string	The name of the custom audience.	custom audience name
TokenType	string	The token type.	custom
Description	string	The description.	desc
CreateTime	integer	The time when the audience was created.	1720356898
AdAccountId	string	The Meta ad account ID.	339**
UpdateTime	integer	The time when the audience was last updated.	51
TokenTotal	integer	The number of tokens.	70
UploadType	string	The upload type.	excel
Code	string	The request status code. A value of OK indicates that the request was successful. For other error codes, see Error codes.	OK
Success	boolean	Indicates whether the API call was successful. true: successful. false: failed.	true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "Message": "OK",
  "RequestId": "39**",
  "Total": 69,
  "Data": [
    {
      "PageId": "239**",
      "Status": "None",
      "CustomAudienceId": "339**",
      "CustomAudienceName": "custom audience name",
      "TokenType": "custom",
      "Description": "desc",
      "CreateTime": 1720356898,
      "AdAccountId": "339**",
      "UpdateTime": 51,
      "TokenTotal": 70,
      "UploadType": "excel"
    }
  ],
  "Code": "OK",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.