GetCommand - 查询单个自定义指令
查询单个自定义指令。
服务接入点与授权信息
请求语法
GET https://{domain}/oapi/v1/lingma/organizations/{organizationId}/commands/{commandId}
请求头
| 参数 |
类型 |
是否必填 |
描述 |
示例值 |
| x-yunxiao-token |
string |
是 |
个人访问令牌。 |
pt-0fh3****0fbG_35af****0484 |
请求参数
| 参数 |
类型 |
位置 |
是否必填 |
描述 |
示例值 |
| organizationId |
string |
path |
是 |
所属企业ID。 |
|
| commandId |
string |
path |
是 |
自定义指令id。 |
|
| needMetric |
string |
query |
否 |
是否包含统计指标（7天内活跃用户数）。 |
N/Y |
请求示例
curl -X GET \
'https://test.rdc.aliyuncs.com/oapi/v1/lingma/organizations/{organizationId}/commands/{commandId}?needMetric={needMetric}' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'
返回参数
| 参数 |
类型 |
描述 |
示例值 |
| - |
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 |
指令类别。 |
system/custom |
| type |
string |
指令类型。 |
prompt |
| status |
string |
指令状态。 |
enabled/disabled |
| visibility |
string |
可见性。 |
public/private |
| contexts |
array[] |
指令上下文。 |
|
| - |
object |
|
|
| identifier |
string |
上下文id。 |
|
| optional |
string |
是否必选。 |
N/Y |
| config |
string |
指令配置(prompt对应JSON字符串)。 |
|
| version |
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": "",
"contexts": [
{
"identifier": "",
"optional": ""
}
],
"config": "",
"version": "",
"last7DayActiveUsers": 0
}
错误码
访问错误码中心查看 API 相关错误码。