文档中心
服务端 API
后台房间信令接口
后台流增加接口

后台流增加接口

更新时间：2025-04-16 11:07

1 接口调用说明

http请求方式: POST/JSON，需使用https
用于增加某个房间一条指定流。

服务环境	调用频率限制	请求示例
国内正式环境	10次/秒	curl -X POST https://liveroom{APPID}-api.zego.im/cgi/addstream -d 'json_str'
海外正式环境	10次/秒	curl -X POST https://liveroom{APPID}-api.zegocloud.com/cgi/addstream -d 'json_str'
国内测试环境	1次/秒	curl -X POST https://test2-liveroom-api.zego.im/cgi/addstream -d 'json_str'
海外测试环境	1次/秒	2020年12月9日及之后接入的用户，使用： curl -X POST https://liveroom-mctest.zego.im/cgi/addstream -d 'json_str' 2020年12月9日之前接入的用户，保持使用原域名： curl -X POST https://test2-liveroom-api.zegocloud.com/cgi/addstream -d 'json_str'

json_str 内容如下：

{
    "access_token": "ACCESS_TOKEN",
    "version": 1,
    "seq": 1,
    "room_id": "r321",
    "user_account": "u1",
    "nick_name":"u1",
    "stream_id": "s1",
    "extra_info": "",
    "title": ""
}

2 参数说明

参数名	类型	是否必须	说明
access_token	String	是	调用接口凭证
version	Int	是	协议版本号，默认填1
seq	Int	是	协议序列号
room_id	String	是	房间 ID
user_account	String	是	推流用户 ID
nick_name	String	是	用户昵称
stream_id	String	是	流ID
extra_info	String	是	流附加信息，不超过1024字节
title	String	是	流标题，不超过127字节

3 返回说明

正常情况下，会返回下述JSON数据包给调用方：

{
       code : 0,
       message : 'success',
       data: {
          "version": 1,
          "seq": 7,
          "stream_id": "s1",
          "stream_sid": "s-1892323111232",
          "stream_seq": 3,
          "stream_ver": 3
       }
}

返回参数说明:

参数名	类型	说明
code	Int	返回码
message	String	操作结果描述
version	Int	协议版本号
seq	Int	协议序列号
stream_id	String	流ID
stream_sid	String	流服务器id
stream_seq	Int	用户流列表更新seq
stream_ver	Int	服务端流版本号；客户端需保存; stream_seq大于client_stream_seq,需更新客户端本地流信息；stream_ver大于client_stream_ver，需更新客户端本地本条流信息

错误时会返回错误码等信息，JSON数据包示例如下（该示例为输入参数错误）:

{
    "code": 2,
    "message": "输入参数错误"
}