- 产品简介
- 购买指南
- 服务端 API
- History
- Introduction
- API Category
- Making API Requests
- Whiteboard Snapshot APIs
- Whiteboard Push APIs
- Document Transcoding APIs
- Real-Time Recording APIs
- Statistics Query APIs
- Recording Video Generation APIs
- Other APIs
- ApplyTiwTrial
- CreateApplication
- DescribeAPIService
- DescribeApplicationInfos
- DescribeApplicationUsage
- DescribeBoardSDKLog
- DescribeIMApplications
- DescribePostpaidUsage
- DescribeRoomList
- DescribeUsageSummary
- DescribeUserList
- DescribeUserResources
- DescribeUserStatus
- DescribeWhiteboardApplicationConfig
- DescribeWhiteboardBucketConfig
- ModifyApplication
- ModifyAutoRenewFlag
- ModifyWhiteboardApplicationConfig
- ModifyWhiteboardBucketConfig
- Data Types
- Error Codes
- 联系我们
- 服务协议
- 产品简介
- 购买指南
- 服务端 API
- History
- Introduction
- API Category
- Making API Requests
- Whiteboard Snapshot APIs
- Whiteboard Push APIs
- Document Transcoding APIs
- Real-Time Recording APIs
- Statistics Query APIs
- Recording Video Generation APIs
- Other APIs
- ApplyTiwTrial
- CreateApplication
- DescribeAPIService
- DescribeApplicationInfos
- DescribeApplicationUsage
- DescribeBoardSDKLog
- DescribeIMApplications
- DescribePostpaidUsage
- DescribeRoomList
- DescribeUsageSummary
- DescribeUserList
- DescribeUserResources
- DescribeUserStatus
- DescribeWhiteboardApplicationConfig
- DescribeWhiteboardBucketConfig
- ModifyApplication
- ModifyAutoRenewFlag
- ModifyWhiteboardApplicationConfig
- ModifyWhiteboardBucketConfig
- Data Types
- Error Codes
- 联系我们
- 服务协议
1. API Description
Domain name for API request: tiw.tencentcloudapi.com.
This API is used to pause real-time recording.
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: PauseOnlineRecord. |
| Version | Yes | String | Common Params. The value used for this API: 2019-09-19. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-singapore. |
| SdkAppId | Yes | Integer | SdkAppId of the customer |
| TaskId | Yes | String | ID of the real-time recording task |
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 Pausing a real-time recording task
Input Example
https://tiw.tencentcloudapi.com/?Action=PauseOnlineRecord
&SdkAppId=1400000001
&TaskId=bj0mt2l23osdj300hl30
&<Common request parameters>
Output Example
{
"Response": {
"RequestId": "eac6b301-a322-493a-8e36-83b295459397"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 |
|---|---|
| AuthFailure | |
| InvalidParameter.BodyParameterTypeUnmatched | The parameter type does not match. |
| InvalidParameter.TaskNotFound | The task to query does not exist. |
| ResourceUnavailable.NotRegistered | TIW is not enabled. |
| ResourceUnavailable.ServiceExpired | The account is in arrears or the TIW service has expired. |
| UnauthorizedOperation.SdkAppId | The SdkAppId does not exist or does not match the current Tencent Cloud account. |
| UnsupportedOperation.InvalidTaskStatus | The specified operation cannot be performed for pending tasks in this state. For example, you cannot resume recording for a recording task. |
| UnsupportedOperation.TaskHasAlreadyStopped | The task is completed, and therefore the specified operation cannot be performed. |
是
否
本页内容是否解决了您的问题？