RTC开发者文档中心 飞雁云
English

内容审核

构建时从公开 REST 接口定义的 `moderation` 标签生成：方法、路径、参数、请求体、响应与 curl。

由公开 REST 接口定义生成

版本 v1.1.0 · 更新于 2026-10-26 · 修订 1

分组概览

本页由公开 REST 接口定义在构建时生成：标签 moderation，共 6 个操作（全量 230 个）。鉴权、信封与分页约定见 REST API 总览.

方法路径摘要
POST/v1/moderation/inspectUpload a sample for inspection
GET/v1/moderation/tasksList moderation tasks
POST/v1/moderation/tasksCreate a moderation task
GET/v1/moderation/tasks/{taskId}Get a moderation task
GET/v1/moderation/tasks/{taskId}/findingsList findings of a task
POST/v1/moderation/tasks/{taskId}/stopStop a moderation task

操作详情

POST /v1/moderation/inspect

Upload a sample for inspection

Called by the client SDK (ContentInspectConfig / ContentInspectModule) with the task token. The sample is judged by the deployment's moderation provider; a flagged verdict triggers a signed callback to the task callbackUrl. A deployment without a provider answers 503 moderation_provider_unavailable (fail-closed).

鉴权：无需鉴权

请求体

字段类型必填说明
mediaTypeenum(image | audio | video)是
mediastring是base64 sample bytes (decoded limit 512 KiB)
capturedAtstringformat date-time
extraInfostring长度 0..1024
json
{
  "mediaType": "image",
  "media": "string",
  "capturedAt": "string",
  "extraInfo": "string"
}

响应

状态码说明 / schema
201OK — ModerationInspectResult
400Invalid parameter — Error
401Bad/expired task token (moderation_token_invalid) — Error
403Task stopped or media type not declared (moderation_task_inactive) — Error
413Sample too large (moderation_payload_too_large) — Error
503No provider configured (moderation_provider_unavailable) — Error

调用示例

bash
curl -s -X POST "$NIMEET_API_BASE/v1/moderation/inspect" \
  -H "Content-Type: application/json" \
  -d '{"mediaType":"image","media":"string","capturedAt":"string","extraInfo":"string"}'

GET /v1/moderation/tasks

List moderation tasks

鉴权：项目凭证（customerId:customerSecret 的 Base64）

参数

名称位置必填类型说明
statusqueryenum(active | stopped)
channelNamequerystring
limitqueryinteger1..200
offsetqueryinteger>= 0

响应

状态码说明 / schema
200OK — object{ tasks, total }
400Invalid parameter — Error

调用示例

bash
curl -s -X GET "$NIMEET_API_BASE/v1/moderation/tasks?status=active&channelName=weekly-sync&limit=50&offset=0" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

POST /v1/moderation/tasks

Create a moderation task

One active task per (project, channel, uid); a duplicate answers moderation_task_conflict with details.taskId. The response carries the one-time inspectToken and inspectUrl — the SDK uploads samples there (ContentInspectConfig.serverConfig equivalent). providerConfigured=false means the deployment has no moderation provider and uploads will answer 503.

鉴权：项目凭证（customerId:customerSecret 的 Base64）

请求体

字段类型必填说明
channelNamestring是pattern ^[A-Za-z0-9_-]{1,128}$
uidinteger | null1..2147483647
mediaTypesarray<enum(image | audio | video)>
intervalSecondsinteger1..3600
callbackUrlstring | null长度 0..2048
metadataobject
json
{
  "channelName": "weekly-sync",
  "uid": 1,
  "mediaTypes": [
    "image"
  ]
}

响应

状态码说明 / schema
201OK — ModerationTaskCreated
400Invalid parameter — Error
409An active task already exists (moderation_task_conflict) — Error

调用示例

bash
curl -s -X POST "$NIMEET_API_BASE/v1/moderation/tasks" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC" \
  -H "Content-Type: application/json" \
  -d '{"channelName":"weekly-sync","uid":1,"mediaTypes":["image"]}'

GET /v1/moderation/tasks/{taskId}

Get a moderation task

鉴权：项目凭证（customerId:customerSecret 的 Base64）

参数

名称位置必填类型说明
taskIdpath是string

响应

状态码说明 / schema
200OK — ModerationTask
404Unknown task (moderation_task_not_found) — Error

调用示例

bash
curl -s -X GET "$NIMEET_API_BASE/v1/moderation/tasks/taskId" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

GET /v1/moderation/tasks/{taskId}/findings

List findings of a task

鉴权：项目凭证（customerId:customerSecret 的 Base64）

参数

名称位置必填类型说明
taskIdpath是string
verdictqueryenum(pass | review | block)
limitqueryinteger1..200
offsetqueryinteger>= 0

响应

状态码说明 / schema
200OK — object{ findings, total }
404Unknown task (moderation_task_not_found) — Error

调用示例

bash
curl -s -X GET "$NIMEET_API_BASE/v1/moderation/tasks/taskId/findings?verdict=pass&limit=50&offset=0" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

POST /v1/moderation/tasks/{taskId}/stop

Stop a moderation task

Idempotent: stopping an already-stopped task returns it unchanged.

鉴权：项目凭证（customerId:customerSecret 的 Base64）

参数

名称位置必填类型说明
taskIdpath是string

响应

状态码说明 / schema
200OK — ModerationTask
404Unknown task (moderation_task_not_found) — Error

调用示例

bash
curl -s -X POST "$NIMEET_API_BASE/v1/moderation/tasks/taskId/stop" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

本分组用到的 Schema

Error — object{ code, message, reason, sdkCode, details }
字段类型必填说明
codestring是stable machine code, see errors.json
messagestring是
reasonstring
sdkCodeintegerAgora-aligned client error number
detailsobject
ModerationFinding — object
字段类型必填说明
findingIdstring是
taskIdstring是
mediaTypeenum(image | audio | video)是
verdictenum(pass | review | block)是
labelsarray<string>是
scorenumber | null是0..1
capturedAtstring是format date-time
receivedAtstring是format date-time
providerstring是
notifiedAtstring | null是format date-time
notifyStateenum(delivered | failed | skipped)是
ModerationInspectResult — object{ findingId, verdict, labels, score }
字段类型必填说明
findingIdstring是
verdictenum(pass | review | block)是
labelsarray<string>是
scorenumber | null是
ModerationTask — object
字段类型必填说明
taskIdstring是
projectIdstring
channelNamestring是
uidinteger | null是1..2147483647
mediaTypesarray<enum(image | audio | video)>是
intervalSecondsinteger是1..3600
callbackUrlstring | null
statusenum(active | stopped)是
inspectUrlstring
inspectedCountinteger是>= 0
flaggedCountinteger是>= 0
metadataobject
createdAtstring是format date-time
updatedAtstring是format date-time
stoppedAtstring | null是format date-time
ModerationTaskCreated — object
字段类型必填说明
taskIdstring是
projectIdstring
channelNamestring是
uidinteger | null1..2147483647
mediaTypesarray<enum(image | audio | video)>是
intervalSecondsinteger1..3600
callbackUrlstring | null
statusenum(active | stopped)是
inspectUrlstring
inspectedCountinteger>= 0
flaggedCountinteger>= 0
metadataobject
createdAtstring是format date-time
updatedAtstringformat date-time
stoppedAtstring | nullformat date-time
inspectTokenstring是
inspectTokenExpiresAtstring是format date-time
providerConfiguredboolean

本页由文档构建流水线生成 · 2026-11-05 14:43:28 UTC · 文档中心 v1.1.0.

内容依据公开 API 定义.

ni-meet 是自建 RTC PaaS，媒体面基于 LiveKit（Apache-2.0），并与声网 API 兼容。