查询热词功能开关
功能介绍
该接口用于查询热词功能开关。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/digital-human-chat/hot-words-switch
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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。 |
参数 |
参数类型 |
描述 |
---|---|---|
enable_hot_words |
Boolean |
热词功能开关。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
GET https://metastudio.cn-north-4.myhuaweicloud.com/v1/70b76xxxxxx34253880af501cdxxxxxx/digital-human-chat/hot-words-switch?robot_id=b3e2b1db10b34f45bff241b133142627
响应示例
状态码: 200
处理成功返回。
{ "enable_hot_words" : false }
状态码: 400
{ "error_code" : "MSS.00000003", "error_msg" : "Invalid parameter" }
状态码
状态码 |
描述 |
---|---|
200 |
处理成功返回。 |
400 |
请求传参异常,包含错误码及对应描述。 |
错误码
请参见错误码。