查询案例
功能介绍
查询满足指定条件的案例列表
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v2/irobot/articles/search
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
search_type |
是 |
String |
搜索类型：HOT-热点案例,RECOMMEND-推荐案例 最小长度：1 最大长度：64 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：5000 |
x-service-key |
否 |
String |
调用智能客服服务标志。 最小长度：1 最大长度：32 |
x-site |
否 |
String |
站点标记，0-中国站 1-国际站 最小长度：0 最大长度：1 |
x-language |
否 |
String |
区域语言简写，en-us zh-cn 最小长度：0 最大长度：32 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
top |
否 |
Integer |
返回匹配度最高的数据条数 最小值：1 最大值：100 |
product_type_id |
是 |
String |
产品类型Id 最小长度：0 最大长度：64 |
business_type_id |
否 |
String |
业务类型Id 最小长度：0 最大长度：64 |
problem_type_id |
否 |
String |
问题类型Id 最小长度：0 最大长度：64 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
articles |
Array of Article objects |
热点/推荐案例列表 数组长度：0 - 2147483647 |
error_code |
String |
错误码 最小长度：0 最大长度：32 |
error_msg |
String |
错误描述 最小长度：0 最大长度：32 |
参数 |
参数类型 |
描述 |
|---|---|---|
id |
String |
案例Id 最小长度：0 最大长度：64 |
code |
String |
案例编码 最小长度：0 最大长度：64 |
name |
String |
案例名称 最小长度：0 最大长度：1024 |
url |
String |
案例链接 最小长度：0 最大长度：2048 |
create_time |
Long |
创建时间 最小值：0 最大值：9223372036854775807 |
update_time |
Long |
更新时间 最小值：0 最大值：9223372036854775807 |
product_type_id |
String |
产品类型Id 最小长度：0 最大长度：64 |
business_type_id |
String |
业务类型Id 最小长度：0 最大长度：64 |
problem_type_id |
String |
问题类型Id 最小长度：0 最大长度：64 |
请求示例
POST https://{endpoint}/v2/irobot/articles/search?search_type=HOT
{
"product_type_id" : "产品类型Id",
"business_type_id" : "业务类型Id",
"problem_type_id" : "问题类型Id",
"top" : 10
}
响应示例
状态码： 200
成功返回200
{
"articles" : [ {
"id" : "案例Id",
"code" : "案例编码",
"name" : "案例名称",
"url" : "案例链接",
"product_type_id" : "产品类型Id",
"business_type_id" : "业务类型Id",
"problem_type_id" : "问题类型Id"
} ]
}
状态码
状态码 |
描述 |
|---|---|
200 |
成功返回200 |
错误码
请参见错误码。
