查询激活码列表
功能介绍
该接口用于查询激活码列表。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/digital-human-chat/active-code
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方法请参考获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
偏移量，表示从此偏移量开始查询。 取值范围： 0-2147483647 默认取值： 0 |
|
limit |
否 |
Integer |
每页显示的条目数量。 取值范围： 1-100 默认取值： 10 |
|
robot_id |
是 |
String |
应用ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取。 响应消息头中X-Subject-Token的值。 |
|
Authorization |
否 |
String |
使用AK/SK方式认证时必选，携带的鉴权信息。 |
|
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选，请求的发生时间。 |
|
X-Project-Id |
否 |
String |
使用AK/SK方式认证时必选，携带项目ID信息。 |
|
X-App-UserId |
否 |
String |
第三方用户ID。不允许输入中文。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-Request-Id |
String |
请求ID。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
offset |
Integer |
与第一条数据的偏移量 取值范围： 0-2147483647 默认取值： 0 |
|
limit |
Integer |
页面大小 取值范围： 1-1000 默认取值： 10 |
|
count |
Integer |
总数量 取值范围： 0-2147483647 |
|
data |
Array of ActiveCodeInfo objects |
激活码信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
active_code_id |
String |
激活码ID。 |
|
active_code |
String |
激活码。 |
|
robot_id |
String |
应用ID。 |
|
room_id |
String |
智能交互对话ID。 |
|
valid_period |
Integer |
有效天数（0表示长期有效）。 取值范围： 0-65535 |
|
expire_time |
String |
过期时间，格式遵循：RFC 3339 如"2021-01-10T08:43:17Z"。 |
|
create_time |
String |
创建时间，格式遵循：RFC 3339 如"2021-01-10T08:43:17Z"。 |
|
update_time |
String |
更新时间，格式遵循：RFC 3339 如"2021-01-10T08:43:17Z"。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
请求示例
GET https://metastudio.cn-north-4.myhuaweicloud.com/v1/70b76xxxxxx34253880af501cdxxxxxx/digital-human-chat/active-code?robot_id=4d54xxxxxxc446249xxxxxxxxxx6526
响应示例
状态码： 200
处理成功返回。
{
"offset" : 0,
"limit" : 10,
"count" : 1,
"data" : [ {
"active_code_id" : "39b9cedccec1f19b33d8f7ce1a6d35b9",
"active_code" : "H7GW3T2E7",
"robot_id" : "4d54xxxxxxc446249xxxxxxxxxx6526",
"room_id" : "41c86xxxxxx34253850af102cdxxxxxx",
"valid_period" : 3,
"expire_time" : "2023-09-04T06:34:21Z",
"create_time" : "2023-09-01T06:34:21Z",
"update_time" : "2023-09-01T06:34:21Z"
} ]
}
状态码： 400
{
"error_code" : "MSS.00000003",
"error_msg" : "Invalid parameter"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
处理成功返回。 |
|
400 |
请求传参异常，包含错误码及对应描述。 |
错误码
请参见错误码。
