Help Center/ MetaStudio/ API Reference/ Intelligent Interaction/ Intelligent Interaction Management/ Virtual Avatar Keyword Record Management/ Querying Keywords
Updated on 2025-12-08 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Keywords

Function

Queries keywords.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

GET /v1/{project_id}/digital-human-chat/hot-words

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Offset where the query starts.

Value range:

0~2147483647

Default value:

0

limit

No

Integer

Number of items displayed on each page.

Value range:

1~100

Default value:

10

robot_id

Yes

String

Application ID.

region

No

Integer

Region where SIS is deployed.

Value range:

0~32

language

No

String

Language for intelligent interaction. Options:

  • zh_CN: Simplified Chinese (discontinued. Use CN.)

  • en_US: English (discontinued. Use EN.)

  • CN: Chinese

  • EN: English

  • ESP: Spanish (supported only outside China)

  • por: Portuguese (supported only outside China)

  • Arabic: Arabic (supported only outside China)

  • Thai: Thai (supported only outside China)

hot_words_type

No

String

  • SIS: SIS keyword

  • MOBVOI: AI Ask ASR keyword

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used.

You can obtain the token by calling the IAM API used to obtain a user token.

Value of X-Subject-Token in the response header.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when a request is sent. This parameter is mandatory for AK/SK authentication.

X-Project-Id

No

String

Project ID. This parameter is mandatory for AK/SK authentication.

X-App-UserId

No

String

Third-party user ID, which does not allow Chinese characters.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Request ID.
Table 5 Response body parameters

Parameter

Type

Description

offset

Integer

Offset from the first data record.

Value range:

0~2147483647

Default value:

0

limit

Integer

Page size.

Value range:

1~1000

Default value:

10

count

Integer

Total number.

Value range:

0~2147483647

data

Array of HotWordsInfo objects

Keyword record information.
Table 6 HotWordsInfo

Parameter

Type

Description

hot_words_id

String

Keyword record ID.

robot_id

String

Application ID.

hot_words_type

String

Keyword type.

NOTE:
SIS: Select this type when SIS is used.

MOBVOI: Select this type when Mobvoi is used.

vocabulary_id

String

Keyword ID, which is configured in SIS.

sis_project_id

String

Project ID of the region where SIS is deployed.

region

Integer

Region where SIS is interconnected.

NOTE:
0: CN North-Beijing4; 3: CN East-Shanghai1

Value range:

0~32

language

String

Language for intelligent interaction. Options:

  • zh_CN: Simplified Chinese (discontinued. Use CN.)

  • en_US: English (discontinued. Use EN.)

  • CN: Chinese

  • EN: English

  • ESP: Spanish (supported only outside China)

  • por: Portuguese (supported only outside China)

  • Arabic: Arabic (supported only outside China)

  • Thai: Thai (supported only outside China)

create_time

String

Creation time. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.

update_time

String

Update time. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

GET https://metastudio.cn-north-4.myhuaweicloud.com/v1/70b76xxxxxx34253880af501cdxxxxxx/digital-human-chat/hot-words?robot_id=b3e2b1db10b34f45bff241b133142627

Example Responses

Status code: 200

Returned when the request succeeded.

{
  "offset" : 0,
  "limit" : 10,
  "count" : 1,
  "data" : [ {
    "hot_words_id" : "39b9cedccec1f19b33d8f7ce1a6d35b9",
    "robot_id" : "b3e2b1db10b34f45bff241b133142627",
    "hot_words_type" : "SIS",
    "vocabulary_id" : "036bd500-27cd-4e2d-bba9-0e6baf9c1bd8",
    "sis_project_id" : "3c4a6bad10334e64823520d734d8f678",
    "region" : 0,
    "language" : "CN",
    "create_time" : "2021-01-10T08:43:17Z",
    "update_time" : "2021-01-10T08:43:17Z"
  } ]
}

Status code: 400

Parameters error, including the error code and its description.

{
  "error_code" : "MSS.00000003",
  "error_msg" : "Invalid parameter"
}

Status Codes

Status Code

Description

200

Returned when the request succeeded.

400

Parameters error, including the error code and its description.

Error Codes

See Error Codes.

Parent Topic: Virtual Avatar Keyword Record Management