tencent cloud

Tencent Real-Time Communication

お知らせ・リリースノート
製品アップデート情報
Tencent Cloudオーディオビデオ端末SDKの再生アップグレードおよび承認チェック追加に関するお知らせ
TRTCアプリケーションのサブスクリプションパッケージサービスのリリースに関する説明について
製品の説明
製品概要
基礎概念
製品の機能
製品の強み
ユースケース
性能データ
購入ガイド
Billing Overview
無料時間の説明
Monthly subscription
Pay-as-you-go
TRTC Overdue and Suspension Policy
課金に関するよくあるご質問
Refund Instructions
初心者ガイド
Demo体験
Call
コンポーネントの説明(TUICallKit)
Activate the Service
Run Demo
クイック導入
オフライン通知
Conversational Chat
クラウドレコーディング(TUICallKit)
AI Noise Reduction
インターフェースのカスタマイズ
Calls integration to Chat
Additional Features
No UI Integration
Server APIs
Client APIs
Solution
ErrorCode
公開ログ
よくある質問
ライブ配信
Billing of Video Live Component
Overview
Activating the Service (TUILiveKit)
Demo のクイックスタート
No UI Integration
UI Customization
Live Broadcast Monitoring
Video Live Streaming
Voice Chat Room
Advanced Features
Client APIs
Server APIs
Error Codes
Release Notes
FAQs
RTC Engine
Activate Service
SDKのダウンロード
APIコードサンプル
Usage Guidelines
クライアント側 API
高度な機能
RTC RESTFUL API
History
Introduction
API Category
Room Management APIs
Stream mixing and relay APIs
On-cloud recording APIs
Data Monitoring APIs
Pull stream Relay Related interface
Web Record APIs
AI Service APIs
Cloud Slicing APIs
Cloud Moderation APIs
Making API Requests
Call Quality Monitoring APIs
Usage Statistics APIs
Data Types
Appendix
Error Codes
コンソールガイド
アプリケーション管理
使用統計
監視ダッシュボード
開発支援
Solution
Real-Time Chorus
よくあるご質問
課金関連問題
機能関連
UserSig関連
ファイアウォールの制限の対応関連
インストールパッケージの圧縮に関するご質問
AndriodおよびiOS関連
Web端末関連
Flutter関連
Electron関連
TRTCCalling Web関連
オーディオビデオ品質関連
その他のご質問
旧バージョンのドキュメント
TUIRoom(Web)の統合
TUIRoom (Android)の統合
TUIRoom (iOS)の統合
TUIRoom (Flutter)の統合
TUIRoom (Electron)の統合
TUIRoom APIのクエリー
クラウドレコーディングと再生の実現(旧)
Protocols and Policies
セキュリティコンプライアンス認証
セキュリティホワイトペーパー
情報セキュリティの説明
Service Level Agreement
Apple Privacy Policy: PrivacyInfo.xcprivacy
TRTC ポリシー
プライバシーポリシー
データ処理とセキュリティ契約
用語集

CreateCloudModeration

PDF
フォーカスモード
フォントサイズ
最終更新日: 2025-12-22 11:43:56

1. API Description

Domain name for API request: trtc.intl.tencentcloudapi.com.

API description:
This API is used to enable the cloud moderation feature to complete audio and video slicing, video frame extraction, and audio stream recording in the room, and submit them to the specified moderation supplier for completing the moderation.

This API is used to achieve the following goals:

  • This API is used to specify the moderation parameters (ModerationParams) to specify the detailed parameters required for moderation.
  • This API is used to specify the storage parameter (SliceStorageParams) to specify the cloud storage you want to upload the file complying with the moderation policy to. Currently, Tencent Cloud Object Storage (COS) and third-party AWS are supported.

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: CreateCloudModeration.
Version Yes String Common Params. The value used for this API: 2019-07-22.
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 TRTC, which is the same as the SdkAppId corresponding to the TRTC room.
RoomId Yes String RoomId of TRTC, which is the RoomId corresponding to the TRTC room.
UserId Yes String Chatbot's UserId, which is used to enter the room and initiate a moderation task. [*Note] This UserId should not be duplicated with the UserIds of the current anchors or audience members in the room. If multiple moderation tasks are initiated in one room, the chatbot's UserId should also be unique; otherwise, the previous moderation task is interrupted. It is recommended to include the room ID as part of the UserId, ensuring that the chatbot's UserId is unique in the room.
UserSig Yes String Signature verification corresponding to the chatbot's UserId, namely, the UserId and UserSig serve as the login password for the chatbot to enter the room. For specific calculation methods, see TRTC solution for calculating UserSig.
ModerationParams Yes ModerationParams Control parameters for cloud moderation.
ModerationStorageParams Yes ModerationStorageParams Parameters for uploading cloud moderation files to the cloud storage.
RoomIdType No Integer Type of the TRTC room number. [*Note] It should be the same as the type of the RoomId corresponding to the recording room. 0: string type; 1: 32-bit integer type (default value). Example value: 1.
ResourceExpiredHour No Integer Validity period for calling the task ID, which starts upon successful initiation of the task and obtaining the task ID. After the timeout, APIs such as querying, updating, or stopping cannot be called, but the moderation task is not stopped. The unit of the parameter is hours, with a default value of 24 hours (1 day). The maximum value is 72 hours (3 days), while the minimum value is 6 hours. For example, if this parameter is not specified, the validity period for calling the querying, updating, and stopping slicing APIs is 24 hours upon the successful start of slicing.

3. Output Parameters

Parameter Name Type Description
TaskId String Task ID assigned by the cloud moderation service. It is a unique identifier for the lifecycle of a moderation task, which loses its significance after the task is completed. The task ID needs to be retained by the business system as a parameter for future operations related to this task.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Creating Cloud Moderation Tasks

This example shows you how to start a cloud moderation task for the specified room (room number: 150) with SdkAppId 200806.

This example shows you how to set the idle time for the room to 30 seconds.
This example shows you how to set the moderation mode to send a video frame screenshot to Tencent ACE for moderation every 5 seconds.
This example shows you how to send a 15-second audio to Tencent ACE for moderation every 15 seconds.
This example shows you how to send the moderation result to the customers through the configured callback URL.

Input Example

POST / HTTP/1.1
Host: trtc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCloudSliceTask
<Common request parameters>

{
    "SdkAppId": 200806,
    "RoomId": "150",
    "RoomIdType": 1,
    "UserId": "inspect",
    "UserSig": "eJwszc3KgkAUxvF7Odv3xY6jx2KgRU1NPHMy3CnQIZEJBDxf1SulLZcs*pAAuveqIuFaeqrW2kMVyAFYogrTGbnBiScDmm2zf0*HdqoLAhxQ85dn4vMn4*N8zFT7f-aXIf3Zj0fWn78*ktBUUyJoEmHMS0ChM83AAD---1NMfA_",
    "ModerationParams": {
        "ModerationType": 1,
        "MaxIdleTime": 30,
        "SliceAudio": 15,
        "SliceVideo": 5,
        "ModerationSupplier": "ace",
        "ModerationSupplierParam": {
            "AppID": "2501",
            "SecretId": "ace_ugc_20521",
            "SecretKey": "637ae34f4069afb92xxxxxxx",
            "AudioBizType": "2001",
            "ImageBizType": "2002"
        },
        "SaveModerationFile": 0,
        "CallbackAllResults": 0
    },
    "ModerationStorageParams": {
        "CloudModerationStorage": {
            "Vendor": 0,
            "Region": "ap-guangzhou",
            "Bucket": "av-recover-prod-1258344699",
            "AccessKey": "AKIDiGYZYrugBPM3TbS2MO9dqmRp",
            "SecretKey": "91w4wXswiDSQ7XfX8So31Bm6",
            "FileNamePrefix": [
                "testname"
            ]
        }
    },
    "ResourceExpiredHour": 72
}

Output Example

{
    "Response": {
        "RequestId": "6c8eac0c-a46e-4002-893a-935160b43b34",
        "TaskId": "-npVqpdU7qidKD61us+k9KlbamMCLrDbczWnLoK-2OqyoZWQndib8Ma8fbGq2JxnW26LgE."
    }
}

5. Developer Resources

SDK

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
AuthFailure CAM signature/authentication error.
AuthFailure.UnRealNameAuthenticated Identity verification has not been completed, so this operation is not allowed.
AuthFailure.UnauthorizedOperation CAM authentication failed.
AuthFailure.UnsupportedOperation Unsupported operation.
FailedOperation Operation failed.
FailedOperation.CSUnsupportMethod The cloud slicing method is not supported.
FailedOperation.RestrictedConcurrency Maximum number of concurrent on-cloud recording tasks reached. Contact us to raise the limit.
InternalError.CSInternalError Internal service error of cloud slicing occurs.
InvalidParameter.OutOfRange Parameter value is out of range.
InvalidParameter.SdkAppId SdkAppId is incorrect.
MissingParameter.AccessKey AccessKey parameter missing.
MissingParameter.Bucket Bucket parameter missing.
MissingParameter.Region Region parameter missing.
MissingParameter.RoomId RoomId is missing.
MissingParameter.SdkAppId SdkAppId is missing.
MissingParameter.SecretKey SecretKey parameter missing.
MissingParameter.SliceParams The SliceParams parameter is required.
MissingParameter.SliceStorageParams The SliceStorageParams parameter is required.
MissingParameter.SliceType The SliceType parameter is required.
MissingParameter.TaskId TaskId parameter missing.
MissingParameter.UserId Missing UserId parameter.
MissingParameter.UserSig UserSig parameter missing.
MissingParameter.Vendor Vendor parameter missing.
UnsupportedOperation Unsupported operation.

ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック