更新时间:2023-12-18 GMT+08:00
分享

查询工具

功能介绍

查询满足指定条件的工具列表

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v2/irobot/tools/search

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

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

表2 请求Body参数

参数

是否必选

参数类型

描述

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

表3 响应Body参数

参数

参数类型

描述

tools

Array of Tool objects

推荐工具列表

数组长度:0 - 65535

error_code

String

错误码

最小长度:0

最大长度:32

error_msg

String

错误描述

最小长度:0

最大长度:32

表4 Tool

参数

参数类型

描述

id

String

工具Id

最小长度:0

最大长度:64

name

String

工具名称

最小长度:0

最大长度:256

url

String

工具链接

最小长度:0

最大长度:2048

icon

String

图标内容,Base64格式

最小长度:0

最大长度:9223372036854775807

problem_type_id

String

问题分类Id

最小长度:0

最大长度:64

business_type_id

String

业务类型Id

最小长度:0

最大长度:64

product_type_id

String

产品类型Id

最小长度:0

最大长度:64

请求示例

POST https://{endpoint}/v2/irobot/tools/search

{
  "top" : 10,
  "product_type_id" : "产品类型Id",
  "business_type_id" : "业务类型Id",
  "problem_type_id" : "问题类型Id"
}

响应示例

状态码: 200

成功返回200

{
  "tools" : [ {
    "id" : "工具Id",
    "name" : "工具名称",
    "url" : "工具链接",
    "icon" : "Base64",
    "problem_type_id" : "问题分类Id",
    "business_type_id" : "业务类型Id",
    "product_type_id" : "产品类型Id"
  } ]
}

状态码

状态码

描述

200

成功返回200

错误码

请参见错误码

相关文档