nimeet 文档中心
English

声网兼容频道查询

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

由公开 REST 接口定义生成

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

分组概览

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

方法路径摘要
GET/dev/v1/channel/user/property/{appid}/{uid}/{channelName}Agora: user status in a channel
GET/dev/v1/channel/user/{appid}/{channelName}Agora: list users in a channel
GET/dev/v1/channel/user/{appid}/{channelName}/hosts_onlyQuery the host list of a live channel
GET/dev/v1/channel/{appid}Agora: list channels
GET/dev/v1/kicking-ruleAgora: list kicking rules
POST/dev/v1/kicking-ruleAgora: create kicking rule
PUT/dev/v1/kicking-ruleAgora: update kicking rule
DELETE/dev/v1/kicking-ruleAgora: delete kicking rule

操作详情

GET /dev/v1/channel/user/property/{appid}/{uid}/{channelName}

Agora: user status in a channel

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

参数

名称位置必填类型说明
appidpath是stringpattern ^[a-f0-9]{32}$
uidpath是integer1..2147483647
channelNamepath是string长度 0..128

响应

状态码说明 / schema
200Agora: user property in a channel — object{ success, data }
401Missing/invalid credentials — Error

调用示例

bash
curl -s -X GET "$NIMEET_API_BASE/dev/v1/channel/user/property/$APP_ID/10001/weekly-sync" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

GET /dev/v1/channel/user/{appid}/{channelName}

Agora: list users in a channel

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

参数

名称位置必填类型说明
appidpath是stringpattern ^[a-f0-9]{32}$
channelNamepath是string长度 0..128
hosts_onlyqueryboolean

响应

状态码说明 / schema
200Agora: channel user list — object{ success, data }
401Missing/invalid credentials — Error

调用示例

bash
curl -s -X GET "$NIMEET_API_BASE/dev/v1/channel/user/$APP_ID/weekly-sync?hosts_only=true" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

GET /dev/v1/channel/user/{appid}/{channelName}/hosts_only

Query the host list of a live channel

Returns the broadcasters of a live channel only; the dedicated path is equivalent to ?hosts_only=.

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

参数

名称位置必填类型说明
appidpath是stringpattern ^[a-f0-9]{32}$
channelNamepath是string长度 0..128

响应

状态码说明 / schema
200hosts of the channel — object{ success, data }
400Invalid parameter — Error
401Missing/invalid credentials — Error
403Banned or service not enabled — Error
404Resource not found — Error
415Content-Type must be application/json — Error
429Quota exceeded — Error

调用示例

bash
curl -s -X GET "$NIMEET_API_BASE/dev/v1/channel/user/$APP_ID/weekly-sync/hosts_only" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

GET /dev/v1/channel/{appid}

Agora: list channels

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

参数

名称位置必填类型说明
appidpath是stringpattern ^[a-f0-9]{32}$
page_noqueryinteger>= 0，默认 0
page_sizequeryinteger1..500，默认 100

响应

状态码说明 / schema
200Agora: { success, data: { channels, total_size } } — object{ success, data }
401Missing/invalid credentials — Error

调用示例

bash
curl -s -X GET "$NIMEET_API_BASE/dev/v1/channel/$APP_ID?page_no=0&page_size=100" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

GET /dev/v1/kicking-rule

Agora: list kicking rules

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

参数

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

响应

状态码说明 / schema
200Agora: { status, rules } — object{ status, rules }
400Invalid parameter — Error
401Missing/invalid credentials — Error

调用示例

bash
curl -s -X GET "$NIMEET_API_BASE/dev/v1/kicking-rule?appid=%24APP_ID" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

POST /dev/v1/kicking-rule

Agora: create kicking rule

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

请求体

字段类型必填说明
appidstring是
cnamestring
uidinteger
ipstring
timeintegerban minutes；0..1440
time_in_secondsinteger0..86430
privilegesarray<enum(join_channel | publish_audio | publish_video)>是
json
{
  "appid": "$APP_ID",
  "cname": "weekly-sync",
  "uid": 10001,
  "time": 10,
  "privileges": [
    "join_channel"
  ]
}

响应

状态码说明 / schema
200Agora: { status: "success", id } — object{ status, id }
400Invalid parameter — Error
401Missing/invalid credentials — Error

调用示例

bash
curl -s -X POST "$NIMEET_API_BASE/dev/v1/kicking-rule" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC" \
  -H "Content-Type: application/json" \
  -d '{"appid":"$APP_ID","cname":"weekly-sync","uid":10001,"time":10,"privileges":["join_channel"]}'

PUT /dev/v1/kicking-rule

Agora: update kicking rule

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

请求体

字段类型必填说明
appidstring是
idinteger是
timeinteger
time_in_secondsinteger
privilegesarray<string>
json
{
  "appid": "$APP_ID",
  "cname": "weekly-sync",
  "uid": 10001,
  "time": 10,
  "privileges": [
    "join_channel"
  ]
}

响应

状态码说明 / schema
200Agora: { status: "success", id } — object{ status, id }
400Invalid parameter — Error
401Missing/invalid credentials — Error

调用示例

bash
curl -s -X PUT "$NIMEET_API_BASE/dev/v1/kicking-rule" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC" \
  -H "Content-Type: application/json" \
  -d '{"appid":"$APP_ID","cname":"weekly-sync","uid":10001,"time":10,"privileges":["join_channel"]}'

DELETE /dev/v1/kicking-rule

Agora: delete kicking rule

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

请求体

字段类型必填说明
appidstring是
idinteger是
json
{
  "appid": "$APP_ID",
  "cname": "weekly-sync",
  "uid": 10001,
  "time": 10,
  "privileges": [
    "join_channel"
  ]
}

响应

状态码说明 / schema
200Agora: { status: "success", id } — object{ status, id }
400Invalid parameter — Error
401Missing/invalid credentials — Error

调用示例

bash
curl -s -X DELETE "$NIMEET_API_BASE/dev/v1/kicking-rule" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC" \
  -H "Content-Type: application/json" \
  -d '{"appid":"$APP_ID","cname":"weekly-sync","uid":10001,"time":10,"privileges":["join_channel"]}'

本分组用到的 Schema

Error — object{ code, message, reason, sdkCode, details }
字段类型必填说明
codestring是stable machine code, see errors.json
messagestring是
reasonstring
sdkCodeintegerAgora-aligned client error number
detailsobject

本页由文档构建流水线生成 · 2026-10-31 01:24:02 UTC · 文档中心 v1.1.0.

内容依据公开 API 定义.

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