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

Querying Cases

Function

Query the list of cases that meet the specified conditions.

URI

POST /v2/irobot/articles/search

Table 1 Query parameters

Parameter

Mandatory

Type

Description

search_type

Yes

String

Specifies the search type. The options are HOT (hot cases) and RECOMMEND (recommended cases).

Minimum length: 1

Maximum length: 64

Request Parameters

Table 2 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 3 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 4 Response body parameters

Parameter

Type

Description

articles

Array of Article objects

Specifies the list of hot/recommended cases.

Array length: 0 - 2147483647

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 5 Article

Parameter

Type

Description

id

String

Specifies the case ID.

Minimum length: 0

Maximum length: 64

code

String

Specifies the case code.

Minimum length: 0

Maximum length: 64

name

String

Specifies the case name.

Minimum length: 0

Maximum length: 1024

url

String

Specifies the case URL.

Minimum length: 0

Maximum length: 2048

create_time

Long

Specifies the creation time.

Minimum value: 0

Maximum value: 9223372036854775807

update_time

Long

Specifies the update time.

Minimum value: 0

Maximum value: 9223372036854775807

product_type_id

String

Specifies the product type ID.

Minimum length: 0

Maximum length: 64

business_type_id

String

Specifies the business type ID.

Minimum length: 0

Maximum length: 64

problem_type_id

String

Specifies the problem type ID.

Minimum length: 0

Maximum length: 64

Request Example

POST https://{endpoint}/v2/irobot/articles/search?search_type=HOT

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

Response Example

Status code: 200

Code 200 is returned if the operation is successful.

{
  "articles" : [ {
    "id" : "Case ID",
    "code" : "Case code",
    "name" : "Case name",
    "url" : "Case URL",
    "product_type_id" : "Product type ID",
    "business_type_id" : "Business type ID",
    "problem_type_id" : "Problem type ID"
  } ]
}

Status Codes

Status Code

Description

200

Code 200 is returned if the operation is successful.

Error Codes

See Error Codes.