全部产品

被调接口

更新时间:2020-09-04 18:47:32

OnConnectOK()

  • 说明
    连接成功。
  • 参数
    无。

OnConnectFailed(err_code, err_msg)

  • 说明
    连接失败。
  • 参数
回调参数 类型 说明
err_code String 错误码
err_msg String 错误码对应的错误信息。
101:初始化超时
102:初始化失败

OnGetSign(bizName,subBiz,uid)

  • 说明
    获取签名。
    说明:业务需要覆盖实现该方法,具体逻辑是到业务自己的服务端获取签名,在业务申请接入时会下发生成的签名。

  • 参数

请求参数 类型 描述
bizName String 业务名
subBiz String 子业务
uid String 用户 ID

OnInitRoomConfigOK()

  • 说明
    初始化房间成功
  • 参数
    无。

OnInitRoomConfigFail(err_code, err_msg)

  • 说明
    初始化房间失败。
  • 参数
回调参数 类型 说明
err_code String 错误码
err_msg String 错误码对应的错误信息。
201:房间状态错误
202:参数错误

OnMediaCallSucc(sid)

  • 说明
    初始化音视频成功。
  • 参数
    无。

OnMediaCallFail(err_code, err_msg)

  • 说明
    初始化音视频失败。
  • 参数
回调参数 类型 说明
err_code int 错误码对应的错误信息:
5101:视频启动失败
5102:音频启动失败
5103:浏览器不支持
5104:房间状态不正确
5105:共享桌面启动失败
5106:发布获取文件流失败
5107:发布文件不存在
5108:发布区域不存在
err_msg String -

OnCreateRoomSucc(room_id, rtoken)

  • 说明
    创建房间成功。

  • 参数

回调参数 类型 说明
room_id String 房间号
rtoken String 房间 token,相当于房间密码

OnCreateRoomFailed(err_code, err_msg)

  • 说明
    创建房间失败。
  • 参数
回调参数 类型 说明
err_code int 错误码对应的错误信息:
301:房间未初始化
302:服务器返回错误
303:创建超时
304:media 初始化超时
err_msg String -

OnJoinRoomSucc()

  • 说明
    加入房间成功。
  • 参数
    无。

OnJoinRoomFailed(err_code, err_msg)

  • 说明
    加入房间失败。
  • 参数
回调参数 类型 说明
err_code int 错误码对应的错误信息:
401:房间未初始化
402:参数错误
403:服务器返回错误
404:加入超时
err_msg String -

OnInviteOK()

  • 说明
    发送邀请加入房间成功。
  • 参数
    无。

OnInviteFail(err_code, err_msg)

  • 说明
    发送邀请加入房间失败。
  • 参数
回调参数 类型 说明
err_code int 错误码对应的错误消息:
501:房间状态错误
502:服务器返回错误
503:参数错误
err_msg String -

OnReplyInviteOK()

  • 说明
    发送答复邀请加入房间成功。
  • 参数
    无。

OnReplyInviteFail(err_code, err_msg)

  • 说明
    发送答复邀请加入房间失败。
  • 参数
回调参数 类型 说明
err_code int 错误码对应的错误消息:
601:房间状态错误
602:服务器返回错误
err_msg String -

OnInviteRequest(roomId, rtoken, inviter, extra)

  • 说明
    被邀请者收到“加入房间”邀请消息。
  • 参数
回调参数 类型 说明
roomId String 房间 ID
rtoken String 房间 token
inviter String 邀请方 uid
extra String 业务透传字段

OnInviteReply(invitee, reply)

  • 说明
    邀请者收到“邀请加入房间”回复消息。
  • 参数
回调参数 类型 说明
invitee String 被邀请方 uid
reply int 0:接听
1:离线
2:拒绝

OnRoomAttendanceList(participants)

  • 说明
    推送“房间与会者列表”给新加入者。
  • 参数
回调参数 类型 说明
participants jsonarray 房间与会者列表。
示例:
[{
“uid”:”1234”,
“publish”:[{
    “feedId”:”1”,
    “tag”:”xxx”
    }, {
    “feedId”:”2”,
    “tag”:”xxx”
    }],
“subscribe”:[{
    “feedId”:”3”
    }, {
    “feedId”:”4”
    }]
  }
}]

OnNewJoinerIn(participant)

  • 说明
    推送“新加入房间者”给与会者。
  • 参数
回调参数 类型 说明
participant String 新加入房间者 uid

OnPublishSucc(sid)

  • 说明
    发布媒体流成功。
  • 参数
回调参数 类型 说明
sid int 流 ID

OnPublishFailed(sid,err_code, err_msg)

  • 说明
    发布媒体流失败。
  • 参数
回调参数 类型 说明
sid int 流 ID
err_code String
err_msg String 1071:服务器返回错误
1072:未设置 video 标签
1073:超出发布限额
1074:发布建立 ice 连接超时

OnSubscribeSucc(feed,sid)

  • 说明
    订阅媒体流成功。
  • 参数
回调参数 类型 说明
sid String 流 ID
feed String 流信息。示例:
{
    “feedId”: [“xxx”,”xxx”],
    “strategy”: 1
}

其中:
feedId:list 类型,表示订阅的流 ID
strategy:int 类型,表示策略

OnSubscribeFailed(sid,err_code, err_msg)

  • 说明
    订阅媒体流失败。
  • 参数
回调参数 类型 说明
sid String 流 ID
err_code int 错误码对应的错误信息。
1081:服务器返回错误
1082:视频窗口 videoId 已使用
1083:超出订阅限额
1084:订阅建立媒体链路失败
1085:订阅的窗口 videoId 为空
err_msg String -

OnNewPublish(feed)

  • 说明
    推送“有新发布”给与会者。
  • 参数
回调参数 类型 说明
feed json 新发布的流信息:
uid:流所属的用户 ID
feedId:发布流 ID
tag:标签

OnNewSubscribe(subscriber,feed)

  • 说明
    推送“有新订阅”给与会者。
  • 参数
回调参数 类型 说明
subscriber String 新订阅者 ID
feed json 新订阅的流信息:
uid:流所属的用户 ID
feedId:被订阅流 ID

OnUnPublishSucc(sid)

  • 说明
    取消发布成功。
  • 参数
回调参数 类型 说明
sid String 流 ID

OnUnSubscribeSucc(sid)

  • 说明
    取消订阅媒体流成功。
  • 参数
回调参数 类型 说明
sid String 流 ID

OnUnPublish(feed)

  • 说明
    推送“取消发布”给与会者。
  • 参数
回调参数 类型 说明
feed json 取消发布的流信息:
uid:流所属的用户 ID
feedId:发布流 ID

OnUnSubscribe(unsubscriber,feed)

  • 说明
    推送“取消订阅”给与会者。
  • 参数
回调参数 类型 说明
unsubscriber String 取消订阅者 ID
feed json 取消订阅的流信息:
uid:流所属的用户 ID
feedId:被订阅流 ID

OnMediaClose(code,sid)

  • 说明
    音视频关闭通知。
  • 参数
回调参数 类型 说明
code int 5001:主动关闭
5002:离开房间被动通知关闭
5003:发布/订阅失败(服务器返回)
5004:建立音视频 ice 连接超时
5005:房间状态异常
5006:取消发布被动通知
5007:ice 连接异常
5008:退出房间关闭音视频
sid int 流 ID

OnSendTextMsgSucc(msgId)

  • 说明
    发送文本消息成功。
  • 参数
回调参数 类型 说明
msgId int 消息 ID

OnSendTextMsgFailed(msgId, code, msg)

  • 说明
    发送文本消息失败。
  • 参数
回调参数 类型 说明
msgId int 消息 ID
code int 10291:服务端返回错误
msg String -

OnReceiveTextMsg(uid, msg)

  • 说明
    推送文本消息。
  • 参数
回调参数 类型 说明
uid String 文本消息发送人
msg String 消息文本

OnLeaveRoom(leaveType)

  • 说明
    退出房间回调。
  • 参数
回调参数 类型 说明
leaveType int 退出房间类型:
1:正常退出
2:异常退出

OnParticipantLeaveRoom(participant,exitType)

  • 说明
    推送“退出房间者”给与会者。
  • 参数
回调参数 类型 说明
participant String 退出者 ID
exitType int 退出类型:
1:正常退出
2:异常退出

OnConnectClose()

  • 说明
    连接关闭。
  • 参数
    无。

OnNetworkWeak(bpsSend, bpsRecv,sid)

  • 说明
    弱网回调。
  • 参数
回调参数 类型 说明
bpsSend String 每秒发送数据(单位 bit)
bpsRecv String 每秒接收数据(单位 bit)
sid int 流 ID(便于区分哪一路流出现弱网)

OnStartAsrSuccess(sid,tag,sessionId)

  • 说明
    开始语音识别成功。
  • 参数
回调参数 类型 说明
sid int 流 ID
tag String 业务透传字段
sessionId String ASR 会话 sessionId

OnStartAsrFailed(sid, err_code, err_msg,tag,sessionId)

  • 说明
    开始语音识别失败。
  • 参数
回调参数 类型 说明
sid int 流 ID
err_code int 20001:ASR 连接超时
err_msg String 错误消息
tag String 业务透传字段
sessionId String ASR 会话 sessionId

OnStopAsrSuccess(sid,tag,sessionId)

  • 说明
    停止语音识别成功。
  • 参数
回调参数 类型 说明
sid int 流 ID
tag String 业务透传字段
sessionId String ASR 会话 sessionId

OnStopAsrFailed(sid, err_code, err_msg,tag,sessionId)

  • 说明
    停止语音识别失败。
  • 参数
回调参数 类型 说明
sid int 流 ID
err_code int 5071:参数不正确
err_msg String 错误消息
tag String 业务透传字段
sessionId String ASR 会话 sessionId

OnAsrMessage(msg, sid,tag,status,sessionId)

  • 说明
    通知识别结果。
  • 参数
回调参数 类型 说明
msg json procType 传值参见 开始语音识别接口。procType 不同,返回格式也不同。
若 procType=8,status=0,则识别结果 msg=
{
"name": "asr",
"value": "识别结果",
"type": 1,
"sentence_id": 3,
"sentence_duration": 6750,
"msg_id": 6
}
若 procType=8,status=1,则返回语音识别结果文件地址,msg=
{
"name": "asr",
"value": "http://coturn-oss-huanan.oss-cn-shenzhen.aliyuncs.com/demo",
"type": 1,
"sentence_id": 3,
"sentence_duration": 6750,
"msg_id": 6
}
若 procType 非 8,则识别结果 value=”识别结果”。
sid int 流 ID
tag String 业务透传字段
status int status=0 表示还未结束
status=1 表示会话结束
sessionId String ASR 会话 sessionId

返回的识别结果 msg 结构如下:

字段 类型 释义
name String 表示识别结果的类型:
asr
nlu
value String 识别的文字结果
type int 识别状态:
0:本句识别中
1:本句识别结束
sentence_id String 句子的唯一标识
sentence_duration int 句子的时长
msg_id int 本条识别结果的 ID
timestamp long 句子结束的绝对时间戳

OnAsrMsgIdle(sid,tag,sessionId)

  • 说明
    长时间没有返回结果通知。
  • 参数
回调参数 类型 说明
sid int 流 ID
tag String 业务透传字段
sessionId String ASR 会话 sessionId

OnStartVodSuccess(file, vod_id)

  • 说明
    开始语音点播成功。
  • 参数
回调参数 类型 说明
file String 点播文件
vod_id String 点播 ID

OnStartVodFail(file, vod_id, err_code, err_msg)

  • 说明
    开始语音点播失败。
  • 参数
回调参数 类型 说明
file String 点播文件
vod_id String 点播 ID
err_code int 错误码对应的消息:
10371:服务端返回错误
10372:房间状态错误
10373:服务端通知开启失败
10374:点播参数有误
10375:开启点播超时
err_msg String -

OnStopVodSuccess(vod_id)

  • 说明
    停止语音点播成功。
  • 参数
回调参数 类型 说明
vod_id String 点播 ID

OnStopVodFail(vod_id, err_code, err_msg)

  • 说明
    停止语音点播失败。
  • 参数
回调参数 类型 说明
vod_id String 点播 ID
err_code int 错误码对应的消息:
10391:服务端返回失败
10392:房间状态错误
10393:点播 ID 有误
err_msg String 错误消息

OnVodOver(vod_id)

  • 说明
    语音点播结束通知。
  • 参数
回调参数 类型 说明
vod_id String 点播 ID

OnVolumeAnalyser(sid, analyser)

  • 说明
    实时音量数据回调。
  • 参数
回调参数 类型 说明
sid String 流 ID
analyser AnalyserNode 返回 AnalyserNode 对象

OnStartTtsSuccess(sessionId)

  • 说明
    开启语音合成成功。
  • 参数
回调参数 类型 说明
sessionId String 语音合成 sessionId

OnStartTtsFailed(code, msg)

  • 说明
    开启语音合成失败。
  • 参数
回调参数 类型 说明
code int 错误码对应的错误消息:
6031:服务端返回错误
6032:参数错误
6033:初始化超时
msg String -

OnTtsResult(status,msg)

  • 说明
    语音合成结果。
  • 参数
回调参数 类型 示例 说明
status int 状态码:
0:成功
非 0:失败
msg json {
“extra”: “”,
“fileUrl”: “”,
“sessionId”: “”,
“fileId”: “”,
“resultType”: 1
}
返回的结果信息:
resultType:返回方式。其中,1 表示文件方式
extra:透传信息
sessionId:语音合成 sessionId
fileUrl:合成语音文件地址
fileId:文件 ID

OnClientStartRecordSuccess(clientRecordId)

  • 说明
    开启浏览器录制成功。
  • 参数
回调参数 类型 说明
clientRecordId String 浏览器录制 ID

OnClientStartRecordFailed(clientRecordId, code, msg)

  • 说明
    开启浏览器录制失败。
  • 参数
回调参数 类型 说明
clientRecordId String 浏览器录制 ID
code int 20301:room 状态错误
20302:已经在录制中
20303:录制 id 已经使用
20304:未发布或未订阅
20305:mediaType 参数错误
msg String 错误码对应的错误消息。

OnClientStopRecordSuccess(videoURL, clientRecordBlob, clientRecordId, targetType)

  • 说明
    停止浏览器录制成功。
  • 参数
回调参数 类型 说明
videoURL String 文件 URL
clientRecordBlob blob 录制文件
clientRecordId String 浏览器录制 ID

OnClientStopRecordFailed(clientRecordId, code, msg)

  • 说明
    停止浏览器录制失败。
  • 参数
回调参数 类型 说明
clientRecordId String 浏览器录制 ID
code int 20331:房间状态错误
msg String 错误码对应的错误消息。

OnClientPauseRecordSuccess(clientRecordId)

  • 说明
    暂停浏览器录制成功。
  • 参数
回调参数 类型 说明
clientRecordId String 浏览器录制 ID

OnClientPauseRecordFailed(clientRecordId, code, msg)

  • 说明
    暂停浏览器录制失败。
  • 参数
回调参数 类型 说明
clientRecordId String 浏览器录制 ID
code int 20371:房间状态错误
20372:未开启浏览器录制
msg String 错误码对应的错误消息。

OnClientResumeRecordSuccess(clientRecordId)

  • 说明
    继续浏览器录制成功。
  • 参数
回调参数 类型 说明
clientRecordId String 浏览器录制 ID

OnClientResumeRecordFailed(clientRecordId, code, msg)

  • 说明
    继续浏览器录制失败。
  • 参数
回调参数 类型 说明
clientRecordId String 浏览器录制 ID
code int 20391:房间状态错误
20392:未开启浏览器录制
msg String 错误码对应的错误消息。

OnClientDownloadRecordSuccess(clientRecordId)

  • 说明
    下载浏览器录制文件成功。
  • 参数
回调参数 类型 说明
clientRecordId String 浏览器录制 ID

OnClientDownloadRecordFailed(clientRecordId, code, msg)

  • 说明
    下载浏览器录制文件失败。
  • 参数
回调参数 类型 说明
clientRecordId String 浏览器录制 ID
code int 20351:房间状态错误
20352:未开启浏览器录制
20353:未停止浏览器录制
msg String 错误码对应的错误消息。

OnGetDevicesSuccess(devicesInfo)

  • 说明
    获取设备信息成功。
  • 参数
回调参数 类型 说明
devicesInfo json 设备信息

OnGetDevicesFailed(code, msg)

  • 说明
    获取设备信息失败。
  • 参数
回调参数 类型 说明
code int 30101:浏览器不支持音视频
30102:获取媒体错误
msg String 错误码对应的错误消息。

OnChangeMediaStreamSuccess(sid)

  • 说明
    切流成功通知。
  • 参数
回调参数 类型 说明
sid int 流 ID

OnChangeMediaStreamFailed(sid,code, msg)

  • 说明
    切流失败通知。
  • 参数
回调参数 类型 说明
sid int 流 ID
code int 1101:未发布
1102:参数错误
1103:media_type 错误
1104:获取音视频失败
1105:共享屏幕流为空
1106:获取视频失败
1107:获取文件流失败
1108:获取音频失败
1109:浏览器不支持音视频
msg String 错误码对应的错误消息。

OnClientRecordBlob(clientRecordId, blob)

  • 说明
    浏览器录制推送录制 blob 数据。
  • 参数
回调参数 类型 说明
clientRecordId String 浏览器录制 ID
blob Blob -

OnInitRemoteRecordSucc(record_id, record_third_id)

  • 说明
    服务端录制初始化成功。
  • 参数
回调参数 类型 说明
recordId String 录制 id
record_third_id String 启动录制时传入的 id,区分调用批次

OnStartRemoteRecordSucc(record_id, record_third_id)

  • 说明
    开始服务端录制成功。
  • 参数
回调参数 类型 说明
record_id String 服务端录制 id
record_third_id String 启动录制时传入的 id,区分调用批次

OnStartRemoteRecordFailed

  • 说明
    开始服务端录制失败。
  • 参数
回调参数 类型 说明
record_id String 服务端录制 id
err_code int 10311 服务端返回开启录制失败
10312:开启录制超时
10313:推送开启录制失败 eventCode=1
10314:推送开启录制失败 eventCode=2
err_msg String -
record_third_id String 启动录制时传入的 id,区分调用批次

OnStopRemoteRecordSucc(record_id)

  • 说明
    停止服务端录制成功。
  • 参数
回调参数 类型 说明
record_id String 服务端录制 id

OnStopRemoteRecordFailed(record_id,err_code, err_msg)

  • 说明
    停止服务端录制失败。
  • 参数
回调参数 类型 说明
record_id String 服务端录制 id
err_code String 10331:服务端返回停止失败
err_msg String -

OnRemoteRecordInfoSucc(recordInfo)

  • 说明
    获取服务端录制结果成功。
  • 参数

说明status 为 2 时,才会有 fileTypefilePath

回调参数 类型 说明
recordInfo json recordId:服务端录制 id
status:录制状态
    0:录制中
    1:上传中
    2:录制成功
    3:录制失败
fileType 文件类型
    1:本地文件
    2:OSS
    3:AFTS
filePath:文件路径

OnRemoteRecordInfoFailed(record_id, err_code, err_msg)

  • 说明
    获取服务端录制结果失败。
  • 参数
回调参数 类型 说明
record_id String 服务端录制 id
err_code int 10351:连接状态错误
10352:服务端返回错误
10353:请求参数错误
err_msg String -

OnPauseRemoteRecordSucc(record_id)

  • 说明
    暂停服务端录制成功。
  • 参数
回调参数 类型 说明
record_id String 服务端录制 id

OnPauseRemoteRecordFailed(record_id, err_code, err_msg)

  • 说明
    暂停服务端录制失败。
  • 参数
回调参数 类型 说明
record_id String 服务端录制 id
err_code int 10341:房间状态错误
10342:录制状态错误
10343:服务端错误
err_msg String -

OnResumeRemoteRecordSucc(record_id)

  • 说明
    恢复服务端录制成功。
  • 参数
回调参数 类型 说明
record_id String 服务端录制 id

OnResumeRemoteRecordFailed(record_id, err_code, err_msg)

  • 说明
    恢复服务端录制失败
  • 参数
回调参数 类型 说明
record_id String 服务端录制 id
err_code int 10361:房间状态错误
10362:录制状态错误
10363:服务端错误
err_msg String -

OnRemoteRecordOver(record_id)

  • 说明
    服务端录制结束通知。此时文件在持久化中,可通过拉取接口获取结果。
  • 参数
回调参数 类型 说明
record_id String 录制 id

OnRemoteRecordingFailed(recordId, feedId, code, msg)

  • 说明
    服务端录制失败通知。
  • 参数
回调参数 类型 说明
recordId String 录制 id
feedId String 与事件相关的流 id
code int 12481:eventCode 为 1
12482:eventCode 为 2
msg String -