ListCommands - 查询自定义指令列表/查询成员可用指令列表

查询自定义指令列表/查询成员可用指令列表。

服务接入点与授权信息

获取服务接入点，替换 API 请求语法中的 <domain> ：服务接入点（domain）。
获取个人访问令牌，具体操作，请参见获取个人访问令牌。

产品	资源	所需权限
通义灵码	自定义指令	只读

请求语法

GET https://{domain}/oapi/v1/lingma/organizations/{organizationId}/commands

请求头

参数	类型	是否必填	描述	示例值
x-yunxiao-token	string	是	个人访问令牌。	pt-0fh3**0fbG_35af**0484

请求参数

参数	类型	位置	是否必填	描述	示例值
organizationId	string	path	是	所属企业ID。
category	query	query	否	指令类型。	system/custom
needMetric	query	query	否	是否包含统计指标（7天内活跃用户）。	N/Y
status	query	query	否	指令状态。	enabled/disabled
userIds	query	query	否	用户id列表。
perPage	query	query	否	每页数据条数，默认20。
page	query	query	否	当前页，默认1。
keyWord	query	query	否	指令名称。

请求示例

curl -X 'GET' \
  'https://test.rdc.aliyuncs.com/oapi/v1/lingma/organizations/{organizationId}/commands?category={category}&needMetric={needMetric}&status={statusrIds={userIds}&perPage={perPage}&page={page}&keyWord={keyWord}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数	类型	描述	示例值
-	array[]
-	object
identifier	string	指令id。
gmtCreate	integer	创建时间。
gmtModified	integer	修改时间。
creatorId	string	创建人id。
creator	object	创建人。
id	string	创建人id。
name	string	创建人名称。
avatarUrl	string	创建人头像。
modifierId	string	修改人id。
modifier	object	修改人。
id	string	修改人id。
name	string	修改人名称。
avatarUrl	string	修改人头像。
displayName	string	指令名称。
name	string	指令英文名称。
description	string	指令描述。
imageUrl	string	指令图标。
category	string	指令类别。
type	string	指令类型。
status	string	指令状态。
visibility	string	可见性。
last7DayActiveUsers	integer	7天内活跃用户。

返回示例

[
    {
        "identifier": "",
        "gmtCreate": 0,
        "gmtModified": 0,
        "creatorId": "",
        "creator": {
            "id": "",
            "name": "",
            "avatarUrl": ""
        },
        "modifierId": "",
        "modifier": {
            "id": "",
            "name": "",
            "avatarUrl": ""
        },
        "displayName": "",
        "name": "",
        "description": "",
        "imageUrl": "",
        "category": "",
        "type": "",
        "status": "",
        "visibility": "",
        "last7DayActiveUsers": 0
    }
]

响应头

参数	描述	示例值
x-next-page	下一页。
x-page	当前页。
x-per-page	每页数据条数。
x-prev-page	上一页。
x-total	总数据量。
x-total-pages	总分页数。

错误码

访问错误码中心查看 API 相关错误码。

results matching ""

No results matching ""