Help Center/Service Tickets/API Reference/API v2 (Recommended)/Intelligent Customer Service/Querying Tools
Updated on 2025-11-07 GMT+08:00
View PDF

Querying Tools

Function

Query the list of tools that meet specified conditions.

URI

POST /v2/irobot/tools/search

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token.

It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Minimum length: 1

Maximum length: 5000

x-service-key

No

String

Specifies the flag for invoking the intelligent customer service.

Minimum length: 1

Maximum length: 32

x-site

No

String

Specifies the site flag. The options are 0 (Chinese mainland) and 1 (international).

Minimum length: 0

Maximum length: 1

x-language

No

String

Specifies the region language with a language abbreviation. The options are en-us and zh-cn.

Minimum length: 0

Maximum length: 32

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

top

No

Integer

Requests for the number of data records with the highest matching degree.

Minimum value: 1

Maximum value: 100

product_type_id

Yes

String

Specifies the product type ID.

Minimum length: 0

Maximum length: 64

business_type_id

No

String

Specifies the business type ID.

Minimum length: 0

Maximum length: 64

problem_type_id

No

String

Specifies the problem type ID.

Minimum length: 0

Maximum length: 64

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

tools

Array of Tool objects

Specifies the list of recommended tools.

Array length: 0 - 65535

error_code

String

Specifies the error code.

Minimum length: 0

Maximum length: 32

error_msg

String

Describes the error.

Minimum length: 0

Maximum length: 32

Table 4 Tool

Parameter

Type

Description

id

String

Specifies the tool ID.

Minimum length: 0

Maximum length: 64

name

String

Specifies the tool name.

Minimum length: 0

Maximum length: 256

url

String

Specifies the tool URL.

Minimum length: 0

Maximum length: 2048

icon

String

Specifies the icon content in Base64 format.

Minimum length: 0

Maximum length: 9223372036854775807

problem_type_id

String

Specifies the problem type ID.

Minimum length: 0

Maximum length: 64

business_type_id

String

Specifies the business type ID.

Minimum length: 0

Maximum length: 64

product_type_id

String

Specifies the product type ID.

Minimum length: 0

Maximum length: 64

Request Example

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

{
  "top" : 10,
  "product_type_id" : "Product type ID",
  "business_type_id" : "Business type ID",
  "problem_type_id" : "Problem type ID"
}

Response Example

Status code: 200

Code 200 is returned if the operation is successful.

{
  "tools" : [ {
    "id" : "Tool ID",
    "name" : "Tool name",
    "url" : "Tool URL",
    "icon" : "Base64",
    "problem_type_id" : "Problem type ID",
    "business_type_id" : "Business type ID",
    "product_type_id" : "Product type ID"
  } ]
}

Status Codes

Status Code

Description

200

Code 200 is returned if the operation is successful.

Error Codes

See Error Codes.