Tencent Interactive Whiteboard
- Product Introduction
- Purchase Guide
- Server APIs
- 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
- Service Agreement
API Category
Last updated: 2024-11-26 18:56:07
Whiteboard Snapshot APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateSnapshotTask | Creates a whiteboard snapshot task | 20 |
| DescribeSnapshotTask | Queries the information about a whiteboard snapshot task | 20 |
Whiteboard Push APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DescribeWhiteboardPush | Queries a whiteboard push task | 20 |
| DescribeWhiteboardPushCallback | Queries the whiteboard push callback URL | 20 |
| DescribeWhiteboardPushSearch | Queries whiteboard push tasks by room ID | 20 |
| SetWhiteboardPushCallback | Sets the whiteboard push callback URL | 20 |
| SetWhiteboardPushCallbackKey | Sets the callback authentication key for whiteboard push | 20 |
| StopWhiteboardPush | Stops a whiteboard push task | 20 |
| StartWhiteboardPush | Starts a whiteboard push task | 20 |
Recording Video Generation APIs (in Beta Testing)
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateVideoGenerationTask | Creates a recording video generation task | 20 |
| DescribeVideoGenerationTask | Queries the status and result of a recording video generation task | 20 |
| DescribeVideoGenerationTaskCallback | Queries the callback URL for recording video generation | 20 |
| SetVideoGenerationTaskCallback | Sets the callback URL for recording video generation | 20 |
| SetVideoGenerationTaskCallbackKey | Sets the callback authentication key for recording video generation | 20 |
Other APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| ApplyTiwTrial | Applies for a Tencent Interactive Whiteboard trial | 20 |
| CreateApplication | Creates a whiteboard application | 20 |
| DescribeAPIService | Queries the information about other cloud products | 20 |
| DescribeApplicationInfos | Queries the details of a whiteboard application | 20 |
| DescribeApplicationUsage | Queries the subproduct usage of Tencent Interactive Whiteboard | 20 |
| DescribeBoardSDKLog | Queries the logs of a whiteboard application | 20 |
| DescribeIMApplications | Queries available IM applications | 20 |
| DescribePostpaidUsage | Queries the pay-as-you-go usage of a user | 20 |
| DescribeRoomList | Queries the rooms of a whiteboard application | 20 |
| DescribeUsageSummary | Queries the summary of subproduct usage | 20 |
| DescribeUserList | Queries the users of a whiteboard application | 20 |
| DescribeUserResources | Queries user resources | 20 |
| DescribeUserStatus | Queries the Tencent Interactive Whiteboard service status of a user | 20 |
| DescribeWhiteboardApplicationConfig | Queries the task-related configurations of a whiteboard application | 20 |
| DescribeWhiteboardBucketConfig | Queries the bucket configurations of a whiteboard application | 20 |
| ModifyApplication | Modifies a whiteboard application | 20 |
| ModifyAutoRenewFlag | Sets auto-renewal | 20 |
| ModifyWhiteboardApplicationConfig | Modifies the task-related configurations of a whiteboard application | 20 |
| ModifyWhiteboardBucketConfig | Modifies the bucket configurations of a whiteboard application | 20 |
Document Transcoding APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateTranscode | Creates a document transcoding task | 20 |
| DescribeTranscode | Queries document transcoding tasks | 20 |
| DescribeTranscodeCallback | Queries the document transcoding callback URL | 20 |
| DescribeTranscodeSearch | Queries transcoding tasks by document name | 20 |
| SetTranscodeCallback | Sets the document transcoding callback URL | 20 |
| SetTranscodeCallbackKey | Sets the key for the document transcoding callback. | 20 |
Real-Time Recording APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DescribeOnlineRecord | Querying a real-time recording task | 20 |
| DescribeOnlineRecordCallback | Queries the real-time recording callback URL | 20 |
| DescribeRecordSearch | Queries real-time recording tasks by room ID | 20 |
| PauseOnlineRecord | Pauses real-time recording | 20 |
| ResumeOnlineRecord | Resumes real-time recording | 20 |
| SetOnlineRecordCallback | Sets the real-time recording callback URL | 20 |
| SetOnlineRecordCallbackKey | Sets the key for the real-time recording callback | 20 |
| StartOnlineRecord | Starts real-time recording | 20 |
| StopOnlineRecord | Stops real-time recording | 20 |
Statistics Query APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DescribeQualityMetrics | Queries the quality data of a whiteboard application | 20 |
| DescribeTIWDailyUsage | Queries the daily billable usage of a whiteboard application | 20 |
| DescribeTIWRoomDailyUsage | Queries the daily billable usage by room | 20 |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No