使用ListCustomAudience查询自定义受众列表-Chat App 消息服务-阿里云

自定义受众列表查询。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cams:ListCustomAudience

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
CustSpaceId	string	是	ISV 子客户的 SpaceId/实例 ID。即通道 ID，在通道管理界面查看。	cams-**
PageId	string	是	Messenger 的 PageId	3939**
AdAccountId	string	否	Meta 广告账户 ID	339**
TokenType	string	否	Token 类型。	custom
CustomAudienceName	string	否	自定义受众名称	name
Page	object	是	分页信息。
Size	integer	是	每页显示数量。	95
Index	integer	是	页数。	40
CustomAudienceId	string	否	自定义受众 ID	239**

返回参数

名称	类型	描述	示例值
	object
AccessDeniedDetail	string	访问被拒绝详细信息。	None
Message	string	错误描述信息。	OK
RequestId	string	请求 ID。	39**
Total	integer	总记录条数。	69
Data	array<object>	返回数据。
	object	返回数据。
PageId	string	Messenger 的 PageId	239**
Status	string	状态	None
CustomAudienceId	string	自定义受众 ID	339**
CustomAudienceName	string	自定义受众名称	custom audience name
TokenType	string	Token 类型。	custom
Description	string	描述。	desc
CreateTime	integer	创建时间	1720356898
AdAccountId	string	Meta 广告账户 ID	339**
UpdateTime	integer	更新时间	51
TokenTotal	integer	token 数量	70
UploadType	string	用户上传类型	excel
Code	string	请求状态码。返回 OK 代表请求成功。其他错误码，请参见错误码列表。	OK
Success	boolean	是否调用成功。 true：调用成功。 false：调用失败。	true

示例

正常返回示例

JSON格式

{
  "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
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。