服务端
API 参考
圈组

音视频和白板相关抄送

更新时间: 2024/03/15 14:31:48

音视频/白板时长消息抄送

5. "eventType"="5""21"

抄送情景说明

抄送时长场景说明:

http1. 主被叫接通,正常结束(通话时长大于0);
2. 主被叫接通,接通的同时立刻挂断(双方都成功进入频道),抄送时长及主被叫账号。备注:立即挂断时,时长也可能不为0;
3. 主被叫接通后出现异常(如:接通时一方网络出现问题),只有一个人成功进入频道(单人进入,抄送时长为0,status是SINGLE_PARTICIPATE),则只抄送成功进入频道的帐号的时长信息;
4. 特别的,对于时长超长通话(通话时长超过12小时)会按照12小时的间隔将时长信息抄送给客户服务器,少于12小时的音视频会话/互动白板会话均不受影响。

HTTP示例

httpPOST  /receiveMsg.action   HTTP/1.1
Host:  yunxinservice.com.cn
Content-Type:  application/json
CurTime: 1440570500855    //当前UTC时间戳,从1970年1月1日0点0 分0 秒开始到现在的毫秒数(String)
MD5: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx     //根据请求中的request body计算出来的MD5值
CheckSum: 001511b8435e0b28044ca50a78e8f983026c5e01
 
{"channelId":"6265489843204131361","createtime":"1458798033925","duration":"25","eventType":"5","live":"1","members":"[{\"accid\":\"lisi\",\"duration\":13},{\"accid\":\"zhangsan\",\"caller\":true,\"duration\":12}]","status":"SUCCESS","type":"AUDIO"}

cURL示例

curlcurl -X POST -H "Content-Type: application/json" -H "CurTime: 1440570500855" -H "MD5: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "CheckSum: 001511b8435e0b28044ca50a78e8f983026c5e01" -d '{"channelId":"6265489843204131361","createtime":"1458798033925","duration":"25","eventType":"5","live":"0","members":"[{\"accid\":\"lisi\",\"duration\":13},{\"accid\":\"zhangsan\",\"caller\":true,\"duration\":12}]","status":"SUCCESS","type":"AUDIO"}' 'http://yunxinservice.com.cn/receiveMsg.action'

消息体中的JSON字段说明

名称类型说明
channelName String音视频房间名。点对点通话无此字段。
channelId String通道号
createtime String音视频通话/白板开始的事件, 可转为13位时间戳
duration String此通通话/白板的通话时长,精确到秒,可转为Integer类型
eventType String为5,表示是实时音视频/白板时长类型事件
live String是否是互动直播的音视频,0:否,1:是
members String members表示音视频通话或白板的参与者列表,每位参与者的accid字段表示其账号。
对于点对点音视频通话:如果是主叫,该参与者的caller字段为true;被叫无caller字段。
对于多人音视频通话:房间创建者的caller字段为true(若创建者未加入该音视频房间参与通话,则抄送中不会有caller为true的参与者)。
duration字段表示该参与者的单方时长,白板暂无此字段。
userType字段表示用户类型,1-nrtc用户 2-webrtc用户 3-webrtc H5用户 4-小程序用户。
status String 通话/白板状态:
SUCCESS:表示正常挂断;
TIMEOUT:表示超时;
SINGLE_PARTICIPATE:表示只有一个参与者;
RUNNING:表示音视频通话还未结束的中间一次抄送;特别的对于级联场景,没有SUCCESS的状态,都是RUNNING状态,此时若要判断房间是否结束,请参考eventType=26/27的音视频房间结束抄送;
UNKNOWN:表示未知状态
type String 类型:
AUDIO:表示音频通话;
VEDIO:表示视频通话;
DataTunnel:表示白板事件
ext String 音视频发起时的自定义字段,可选,由用户指定
running Boolean 若为true表示超长时长通话的过程中的抄送,缺省或者false表示普通时长通话的抄送或者超长时长通话的最后一次抄送

消息抄送详细示例

实时音频通话时长消息

抄送示例:
{"channelId":"6265489843204131361","createtime":"1458798033925","duration":"25","eventType":"5","live":"0","members":"[{\"accid\":\"lisi\",\"duration\":13},{\"accid\":\"zhangsan\",\"caller\":true,\"duration\":12}]","status":"SUCCESS","type":"AUDIO"}

实时视频通话时长消息

抄送示例:
{"channelId":"6265490045067594274","createtime":"1458798080073","duration":"22","eventType":"5","live":"1","members":"[{\"accid\":\"lisi\",\"duration\":11},{\"accid\":\"zhangsan\",\"caller\":true,\"duration\":11}]","status":"SUCCESS","type":"VEDIO"}

白板时长消息

抄送示例:
{"channelId":"6668145522152249926","createtime":"1473385450643","duration":"12","eventType":"5","members":"[{\"accid\":\"zhangsan\",\"duration\":6},{\"accid\":\"lisi\",\"caller\":true,\"duration\":6}]","status":"SUCCESS","type":"DataTunnel"}

音视频/白板文件下载信息抄送

6. "eventType"="6""22"

说明:

2018710日(v5.4.0版本)开始,网易云信对音视频录制服务进行录制架构优化,对于超过2小时的音视频通话录制文件,会以2小时(若有需要,可向商务经理发起更改申请)为间隔生成文件并进行抄送,需要开发者在处理抄送时了解上述逻辑并做兼容。

HTTP示例

httpPOST  /receiveMsg.action   HTTP/1.1
Host:  yunxinservice.com.cn
Content-Type:  application/json
CurTime: 1440570500855    //当前UTC时间戳,从1970年1月1日0点0 分0 秒开始到现在的毫秒数(String)
MD5: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx     //根据请求中的request body计算出来的MD5值
CheckSum: 001511b8435e0b28044ca50a78e8f983026c5e01
 
{"eventType":"6","fileinfo":"[{\"caller\":true,\"channelid\":\"6290737000999815988\",\"filename\":\"xxxxxx.type\",\"md5\":\"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\"mix\":false,\"size\":\"2167\",\"type\":\"gz\",\"vid\":\"1062591\",\"url\":\"http://xxxxxxxxxxxxxxxxxxxx.type\",\"user\":\"zhangsan\"}]"}

cURL示例

curlcurl -X POST -H "Content-Type: application/json" -H "CurTime: 1440570500855" -H "MD5: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "CheckSum: 001511b8435e0b28044ca50a78e8f983026c5e01" -d '{"eventType":"6","fileinfo":"[{\"caller\":true,\"channelid\":\"6290737000999815988\",\"filename\":\"xxxxxx.type\",\"md5\":\"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\"mix\":false,\"size\":\"2167\",\"type\":\"gz\",\"vid\":\"1062591\",\"url\":\"http://xxxxxxxxxxxxxxxxxxxx.type\",\"user\":\"zhangsan\"}]"}' 'http://yunxinservice.com.cn/receiveMsg.action'

消息体中的JSON字段说明:

注意:音视频/白板文件下载信息抄送,其中fileinfo字段为JSON数组,最多可包含10个数组元素(即10条文件信息/10个channelid),请开发者注意解析区分。

名称类型说明
eventType String值为6,表示是音视频/白板文件下载信息类型的消息
fileinfo String 可转为JSONArray,其中的字段释义如下:
caller:是否是此通通话的发起者,若是则为true,若不是则没有此字段,可转为Boolean值
channelid:通道号,可转为Long值
filename:文件名,直接存储,混合录制文件filename带有"-mix"标记
md5:文件的md5值
size:文件大小,单位为字符,可转为Long值
type:文件的类型(扩展名),包括:实时音频录制文件(aac)、白板录制文件(gz)、实时视频录制文件(mp4)、互动直播视频录制文件(flv)
url:文件的下载地址
user:用户帐号,若该文件为混合录制文件,则该字段为"0"
mix:是否为混合录制文件,true:混合录制文件;false:单人录制文件
vid:点播文件id,注意白板录制文件(gz)无此字段。通过该参数可以调用点播接口查询相关信息。
pieceindex:录制文件的切片索引,如果单通通话录制时长超过切片时长,则录制文件会被且被切割成多个文件
timestamp:文件生成的系统时间

用户进出音视频/白板房间抄送

13. "eventType"="13""23"。需要单独开通,如有需要,请联系网易云信商务经理。

HTTP示例

httpPOST  /receiveMsg.action   HTTP/1.1
Host:  yunxinservice.com.cn
Content-Type:  application/json
CurTime: 1440570500855    //当前UTC时间戳,从1970年1月1日0点0 分0 秒开始到现在的毫秒数(String)
MD5: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx //根据请求中的request body计算出来的MD5值
CheckSum: 001511b8435e0b28044ca50a78e8f983026c5e01
 
{"eventType":"13","event":"1","user":"abcd","channelid":"193384021111101","timestamp":"1510812687298","roomtype":"2"}

cURL示例

curlcurl -X POST -H "Content-Type: application/json" -H "CurTime: 1440570500855" -H "MD5: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "CheckSum: 001511b8435e0b28044ca50a78e8f983026c5e01" -d '{"eventType":"13","event":"1","user":"abcd","channelid":"193384021111101","timestamp":"1510812687298","roomtype":"2"}' ‘http://yunxinservice.com.cn/receiveMsg.action’

消息体中的JSON字段说明

名称类型说明
event String进入或离开音视频/白板房间:
0:离开音视频/白板房间;注:针对点对点通话,由于断网等异常原因导致超时离开通话频道的用户,不一定会产生离开行为的抄送。
1:进入音视频/白板房间。
可转为Integer值
user String用户账号
channelid String通道号,可转为Long值
timestamp String进入或离开音视频/白板房间的13位时间戳,可转为Long值
roomtype String房间类型:
1:点对点双人房间;
2:多人会议房间;
3:互动直播房间;
4:白板房间。
可转为Integer值

音视频房间开始/结束抄送

19. "eventType"="26""27""28""29" 
  • 示例-上传任务抄送:

    19.1. HTTP示例

    19.2. cURL示例

    19.3. 消息体中的JSON字段说明

HTTP示例

httpPOST  /receiveMsg.action   HTTP/1.1
Host:  yunxinservice.com.cn
Content-Type:  application/json
CurTime: 1440570500855    //当前UTC时间戳,从1970年1月1日0点0 分0 秒开始到现在的毫秒数(String)
MD5: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx //根据请求中的request body计算出来的MD5值
CheckSum: 001511b8435e0b28044ca50a78e8f983026c5e01
 
{"channelId": "1234","createtime": "123", "timestamp": "233", eventType":"26"}

cURL示例

curlcurl -X POST -H "Content-Type: application/json" -H "CurTime: 1440570500855" -H "MD5: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "CheckSum: 001511b8435e0b28044ca50a78e8f983026c5e01" -d '{"channelId": "1234","createtime": "123", "timestamp": "233", eventType":"26"}' 'http://yunxinservice.com.cn/receiveMsg.action'

消息体中的JSON字段说明

名称类型说明
eventType String抄送事件类型,26表示音视频房间结束抄送,27表示G2音视频房间结束抄送,28表示音视频房间开始抄送,29表示G2音视频房间开始抄送。
说明:以上类型抄送只有在房间为级联房间时会产生
channelId String通道号
createtime String音视频房间创建时间
timestamp String事件发生时间

RTMP事件抄送

20. "eventType"="35"
  • 示例-上传任务抄送:

    20.1. HTTP示例

    20.2. cURL示例

    20.3. 消息体中的JSON字段说明

HTTP示例

httpPOST  /receiveMsg.action   HTTP/1.1
Host:  yunxinservice.com.cn
Content-Type:  application/json
CurTime: 1440570500855    //当前UTC时间戳,从1970年1月1日0点0 分0 秒开始到现在的毫秒数(String)
MD5: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx //根据请求中的request body计算出来的MD5值
CheckSum: 001511b8435e0b28044ca50a78e8f983026c5e01
 
{"cid": "1234","code": "123", "msg": "aaa", "taskId": "abc", "streamUrl": "sassss","eventType":"35"}

cURL示例

curlcurl -X POST -H "Content-Type: application/json" -H "CurTime: 1440570500855" -H "MD5: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "CheckSum: 001511b8435e0b28044ca50a78e8f983026c5e01" -d '{"cid": "1234","code": "123", "msg": "aaa", "taskId": "abc", "streamUrl": "sassss","eventType":"35"}' 'http://yunxinservice.com.cn/receiveMsg.action'

消息体中的JSON字段说明

名称类型说明
eventType String抄送事件类型,35表示RTMP事件抄送,仅支持音视频通话1.0的客户开通
cid String通道号
code String错误码:
推流成功 505 stream push succeeded
推流地址推流失败 506 stream push failed
过程中推流地址被禁用 506 session forbidden
过程中源站转推cdn失败 506 cdn forward failed
开启录制,但应用无录制权限 510 no record permission
推流停止 511 stop pushing stream
msg String描述
taskId String任务ID
streamUrl StringstreamUrl
此文档是否对你有帮助?
有帮助
去反馈
  • 音视频/白板时长消息抄送
  • 抄送情景说明
  • HTTP示例
  • cURL示例
  • 消息体中的JSON字段说明
  • 消息抄送详细示例
  • 实时音频通话时长消息
  • 实时视频通话时长消息
  • 白板时长消息
  • 音视频/白板文件下载信息抄送
  • HTTP示例
  • cURL示例
  • 消息体中的JSON字段说明:
  • 用户进出音视频/白板房间抄送
  • HTTP示例
  • cURL示例
  • 消息体中的JSON字段说明
  • 音视频房间开始/结束抄送
  • HTTP示例
  • cURL示例
  • 消息体中的JSON字段说明
  • RTMP事件抄送
  • HTTP示例
  • cURL示例
  • 消息体中的JSON字段说明