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

Querying Agencies

Function

Queries agencies in a project.

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/agency

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of the region where the entrusted service is. For example, if CBS of CN North-Beijing4 needs to be entrusted, enter the project ID of CN North-Beijing4. For details about how to obtain the project ID, see [Obtaining the Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

role_type

No

String

Agency authorization type.

  • CBS: CBS visitor

  • SIS: SIS invocation

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. You need to obtain the global token (set scope to domain).

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

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

agency_id

String

Agency ID.

Example Requests

GET https://metastudio.cn-north-4.myhuaweicloud.com/v1/70b76xxxxxx34253880af501cdxxxxxx/digital-human-chat/agency?role_type=SIS

{
  "agency_id" : "39b9cedccec1f19b33d8f7ce1a6d35b9"
}

Example Responses

Status code: 200

Returned when the request succeeded.

{
  "agency_id" : "39b9cedccec1f19b33d8f7ce1a6d35b9"
}

Status Codes

Status Code

Description

200

Returned when the request succeeded.

Error Codes

See Error Codes.

Parent Topic: Virtual Avatar Agency Management