接口交互

编辑文档更新于 2025-05-09 01:48:33

网关信息

网关地址: https://brtc-wtn.baijiayun.com

发布流

基本信息

Path： /whip/{AppID}/{StreamID}

Method： POST

请求参数

请求体

offer sdp，Unified Plan格式，mline的direction均为sendonly

Headers

参数名称	参数值	是否必须	备注
Authorization		是	必须 Bearer ${token}
Content-Type	application/sdp	是	固定值：application/sdp

路径参数

参数名称	备注
AppID	应用ID
StreamID	流ID

Query

参数名称	必选	备注
session_id	false	客户端生成的 id，用于日志排查
client_ip	false	客户端 IP，用于服务端分配媒体服务器，IPv4 或 IPv6，如： 220.181.38.150 2001:0db8:85a3:0000:0000:8a2e:0370:7334 （冒号会被 URL 编码）
mute_audio	false	true/false 音频的初始 Mute 配置
mute_video	false	true/false 视频的初始 Mute 配置
room_id	false	房间号

Body

SDP answer，Unified Plan格式，mline的direction均为recvonly

响应参数

成功响应

StatusCode 201 Created

响应头

名称	类型	必选	描述
Content-Type	string	true	固定值：application/sdp
Location	string	true	示例值：资源URL https://whip.example.org/resource/id
Link	string	true	WHIP扩展

响应体

SDP answer，Unified Plan格式，mline的direction均为recvonly

其他响应

状态码	说明
400	请求参数有误
401	没有携带Authorization头或token有问题（无法解析、字段与请求不匹配、签名有问题等）
403	Token过期
415	Content-Type错误
500	服务器内部错误

备注

当发送开始发布流请求时，若该StreamID已有发布流资源存在（重复发布流），则新的发布流资源会覆盖旧的，旧发布流资源的ICE连接关闭，DTLS发送close_notify；新发布流资源不继承旧发布流资源的配置信息，使用请求中携带或默认的配置信息

订阅流

请求参数

请求体

offer sdp，Unified Plan格式，mline的direction均为recvonly

Headers

参数名称	参数值	是否必须	备注
Authorization		是	必须 Bearer ${token}
Content-Type	application/sdp	是	固定值：application/sdp

路径参数

参数名称	备注
AppID	应用ID
StreamID	流ID

Query

参数名称	必选	备注
session_id	false	客户端生成的 id，用于日志排查
client_ip	false	客户端 IP，用于服务端分配媒体服务器，IPv4 或 IPv6，如： 220.181.38.150 2001:0db8:85a3:0000:0000:8a2e:0370:7334 （冒号会被 URL 编码）
mute_audio	false	true/false 音频的初始 Mute 配置
mute_video	false	true/false 视频的初始 Mute 配置
room_id	false	房间号
profile	false	Simulcast 流层级

Body

SDP answer，Unified Plan格式，mline的direction均为sendonly

响应参数

成功响应

201 Created

响应头

名称	类型	必选	描述
Content-Type	string	true	固定值：application/sdp
Location	string	true	示例值：资源URL https://whip.example.org/resource/id
Link	string	true	WHIP扩展

响应体

SDP answer，Unified Plan格式，mline的direction均为recvonly

其他响应

状态码	说明
400	请求参数有误
401	没有携带Authorization头或token有问题（无法解析、字段与请求不匹配、签名有问题等）
403	Token过期
415	Content-Type错误
409	流不存在
500	服务器内部错误

备注

当发生重复发布流时，订阅流端应无需重试接收到新的流，服务端会自动更新到新的数据流到客户端

控制流

基本信息

Path： /resource/{resouceId}

Method： POST

请求参数

Headers

参数名称	参数值	是否必须	备注
Content-Type	application/json	是
Authorization		是	必须 Bearer ${token}

路径参数

参数名称	备注
resouceId	此处id为推流或者拉流时响应头中Location 的数据

Body

名称	类型	必须	备注
mute_audio	boolean	false	音频Mute配置
mute_video	boolean	false	视频Mute配置
profile	number	false	仅拉流时生效，用于配置拉大流还是小流

响应参数

成功响应

200 OK

响应头

Content-Type：text/plain

其他响应

状态码	说明
400	请求参数有误
404	资源不存在
500	服务器内部错误

接口说明

只有请求中所携带字段的配置被更新，其他配置维持原状

销毁流

基本信息

Path： /resource/{resouceId}

Method： DELETE

请求参数

Headers

参数名称	参数值	是否必须	备注
Content-Type	application/x-www-form-urlencoded	是
Authorization		是	必须 Bearer ${token}

路径参数

参数名称	备注
resouceId	此处id为推流或者拉流时响应头中Location 的数据

响应参数

成功响应

200 OK

响应头

Content-Type：text/plain

其他响应

状态码	说明
400	请求参数有误
404	资源不存在
500	服务器内部错误

接口说明

开始发布流/订阅流请求成功后，若30s内没有建立ICE连接，应删除相应的资源
当发布流发生ICE failed时，等待30s后再删除相应的资源，期间如果发生重试（重新发送开始发布流请求），则会根据重复发布流的处理逻辑将该资源覆盖
当某个StreamID的发布流资源被删除时，该StreamID的订阅流资源也应被删除，ICE连接关闭，DTLS发送close_notify