Help Center/ MetaStudio/ API Reference/ Intelligent Interaction/ Intelligent Interaction Management/ Virtual Avatar Voice Recording Configuration Management/ Creating Voice Recording Configurations
Updated on 2025-12-08 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Creating Voice Recording Configurations

Function

Creates voice recording configurations.

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

POST /v1/{project_id}/digital-human-chat/audio-record-config

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.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

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.

X-Auth-Token

Yes

String

User token.

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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

obs_bucket_name

Yes

String

Definition:

Name of the OBS bucket for storing recorded voice files.

Constraints:

N/A

Value range:

The value contains 1 to 64 characters.

Default value:

N/A

obs_endpoint

Yes

String

Definition:

OBS endpoint for receiving recorded voice files.

Constraints:

The OBS endpoint must be valid.

Value range:

The value contains 1 to 64 characters.

Default value:

N/A

enable_audio_record

Yes

Boolean

Whether to enable voice recording.

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

project_id

String

Tenant ID.

obs_bucket_name

String

Definition:

Name of the OBS bucket for storing recorded voice files.

Constraints:

N/A

Value range:

The value contains 1 to 64 characters.

Default value:

N/A

obs_endpoint

String

Definition:

OBS endpoint for receiving recorded voice files.

Constraints:

The OBS endpoint must be valid.

Value range:

The value contains 1 to 64 characters.

Default value:

N/A

enable_audio_record

Boolean

Whether to enable voice recording.

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 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

POST https://metastudio.cn-north-4.myhuaweicloud.com/v1/70b76xxxxxx34253880af501cdxxxxxx/digital-human-chat/audio-record-config

{
  "obs_bucket_name" : "Intelligent_Interaction_audio_record",
  "obs_endpoint" : "obs.cn-north-4.myhuaweicloud.com",
  "enable_audio_record" : true
}

Example Responses

Status code: 200

Returned when the request succeeded.

{
  "project_id" : "70b76xxxxxx34253880af501cdxxxxxx",
  "obs_bucket_name" : "Intelligent_Interaction_audio_record",
  "obs_endpoint" : "obs.cn-north-4.myhuaweicloud.com",
  "enable_audio_record" : true,
  "create_time" : "2023-09-01T06:34:21Z",
  "update_time" : "2023-09-01T06:34:21Z"
}

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 Voice Recording Configuration Management