nimeet 文档中心
English

旁路推流（FLS / 平台任务）

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

由公开 REST 接口定义生成

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

分组概览

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

方法路径摘要
GET/v1/projects/{appid}/fls/entry_pointsAgora FLS: list entry points
POST/v1/projects/{appid}/fls/entry_pointsAgora FLS: create an entry point
DELETE/v1/projects/{appid}/fls/entry_points/{entryPoint}Agora FLS: delete an entry point
PUT/v1/projects/{appid}/fls/entry_points/{entryPoint}/admin/record/standard/regions/{region}/tasksAgora FLS: start pushing a stream name
DELETE/v1/projects/{appid}/fls/entry_points/{entryPoint}/admin/record/standard/regions/{region}/tasks/{streamName}Agora FLS: stop pushing a stream name
GET/v1/streamsList streaming tasks
POST/v1/streamsStart a RTMP/HLS streaming task
GET/v1/streams/{id}Get a streaming task
POST/v1/streams/{id}/heartbeatViewer heartbeat (resets idle timeout)
POST/v1/streams/{id}/stopStop a streaming task

操作详情

GET /v1/projects/{appid}/fls/entry_points

Agora FLS: list entry points

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

参数

名称位置必填类型说明
appidpath是stringpattern ^[a-f0-9]{32}$

响应

状态码说明 / schema
200{ entryPoints } (sorted strings) — FlsEntryPointList

调用示例

bash
curl -s -X GET "$NIMEET_API_BASE/v1/projects/$APP_ID/fls/entry_points" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

POST /v1/projects/{appid}/fls/entry_points

Agora FLS: create an entry point

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

参数

名称位置必填类型说明
appidpath是stringpattern ^[a-f0-9]{32}$
idquerystring

响应

状态码说明 / schema
200{ entryPoint, entryPoints } — FlsEntryPoint

调用示例

bash
curl -s -X POST "$NIMEET_API_BASE/v1/projects/$APP_ID/fls/entry_points?id=weekly-sync_1a2b" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

DELETE /v1/projects/{appid}/fls/entry_points/{entryPoint}

Agora FLS: delete an entry point

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

参数

名称位置必填类型说明
appidpath是stringpattern ^[a-f0-9]{32}$
entryPointpath是stringpattern ^[A-Za-z0-9_-]{1,64}$

响应

状态码说明 / schema
200{ deleted, entryPoint } — FlsEntryPointDelete

调用示例

bash
curl -s -X DELETE "$NIMEET_API_BASE/v1/projects/$APP_ID/fls/entry_points/live" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

PUT /v1/projects/{appid}/fls/entry_points/{entryPoint}/admin/record/standard/regions/{region}/tasks

Agora FLS: start pushing a stream name

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

参数

名称位置必填类型说明
appidpath是stringpattern ^[a-f0-9]{32}$
entryPointpath是stringpattern ^[A-Za-z0-9_-]{1,64}$
regionpath是enum(cn | ap | na | eu)
idquery是string
cnamequerystring

响应

状态码说明 / schema
202{ streamName, taskId, state, region } — FlsTaskAccepted

调用示例

bash
curl -s -X PUT "$NIMEET_API_BASE/v1/projects/$APP_ID/fls/entry_points/live/admin/record/standard/regions/cn-shanghai/tasks?id=weekly-sync_1a2b&cname=weekly-sync" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

DELETE /v1/projects/{appid}/fls/entry_points/{entryPoint}/admin/record/standard/regions/{region}/tasks/{streamName}

Agora FLS: stop pushing a stream name

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

参数

名称位置必填类型说明
appidpath是stringpattern ^[a-f0-9]{32}$
entryPointpath是stringpattern ^[A-Za-z0-9_-]{1,64}$
regionpath是enum(cn | ap | na | eu)
streamNamepath是stringpattern ^[A-Za-z0-9_-]{1,128}$

响应

状态码说明 / schema
200{ streamName, taskId, state } — FlsTaskStop

调用示例

bash
curl -s -X DELETE "$NIMEET_API_BASE/v1/projects/$APP_ID/fls/entry_points/live/admin/record/standard/regions/cn-shanghai/tasks/weekly-sync_1a2b" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

GET /v1/streams

List streaming tasks

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

响应

状态码说明 / schema
200{ total, streams } — StreamingTaskList

调用示例

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

POST /v1/streams

Start a RTMP/HLS streaming task

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

请求体

字段类型必填说明
channelNamestring是
entryPointstring默认 "live"
streamNamestring
rtmpUrlstring
hlsboolean默认 true
idleTimeoutSecondsinteger默认 300
maxDurationSecondsinteger
idempotencyKeystring
json
{
  "channelName": "weekly-sync",
  "entryPoint": "live",
  "hls": true,
  "idleTimeoutSeconds": 300
}

响应

状态码说明 / schema
202accepted — StreamingTask
403Banned or service not enabled — Error
429Quota exceeded — Error

调用示例

bash
curl -s -X POST "$NIMEET_API_BASE/v1/streams" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC" \
  -H "Content-Type: application/json" \
  -d '{"channelName":"weekly-sync","entryPoint":"live","hls":true,"idleTimeoutSeconds":300}'

GET /v1/streams/{id}

Get a streaming task

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

参数

名称位置必填类型说明
idpath是string长度 0..128

响应

状态码说明 / schema
200task — StreamingTask

调用示例

bash
curl -s -X GET "$NIMEET_API_BASE/v1/streams/weekly-sync_1a2b" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

POST /v1/streams/{id}/heartbeat

Viewer heartbeat (resets idle timeout)

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

参数

名称位置必填类型说明
idpath是string长度 0..128

响应

状态码说明 / schema
200the task with a refreshed lastActiveAt — StreamingTask
404Resource not found — Error

调用示例

bash
curl -s -X POST "$NIMEET_API_BASE/v1/streams/weekly-sync_1a2b/heartbeat" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

POST /v1/streams/{id}/stop

Stop a streaming task

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

参数

名称位置必填类型说明
idpath是string长度 0..128

响应

状态码说明 / schema
200the stopped task (same shape as GET /v1/streams/{id}) — StreamingTask
404Resource not found — Error

调用示例

bash
curl -s -X POST "$NIMEET_API_BASE/v1/streams/weekly-sync_1a2b/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
FlsEntryPoint — object{ entryPoint, entryPoints }
字段类型必填说明
entryPointstring是
entryPointsarray<string>是
FlsEntryPointDelete — object{ deleted, entryPoint }
字段类型必填说明
deletedboolean是
entryPointstring是
FlsEntryPointList — object{ entryPoints }
字段类型必填说明
entryPointsarray<string>是
FlsTaskAccepted — object{ streamName, taskId, state, region }
字段类型必填说明
streamNamestring是
taskIdstring是
stateenum(starting | running | stopping | stopped | failed | expired)是
regionstring是
FlsTaskStop — object{ streamName, taskId, state }
字段类型必填说明
streamNamestring是
taskIdstring是
stateenum(starting | running | stopping | stopped | failed | expired)是
StreamingTask — object
字段类型必填说明
idstring
channelNamestring
entryPointstring
streamNamestring
rtmpUrlstring
hlsUrlstring
stateenum(starting | running | stopping | stopped | failed | expired)
idleTimeoutSecondsinteger
lastActiveAtstringformat date-time
errorstring | null
StreamingTaskList — object{ total, streams }
字段类型必填说明
totalinteger是
streamsarray<object>是

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

内容依据公开 API 定义.

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