Agora-compatible Channel Queries

Agora-compatible channel and user queries.

Generated from the public REST API definitions

Version v1.1.0 · Updated 2026-10-26 · revision 1

Group overview

Generated at build time from the public REST API definition: tag agora-channel, 8 operations (out of 189). For authentication, envelope and pagination conventions see REST API overview.

Method	Path	Summary
`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_only`	Query the host list of a live channel
`GET`	`/dev/v1/channel/{appid}`	Agora: list channels
`GET`	`/dev/v1/kicking-rule`	Agora: list kicking rules
`POST`	`/dev/v1/kicking-rule`	Agora: create kicking rule
`PUT`	`/dev/v1/kicking-rule`	Agora: update kicking rule
`DELETE`	`/dev/v1/kicking-rule`	Agora: delete kicking rule

Operation details

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

Agora: user status in a channel

Authentication: project credentials (Base64 of customerId:customerSecret)

Parameters

Name	Location	Required	Type	Description
`appid`	path	is	`string`	pattern ^[a-f0-9]{32}$
`uid`	path	is	`integer`	1..2147483647
`channelName`	path	is	`string`	length 0..128

Response

Status codes	Description / schema
`200`	Agora: user property in a channel — `object{ success, data }`
`401`	Missing/invalid credentials — `Error`

Example call

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

Authentication: project credentials (Base64 of customerId:customerSecret)

Parameters

Name	Location	Required	Type	Description
`appid`	path	is	`string`	pattern ^[a-f0-9]{32}$
`channelName`	path	is	`string`	length 0..128
`hosts_only`	query		`boolean`

Response

Status codes	Description / schema
`200`	Agora: channel user list — `object{ success, data }`
`401`	Missing/invalid credentials — `Error`

Example call

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=.

Authentication: project credentials (Base64 of customerId:customerSecret)

Parameters

Name	Location	Required	Type	Description
`appid`	path	is	`string`	pattern ^[a-f0-9]{32}$
`channelName`	path	is	`string`	length 0..128

Response

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

Example call

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

Authentication: project credentials (Base64 of customerId:customerSecret)

Parameters

Name	Location	Required	Type	Description
`appid`	path	is	`string`	pattern ^[a-f0-9]{32}$
`page_no`	query		`integer`	>= 0，default 0
`page_size`	query		`integer`	1..500，default 100

Response

Status codes	Description / schema
`200`	Agora: `{ success, data: { channels, total_size } }` — `object{ success, data }`
`401`	Missing/invalid credentials — `Error`

Example call

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

Authentication: project credentials (Base64 of customerId:customerSecret)

Parameters

Name	Location	Required	Type	Description
`appid`	query	is	`string`

Response

Status codes	Description / schema
`200`	Agora: `{ status, rules }` — `object{ status, rules }`
`400`	Invalid parameter — `Error`
`401`	Missing/invalid credentials — `Error`

Example call

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

Authentication: project credentials (Base64 of customerId:customerSecret)

Request body

Field	Type	Required	Description
`appid`	`string`	is
`cname`	`string`
`uid`	`integer`
`ip`	`string`
`time`	`integer`		ban minutes；0..1440
`time_in_seconds`	`integer`		0..86430
`privileges`	`array<enum(join_channel \| publish_audio \| publish_video)>`	is

json

{
  "appid": "$APP_ID",
  "cname": "weekly-sync",
  "uid": 10001,
  "time": 10,
  "privileges": [
    "join_channel"
  ]
}

Response

Status codes	Description / schema
`200`	Agora: `{ status: "success", id }` — `object{ status, id }`
`400`	Invalid parameter — `Error`
`401`	Missing/invalid credentials — `Error`

Example call

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

Authentication: project credentials (Base64 of customerId:customerSecret)

Request body

Field	Type	Required
`appid`	`string`	is
`id`	`integer`	is
`time`	`integer`
`time_in_seconds`	`integer`
`privileges`	`array<string>`

json

{
  "appid": "$APP_ID",
  "cname": "weekly-sync",
  "uid": 10001,
  "time": 10,
  "privileges": [
    "join_channel"
  ]
}

Response

Status codes	Description / schema
`200`	Agora: `{ status: "success", id }` — `object{ status, id }`
`400`	Invalid parameter — `Error`
`401`	Missing/invalid credentials — `Error`

Example call

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

Authentication: project credentials (Base64 of customerId:customerSecret)

Request body

Field	Type	Required	Description
`appid`	`string`	is
`id`	`integer`	is

json

{
  "appid": "$APP_ID",
  "cname": "weekly-sync",
  "uid": 10001,
  "time": 10,
  "privileges": [
    "join_channel"
  ]
}

Response

Status codes	Description / schema
`200`	Agora: `{ status: "success", id }` — `object{ status, id }`
`400`	Invalid parameter — `Error`
`401`	Missing/invalid credentials — `Error`

Example call

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"]}'

Schemas used by this group

Error — object{ code, message, reason, sdkCode, details }

Field	Type	Required	Description
`code`	`string`	is	stable machine code, see errors.json
`message`	`string`	is
`reason`	`string`
`sdkCode`	`integer`		Agora-aligned client error number
`details`	`object`

Agora-compatible Channel Queries

Group overview

Operation details

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

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

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

GET /dev/v1/channel/{appid}

GET /dev/v1/kicking-rule

POST /dev/v1/kicking-rule

PUT /dev/v1/kicking-rule

DELETE /dev/v1/kicking-rule

Schemas used by this group

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

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

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

GET `/dev/v1/channel/{appid}`

GET `/dev/v1/kicking-rule`

POST `/dev/v1/kicking-rule`

PUT `/dev/v1/kicking-rule`

DELETE `/dev/v1/kicking-rule`