Submit a live task

Submit a URL live stream or a ZEGO, Agora, or TRTC room/channel for moderation. Project policy determines whether images, audio, or both are checked.

Request format

Send a UTF-8 encoded JSON body.

For authentication headers and signing rules, see Request signature in the Help Center. Use the submitting project when querying or stopping a task.

Live video requirements

• Supported input types: URL streams and RTC rooms/channels; BASE64 is not supported
• Supported streaming protocols: rtp, rtmp, rtmps, mmsh, mmst, hls, http, tcp, https (subject to the conditions below). For hls, use an http/https playlist URL
• Protocol conditions: rtp requires a media payload that can be identified without an additional SDP session description; tcp must carry an automatically detectable media container. Validate network and port accessibility in the deployment and stream reception for both protocols before use. The API does not accept srtp decryption parameters, so direct access to encrypted srtp streams is not currently supported
• Stream URL requirements: Use a directly accessible stream URL or HLS playlist URL, not a player web page. Keep the URL and its authorization valid throughout moderation; both HLS playlists and media segments must be accessible
• Media requirements: Video tracks must be decodable; audio tracks must also be decodable when audio moderation is required. Processing depends on the audio/video codecs in the stream, not just the protocol or URL suffix
• RTC requirements: ZEGO, Agora, and TRTC are supported. Supply provider and room/channel parameters in data, with valid joining credentials as required by the provider authentication settings. The moderation account must be able to join and subscribe to the audio/video being moderated

Request body

RTC moderation scope

RTC userId/uid identifies the moderation account that joins the room, not a target publisher. Result liveUserId identifies the actual media publisher. Server-side Agora integration is separate from the client-side Agora plugin; do not mix their protocols.

ZEGO — data.zegoParam

AGORA — data.agoraParam

Agora currently does not support the mixAudio, enableVad, or firstFrameBlackFilter request switches; omit them.

TRTC — data.trtcParam

Repeated submissions

While the existing task deduplication record remains valid, URL streams reuse a task by project + strategy + URL; RTC uses project + provider + room/channel, excluding strategy and stream ID. Repeated submissions return the existing task ID and do not update its token, policy, sampling, or callback settings. To change settings, stop the original task and wait for completion/cleanup before submitting again. Use result.taskId from the response body.

Request examples

URL live stream

{
  "video": "https://media.example.com/live.m3u8",
  "frequency": 5,
  "segmentSeconds": 10,
  "liveDirectMedia": true,
  "extra": {
    "bizId": "live-10001"
  }
}

ZEGO

{
  "frequency": 5,
  "segmentSeconds": 10,
  "data": {
    "streamType": "ZEGO",
    "zegoParam": {
      "roomId": "room-10001",
      "userId": "audit-10001",
      "streamId": "stream-10001",
      "accessToken": "replace-with-provider-token",
      "mixAudio": false,
      "idleTimeMillis": 300000
    }
  },
  "callbackUrl": "https://callback.example.com/video-check",
  "callbackSecretKey": "replace-with-callback-secret",
  "extra": {
    "bizId": "rtc-10001"
  }
}

AGORA

{
  "frequency": 5,
  "segmentSeconds": 10,
  "data": {
    "streamType": "AGORA",
    "agoraParam": {
      "appId": "replace-with-agora-app-id",
      "channelId": "channel-10001",
      "userId": "audit-10001",
      "accessToken": "replace-with-provider-token",
      "idleTimeMillis": 300000
    }
  },
  "callbackUrl": "https://callback.example.com/video-check",
  "callbackSecretKey": "replace-with-callback-secret",
  "extra": {
    "bizId": "rtc-10001"
  }
}

TRTC

{
  "frequency": 5,
  "segmentSeconds": 10,
  "data": {
    "streamType": "TRTC",
    "trtcParam": {
      "sdkAppId": "1400000001",
      "strRoomId": "room-10001",
      "uid": "audit-10001",
      "userSig": "replace-with-provider-user-sig",
      "idleTimeMillis": 300000
    }
  },
  "callbackUrl": "https://callback.example.com/video-check",
  "callbackSecretKey": "replace-with-callback-secret",
  "extra": {
    "bizId": "rtc-10001"
  }
}

All credentials and addresses are placeholders. Provider credentials must remain valid for room entry and ongoing moderation, with permission to receive the required media.

Response format

The response body is JSON, with the response header Content-Type: application/json.

{
  "errorCode": 0,
  "result": {
    "taskId": "cn_00000000-0000-0000-0000-000000000001_1791763200000",
    "result": 0
  }
}

Save result.taskId from the actual response. The example ID cannot be reused in subsequent requests.

Errors

See Error codes and handling; handle HTTP status, errorCode, task/result status code, and moderation verdict result separately.