Tencent Interactive Whiteboard
Last updated: 2025-12-04 09:14:48
Fundamental information
| Product | Abbreviation in CAM | Console | Authorization by Tag | Authorization Granularity | IP Restriction |
|---|---|---|---|---|---|
| Tencent Interactive Whiteboard | tiw | Supported | Supported | Resource level | Partially supported |
Note：
The authorization granularity of cloud products is divided into three levels: service level, operation level, and resource level, based on the degree of granularity.
- Service level: It defines whether a user has the permission to access the service as a whole. A user can have either full access or no access to the service. For the authorization granularity of cloud products at service level, the authorization of specific APIs are not supported.
- Operation level: It defines whether a user has the permission to call a specific API of the service. For example, granting an account read-only access to the CVM service is an authorization at the operation level.
- Resource level: It is the finest authorization granularity which defines whether a user has the permission to access specific resources. For example, granting an account read/write access to a specific CVM instance is an authorization at the resource level.
API authorization granularity
Two authorization granularity levels of API are supported: resource level, and operation level.
- Resource level: It supports the authorization of a specific resource.
- Operation level: It does not support the authorization of a specific resource. If the policy syntax restricts a specific resource during authorization, CAM will determine that this API is not within the scope of authorization, and deem it as unauthorized.
Write operations
| API | API Description | Authorization Granularity | Six-segment Resource Description | IP Restriction |
|---|---|---|---|---|
| ApplyTiwTrial | apply trial of tiw | Operation level | * | Supported |
| CreateApplication | create tiw application | Operation level | * | Supported |
| CreatePPTCheckTask | Create a PPT detection task | Resource level | qcs::tiw::uin/${uin}:volume/${volumeId} | Supported |
| CreateSnapshot | create snapshot task | Resource level | qcs::tiw::uin/${uin}:sdkappid/${SdkAppId} | Supported |
| CreateTranscode | create document transcode task | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| CreateVideoGenerationTask | create video generation task | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| ModifyApplication | modify tiw application | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| ModifyAutoRenewFlag | modify auto renew flag | Operation level | * | Supported |
| ModifyWhiteboardApplicationConfig | modify whiteboard application configuration | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| ModifyWhiteboardBucketConfig | modify whiteboard resource bucket configuration | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| PauseOnlineRecord | pause online record | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| ResumeOnlineRecord | resume online record | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| SetOnlineRecordCallback | set callback address of online record | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| SetOnlineRecordCallbackKey | set callback key for online record task | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| SetSnapshotCallback | set callback address for snapshot task | Resource level | qcs::tiw::uin/${uin}:sdkappid/${SdkAppId} | Supported |
| SetSnapshotCallbackKey | set callback key for snapshot task | Resource level | qcs::tiw::uin/${uin}:sdkappid/${SdkAppId} | Supported |
| SetTranscodeCallback | set callback address of document transcode | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| SetTranscodeCallbackKey | set callback key for transcode task | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| SetVideoGenerationTaskCallback | set callback address for video generation task | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| SetVideoGenerationTaskCallbackKey | set callback key for video generation task | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| SetWhiteboardPushCallback | SetWhiteboardPushCallback | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| SetWhiteboardPushCallbackKey | SetWhiteboardPushCallbackKey | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| StartOnlineRecord | start online record task | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| StartWhiteboardPush | start whiteboard push task | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| StopOnlineRecord | stop online record | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| StopWhiteboardPush | stop whiteboard push task | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
Read operations
| API | API Description | Authorization Granularity | Six-segment Resource Description | IP Restriction |
|---|---|---|---|---|
| DescribeAPIService | describe information of other qcloud service | Operation level | * | Supported |
| DescribeApplicationUsage | describe sub product usage of tiw application | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| DescribeBoardSDKLog | DescribeBoardSDKLog | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| DescribeOnlineRecord | describe result of online record | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| DescribeOnlineRecordCallback | describe callback address of online record | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| DescribePostpaidUsage | describe postpaid usage | Operation level | * | Supported |
| DescribeRecordSearch | search online record task | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| DescribeRoomList | DescribeRoomList | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| DescribeSnapshot | describe snapshot task result | Resource level | qcs::tiw::uin/${uin}:sdkappid/${SdkAppId} | Supported |
| DescribeSnapshotCallback | describe callback address of snapshot | Resource level | qcs::tiw::uin/${uin}:sdkappid/${SdkAppId} | Supported |
| DescribeTIWRoomDailyUsage | Query the daily billing usage of room dimensions | Resource level | qcs::tiw::uin/${uin}:volume/${volumeId} | Supported |
| DescribeTranscode | describe result of document transcode task | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| DescribeTranscodeByUrl | Query the transcoding task status by document URL. | Resource level | qcs::tiw::uin/${uin}:volume/${volumeId} | Supported |
| DescribeTranscodeCallback | describe callback address of document transcode | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| DescribeTranscodeSearch | search document transcode task | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| DescribeUsageSummary | describe usage summary of tiw application | Operation level | * | Supported |
| DescribeUserList | DescribeUserList | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| DescribeUserResources | describe tiw resources | Operation level | * | Supported |
| DescribeUserStatus | describe user status | Operation level | * | not supported |
| DescribeVideoGenerationTask | describe video generation task result | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| DescribeVideoGenerationTaskCallback | describe callback address for video generation task | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| DescribeWhiteboardBucketConfig | describe whiteboard bucket configuration | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| DescribeWhiteboardPush | DescribeWhiteboardPush | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| DescribeWhiteboardPushCallback | DescribeWhiteboardPushCallback | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| DescribeWhiteboardPushSearch | DescribeWhiteboardPushSearch | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
List Operations
| API | API Description | Authorization Granularity | Six-segment Resource Description | IP Restriction |
|---|---|---|---|---|
| DescribeApplicationInfos | describe tiw applications | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
| DescribeIMApplications | describe im application which is not tiw application | Operation level | * | Supported |
| DescribeWhiteboardApplicationConfig | describe whiteboard application configuration, including event callback address, resource bucket, etc. | Resource level | qcs::tiw::uin/${uin}:sdkappid/${sdkappid} | Supported |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback