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

Querying Q&A Pair Details

Function

Query details about a specified Q&A pair.

URI

GET /v2/irobot/qapairs/{qa_pair_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

qa_pair_id

Yes

String

Specifies the Q&A pair ID.

Minimum length: 0

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

Yes

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

qapair

QaPair object

Specifies the details of the Q&A pair.

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 QaPair

Parameter

Type

Description

domain

String

Specifies the domain.

Minimum length: 0

Maximum length: 200

link

String

Specifies the link.

Minimum length: 0

Maximum length: 65535

question

String

Specifies the question.

Minimum length: 0

Maximum length: 65535

answers

Array of Answer objects

Specifies the answer list.

Array length: 0 - 65535

qa_pair_id

String

Specifies the Q&A pair ID.

Minimum length: 0

Maximum length: 64

ex_questions

Array of ExtendQuestion objects

Specifies the list of extended questions.

Array length: 0 - 65535

related_question_ids

Array of strings

Specifies the list of related questions.

Minimum length: 0

Maximum length: 65535

Array length: 0 - 65535
Table 5 Answer

Parameter

Type

Description

content

String

Specifies the answer content.

Minimum length: 0

Maximum length: 65535

id

String

Specifies the answer ID.

Minimum length: 0

Maximum length: 64

tags

Array of strings

Specifies the label list.

Minimum length: 0

Maximum length: 65535

Array length: 0 - 65535

answer_type

String

Specifies the answer type.

Minimum length: 0

Maximum length: 10

Options:

  • TEXT

  • RICH_TEXT

  • FLOW

  • QA_PAIR

qa_flow_entry

CbsFlowEntry object

Specifies the process information related to the answer.
Table 6 CbsFlowEntry

Parameter

Type

Description

qa_flow_id

String

Specifies the Q&A process ID.

Minimum length: 0

Maximum length: 64

start_node_id

String

Specifies the start node ID.

Minimum length: 0

Maximum length: 64
Table 7 ExtendQuestion

Parameter

Type

Description

content

String

Specifies the content of the extended question.

Minimum length: 0

Maximum length: 65535

score

Double

Specifies the score.

Minimum value: 0

Maximum value: 1

Request Example

GET https://{endpoint}/v2/irobot/qapairs/pair-id

null

Response Example

Status code: 200

Code 200 is returned if the operation is successful.

{
  "qapair" : {
    "domain" : "ECS",
    "link" : "link",
    "question" : "test",
    "qa_pair_id" : "pair-id"
  }
}

Status Codes

Status Code

Description

200

Code 200 is returned if the operation is successful.

Error Codes

See Error Codes.