ListProduct - 商品列表 - Chat App 消息服务

查询目录下的商品列表。

接口说明

本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

cams:ListProduct

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
CatalogId	string	是	目录 ID，可在 Meta 平台获取目录 ID。	2939838xxxx
Fields	string	否	字段列表，多个字段用半角逗号（,）隔开。具体字段请参考商品字段	id,name
Before	string	否	查询前一页消息的结束位置。	wiidkd939kek93
After	string	否	查询下一页消息的起始位置。	kdkii48jfjjei3
Limit	integer	否	查询数量。取值范围[1,1000]。	73
CustSpaceId	string	否	ISV 子客户的 SpaceId。	C2939838xxxx
WabaId	string	是	WABA 账号 ID。	3848747xxxx

返回参数

名称	类型	描述	示例值
	object
AccessDeniedDetail	string	访问被拒绝详细信息。	None
Message	string	提示信息，当返回异常时有值。	None
RequestId	string	请求 ID。	90E63D28-E31D-1EB2-8939-A94866411B2O
Model	object	请求结果数据。
Paging	object	分页详情。
Cursors	object	分页位置。
Before	string	前一条记录位置。	sjjsjdjjdjd83883
After	string	后一条记录位置。	sjsuueu83838
Data	array<object>	返回数据对像。
	object	商品数据。	{"id":"293983883", "name":"product1"}
Code	string	请求状态码。返回 OK 代表请求成功。其他错误码，请参见错误码列表。	OK
Success	boolean	是否调用成功： true：调用成功。 false：调用失败。	true

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Model": {
    "Paging": {
      "Cursors": {
        "Before": "sjjsjdjjdjd83883",
        "After": "sjsuueu83838"
      }
    },
    "Data": [
      {
        "id": "293983883",
        "name": "product1"
      }
    ]
  },
  "Code": "OK",
  "Success": true
}

错误码

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

变更历史

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