接口HOST:https://域名 

websocket服务器:wss://域名

request_key为服务端配置文件中的request_key

返回结果:(JSON格式)

status:1(有数据时)、0(无数据或非法请求)

tips:提示信息

data:数据

data数据说明:

room: 房间相关信息

user: 用户相关信息

owner_stream: 房主流信息(对应CAM)

push: 房主推流地址

rtmp: 房主播放地址(RTMP格式)

flv:    房主播放地址(FLV格式)

status: 房主流状态(0:从未开始, 1:断开, 2:推流中)

guest_stream: 客人流信息(对应手机)

push: 客人推流地址

rtmp: 客人播放地址(RTMP格式)

flv:    客人播放地址(FLV格式)

status: 客人流状态(0:从未开始, 1:断开, 2:推流中)


WebSocket消息说明:

1、 websocket连接时需带上open_id,如wss://域名?open_id=

2、 stream_status: 返回{stream_key,stream_status(1为断开,2为推流中)}

3、 join_session:加入会话

4、 close_session:结束会话


一、 微信登录,获取OpenId

接口:/getOpenId 

参数:(post方式)

key: request_key,

code: 用户微信code

说明:返回用户open_id和nickname


二、 APP获取流信息

接口:/appRegister 

参数:(post方式)

key:request_key,

open_id: app提供的唯一ID

nickname:昵称

说明:返回用户open_id和nickname和from



三、 创建会话

接口:/createSession 

参数:(post方式)

key:request_key

owner_open_id: 发起端用户openid

session_key: 客户端随机生成的session_key(唯一,长度<=16位)

说明:房主发起,如果成功,返回房间相关信息


四、 加入会话

接口:/joinSession 

参数:(post方式)

key:request_key

room_id: 发起端的房间ID

guest_open_id: 接收端用户openid

session_key: 发起端的session_key

说明:被邀请人调用,如果成功,返回加入会话后房间的信息


五、 结束会话

接口:/closeSession 

参数:(post方式)

key:request_key

room_id: 发起端的房间ID

session_key: 发起端的 session_key

说明:双方皆可调用,将邀请人退出,如果成功,返回status为1


六、 获取我的房间信息

接口:/ownerRoomInfo 

参数:(post方式)

key:request_key

open_id: 我的openid

说明:包含用户的推流状态


七、 PC端获取会话信息

接口:/checkSession 

参数:(post方式)

key:request_key

session_key: 发起端的session_key

说明:返回房间相关信息


如您需求源码进行二次开发,请联络技术支持中心 info@foream.com

文档更新时间: 2019-03-19 16:26   作者:admin