Updated on 2025-11-07 GMT+08:00

Querying Feedback Options

Function

Query the feedback options that meet the query conditions.

URI

GET /v2/irobot/feedbacks/options

Table 1 Query parameters

Parameter

Mandatory

Type

Description

status

Yes

String

Specifies the publishing status of a feedback option.

Options:

  • UNPUBLISHED

  • PUBLISH

feedback_source

No

String

Specifies the source of a feedback option.

Options:

  • FAQ

  • FLOW

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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

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

feedback_options

Array of FeedbackOption objects

Specifies the option list.

Array length: 0 - 100000

Table 4 FeedbackOption

Parameter

Type

Description

feedback_option_id

String

Specifies the feedback option ID.

Minimum length: 0

Maximum length: 65535

feedback_option_name

String

Specifies the feedback option name.

Minimum length: 0

Maximum length: 65535

Request Example

GET https://{endpoint}/v2/irobot/feedbacks/options?feedback_source=FAQ&status=PUBLISH

null

Response Example

Status code: 200

Code 200 is returned if the operation is successful.

{
  "feedback_options" : [ {
    "feedback_option_id" : "option-id",
    "feedback_option_name" : "option-name"
  } ]
}

Status Codes

Status Code

Description

200

Code 200 is returned if the operation is successful.

Error Codes

See Error Codes.