tencent cloud



Last updated: 2023-07-06 14:47:53

1. API Description

Domain name for API request: gme.tencentcloudapi.com.

This API is used to modify recording configurations.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: ModifyRecordInfo.
Version Yes String Common Params. The value used for this API: 2018-07-11.
Region No String Common Params. This parameter is not required.
TaskId Yes Integer ID of the ongoing task, which is returned from the StartRecord API.
RecordMode Yes Integer Recording mode. Valid values: 1: single stream; 2: mixed streams; 3: single stream and mixed streams.
BizId Yes Integer Application ID.
SubscribeRecordUserIds No SubscribeRecordUserIds Allowlist or blocklist for stream subscription.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying recording configurations

This example shows you how to modify recording configurations.

Input Example

Host: gme.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRecordInfo
<Common request parameters>

    "SubscribeRecordUserIds": {
        "SubscribeUserIds": [
        "UnSubscribeUserIds": [
    "RecordMode": 1,
    "TaskId": 446192236330927912,
    "BizId": 3400352518

Output Example

    "Response": {
        "RequestId": "h9167d24-a2c6-1125-a5bd-5c023ba721c2"

5. Developer Resources


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue.InvalidBizId Invalid BizId.
InvalidParameterValue.InvalidRecordMode Invalid RecordMode.
InvalidParameterValue.InvalidSubscribeRecordUserIds Incorrect blocklist/allowlist format.
InvalidParameterValue.InvalidSubscribeUserIds The number of entries on the allowlist exceeds 20.
InvalidParameterValue.InvalidTaskId Invalid taskid.
InvalidParameterValue.InvalidUNSubscribeUserIds The number of entries on the blocklist exceeds 20.
ResourceNotFound.TaskNotFound The task ID does not exist.
UnauthorizedOperation Unauthorized operation.
UnsupportedOperation Operation unsupported.
UnsupportedOperation.ServiceNotOpened The recording service is not activated.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support