nimeet 文档中心
English

Media Pull

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

由公开 REST 接口定义生成

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

分组概览

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

方法路径摘要
GET/v1/projects/{appId}/cloud-player/playersList the cloud players of a project
POST/{region}/v1/projects/{appId}/cloud-player/playersCreate a cloud player
GET/{region}/v1/projects/{appId}/cloud-player/players/{id}Get one cloud player
PATCH/{region}/v1/projects/{appId}/cloud-player/players/{id}Update a cloud player
DELETE/{region}/v1/projects/{appId}/cloud-player/players/{id}Destroy a cloud player
PATCH/{region}/v1/projects/{appId}/cloud-player/{playerid}Update a cloud player (legacy path spelling)

操作详情

GET /v1/projects/{appId}/cloud-player/players

List the cloud players of a project

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

参数

名称位置必填类型说明
appIdpath是stringpattern ^[a-f0-9]{32}$
filterquerystring
pageSizequeryinteger1..500，默认 200
pageTokenquerystring

响应

状态码说明 / schema
200cloud players — object{ totalSize, players, fields, nextPageToken }
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/v1/projects/appId/cloud-player/players?filter=value&pageSize=0&pageToken=value" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

POST /{region}/v1/projects/{appId}/cloud-player/players

Create a cloud player

Creates a player that pulls an online media stream into an RTC channel as a user. The player is connecting until the injected participant is observed in the channel, then running.

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

参数

名称位置必填类型说明
regionpath是enum(cn | ap | na | eu)
appIdpath是stringpattern ^[a-f0-9]{32}$
streamIpquerystringformat ipv4

请求体

字段类型必填说明
playerobject是
json
{
  "player": {
    "streamUrl": "string",
    "channelName": "weekly-sync",
    "uid": 1,
    "account": "string"
  }
}

响应

状态码说明 / schema
200player created — object{ player, fields }
400Invalid parameter — Error
401Missing/invalid credentials — Error
403Banned or service not enabled — Error
404Resource not found — Error
409a cloud player with the same name already exists — Error
415Content-Type must be application/json — Error
429Quota exceeded — Error

调用示例

bash
curl -s -X POST "$NIMEET_API_BASE/cn-shanghai/v1/projects/appId/cloud-player/players?streamIp=value" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC" \
  -H "Content-Type: application/json" \
  -d '{"player":{"streamUrl":"string","channelName":"weekly-sync","uid":1,"account":"string"}}'

GET /{region}/v1/projects/{appId}/cloud-player/players/{id}

Get one cloud player

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

参数

名称位置必填类型说明
regionpath是enum(cn | ap | na | eu)
appIdpath是stringpattern ^[a-f0-9]{32}$
idpath是string长度 0..128

响应

状态码说明 / schema
200the cloud player — object{ player, fields }
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/cn-shanghai/v1/projects/appId/cloud-player/players/weekly-sync_1a2b" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

PATCH /{region}/v1/projects/{appId}/cloud-player/players/{id}

Update a cloud player

Changes the source address, the transcoding options, the playback position or the paused state.

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

参数

名称位置必填类型说明
regionpath是enum(cn | ap | na | eu)
appIdpath是stringpattern ^[a-f0-9]{32}$
idpath是string长度 0..128
sequencequeryinteger>= 0

请求体

字段类型必填说明
playerobject{ streamUrl, audioOptions, videoOptions, seekPosition, isPause }
json
{
  "player": {
    "streamUrl": "string",
    "audioOptions": {},
    "videoOptions": {}
  }
}

响应

状态码说明 / schema
200the request succeeded; the response body is empty
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 PATCH "$NIMEET_API_BASE/cn-shanghai/v1/projects/appId/cloud-player/players/weekly-sync_1a2b?sequence=0" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC" \
  -H "Content-Type: application/json" \
  -d '{"player":{"streamUrl":"string","audioOptions":{},"videoOptions":{}}}'

DELETE /{region}/v1/projects/{appId}/cloud-player/players/{id}

Destroy a cloud player

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

参数

名称位置必填类型说明
regionpath是enum(cn | ap | na | eu)
appIdpath是stringpattern ^[a-f0-9]{32}$
idpath是string长度 0..128

响应

状态码说明 / schema
200the request succeeded; the response body is empty
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 DELETE "$NIMEET_API_BASE/cn-shanghai/v1/projects/appId/cloud-player/players/weekly-sync_1a2b" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

PATCH /{region}/v1/projects/{appId}/cloud-player/{playerid}

Update a cloud player (legacy path spelling)

Documented legacy spelling of the player update; identical behaviour to /cloud-player/players/{id}.

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

参数

名称位置必填类型说明
regionpath是enum(cn | ap | na | eu)
appIdpath是stringpattern ^[a-f0-9]{32}$
playeridpath是string长度 0..128
sequencequeryinteger>= 0

请求体

字段类型必填说明
playerobject{ streamUrl, audioOptions, videoOptions, seekPosition, isPause }
json
{
  "player": {
    "streamUrl": "string",
    "audioOptions": {},
    "videoOptions": {}
  }
}

响应

状态码说明 / schema
200the request succeeded; the response body is empty
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 PATCH "$NIMEET_API_BASE/cn-shanghai/v1/projects/appId/cloud-player/playerid?sequence=0" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC" \
  -H "Content-Type: application/json" \
  -d '{"player":{"streamUrl":"string","audioOptions":{},"videoOptions":{}}}'

本分组用到的 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 兼容。