会议管理API

会议管理API 提供登录、呼叫、会议创建销毁、透明传输等功能.

登录/注销

登录

Login(account, psw, nickName, userId, cookie)

  • 返回值:无
参数 类型 含义
account string 云屋鉴权帐号
psw string 云屋鉴权密码(需要md5加密)
nickName string 昵称
userId string 自定义帐号,需保证唯一性
cookie string 自定义数据 (在回调时,回传给调用者)

登陆成功则回调LoginSuccess,登陆失败则回调LoginFail

注销

Logout()

  • 返回值:无

登录/注销回调函数

登陆成功

LoginSuccess.callback = function(usrID,cookie){}

  • 功能:登录成功响应

  • 参数

    • usrID ----- 用户账户
    • cookie ----- 自定义用户数据

登录失败

LoginFail.callback = function(sdkEr,RspDesc,cookie){}

  • 功能:登录失败响应

  • 参数

    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • RspDesc ----- 失败描述
    • cookie ----- 自定义用户数据

注销成功

LogoutSuccess.callback = function(){}

  • 功能:登录成功响应

注销失败

CRVideo_LogoutFail.callback = function(sdkEr,RspDesc,cookie){}

  • 功能:注销失败响应

  • 参数

    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • RspDesc ----- 失败描述
    • cookie ----- 自定义用户数据

免打扰

设置免打扰

SetDNDStatus(DNDStatus)

  • 返回值:无
参数 类型 含义
DNDStatus number 0代表自动分配, 1 不自动分配

操作成功则回调SetDNDStatusSuccess,失败则回调SetDNDStatusFail

免打扰回调函数

设置免打扰状态操作成功

SetDNDStatusSuccess.callback = function(){}

  • 功能:客户端设置免打扰状态操作成功响应

设置免打扰状态操作失败

SetDNDStatusFail.callback = function(sdkEr){}

  • 功能:客户端设置免打扰状态操作失败响应

  • 参数

创建/进入/离开/结束会议

创建会议

CreateMeeting(server_addr, account, pwd, meetSubject)

  • 返回值:无
参数 类型 含义
server_addr string 服务器地址
account string 云屋鉴权帐号
pwd string 云屋鉴权密码(需要md5加密)
meetSubject string 会议主题(字符长度最大值50)

操作成功则回调CreateMeetingSuccess,失败则回调CreateMeetingFail

进入会议

EnterMeeting(meetID, pswd, userID, nickName, cookie)

  • 返回值:无
参数 类型 含义
meetID number 视频会话ID
pswd string 本次会议中的密码(系统自动生成,在呼叫回调中取得,若无密码则传空字符串)
userID string 用户id
nickName string 昵称
cookie string 自定义数据 (在回调时,回传给调用者)

双方开始进入本次视频会话 操作完成则回调EnterMeetingRslt

离开会议

ExitMeeting()

  • 返回值:无

他人离开会话的回调事件UserLeftMeeting

结束会议

StopMeeting(meetId, cookie)

  • 功能:停止房间

  • 返回值:无

参数 类型 含义
meetId number 房间id
cookie string 自定义数据 (在回调时,回传给调用者)

回调函数StopMeetingRslt,调用此接口结束房间时,其他会话用户会收到MeetingStopped

创建/进入/离开/结束会议回调函数

创建会议成功

CreateMeetingSuccess.callback = function(meetObj,cookie){}

  • 功能:创建会议成功响应

  • 参数

    • meetObj ----- 会议信息
    • cookie ----- 自定义用户数据

创建会议失败

CreateMeetingFail.callback = function(sdkEr,RspDesc){}

  • 功能:创建会议成功响应

  • 参数

    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • RspDesc ----- 失败描述

进入会议结果

EnterMeetingRslt.callback = function(sdkEr){}

  • 功能:进入会议完成响应

  • 参数

结束会议结果

StopMeetingRslt.callback = function(sdkEr){}

  • 功能:通知结束视频会议结果

  • 参数

结束会议结果

MeetingStopped.callback = function(nickName){}

  • 功能:会议被结束通知

  • 参数

    • nickName ----- 操作者的昵称

开启/查询/关闭用户状态

获取所有用户状态信息列表

GetUserStatus()

  • 返回值:无

操作成功则回调GetUserStatusSuccess,失败则回调GetUserStatusFail

开启用户的状态推送

StartUserStatusNotify()

  • 返回值:无

企业下所有用户状态有变化时包括呼叫会议状态、免打扰状态),都会收到通知开启后,用户量越大消息量越大,所以请按需开启在StartUserStatusNotify前,应该先通过GetUserStatus获取所有用户状态

关闭用户的状态推送

StopUserStatusNotify()

  • 返回值:无

开启/查询/关闭用户状态回调函数

获取所有用户在线状态成功

GetUserStatusSuccess.callback = function(userStatus,cookie){}

  • 功能:客获取所有用户在线状态成功响应

  • 参数

    • userStatus ----- 用户在线状态信息列表,userID:用户id,userStatus:用户的在线状态(0离线 ;1在线空闲 ;2在线忙碌;3在线会议中),DNDType:用户免打扰状态(0代表关闭免打扰,其它值代表开启免打扰)
    • cookie ----- 自定义用户数据

获取所有用户在线状态失败

GetUserStatusFail.callback = function(sdkEr ,cookie){}

  • 功能:获取所有用户在线状态失败响应

  • 参数

    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • cookie ----- 自定义用户数据

开启用户状态推送

StartUserStatusNotifyRslt.callback = function(sdkEr ,cookie){}

  • 功能:启动用户状态推送响应

  • 参数

    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • cookie ----- 自定义用户数据

关闭用户状态推送

StopUserStatusNotifyRslt.callback = function(sdkEr ,cookie){}

  • 功能:结束用户状态推送响应

  • 参数

    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • cookie ----- 自定义用户数据

用户状态通知

用户状态变化通知

NotifyUserStatus.callback = function(userStatus ,cookie){}

  • 功能:某个用户状态变化通知

  • 参数

    • userStatus ----- userStatus单个用户在线状态信息
    • cookie ----- 自定义用户数据

会议成员信息查询

会议成员列表

GetAllMembers()

  • 返回值:返回含多个成员信息(Array ------MemberInfo

会议成员信息

GetMemberInfo(userID)

  • 返回值:返回用户userID的成员信息(MemberInfo
参数 类型 含义
userID string 用户ID

会议成员变动通知

有人进入会议通知

UserEnterMeeting.callback = function(usrID){}

  • 功能某用户进入了会议

  • 参数

    • usrID ----- 进入会议的用户ID

有人离开会议通知

UserLeftMeeting.callback = function(userId,reson){}

  • 功能:某用户离开了会议

  • 参数

    • userId ----- 离开会议的用户ID
    • reson ----- 离开的原因

昵称变更通知

NotifyNickNameChanged.callback = function(userid,oldname,newname){}

  • 功能:SDK通知某用户改变了昵称(改昵称的用户自身不会接收到此通知)

  • 参数

    • userid ----- 用户id
    • oldname ----- 改变昵称的某用户昵称(改变之前的昵称)
    • newname ----- 改变昵称的某用户昵称(改变之后的昵称)

呼叫/接收呼叫/拒绝呼叫/挂断呼叫

发起呼叫

Call(calledUserID, meetObj, usrExtDat)

  • 返回值:返回本次呼叫标识码(呼叫ID)
参数 类型 含义
calledUserID string 被叫用户的账户ID,回调函数AutoAssignUser或者ReqAssignUserRslt中获得
meetObj MeetInfoObj 会议信息
usrExtDat string 自定义扩展参数

操作成功则回调CallSuccess,失败则回调CallFail。 呼叫时,对方迟迟不响应,30秒后系统自动结束呼叫

接受对方发起的呼叫

AcceptCall(callID, meetObj, usrExtDat, cookie)

参数 类型 含义
callID string 呼叫ID
meetObj MeetInfoObj 会议信息
usrExtDat string 自定义扩展参数
cookie string 自定义数据 (在回调时,回传给调用者)

开始进入视频会话。操作成功则回调AcceptCallSuccess,失败则回调AcceptCallFail

拒绝对方发起的呼叫

RejectCall(callID, usrExtDat, cookie)

  • 返回值:无
参数 类型 含义
callID string 呼叫ID
usrExtDat string 自定义扩展参数
cookie string 自定义数据 (在回调时,回传给调用者)

操作成功则回调RejectCallSuccess,失败则回调RejectCallFail

挂断呼叫

HungupCall(callID)

  • 返回值:无
参数 类型 含义
callID string 呼叫ID

操作成功则回调HangupCallSuccess,失败则回调HangupCallFail

呼叫/接收呼叫/拒绝呼叫/挂断呼叫回调函数

发起呼叫操作成功

CallSuccess.callback = function(callID ,cookie){}

  • 功能:呼叫他人操作成功响应

  • 参数

    • callID ----- 呼叫全局标识
    • cookie ----- 自定义用户数据

发起呼叫操作失败

CallFail.callback = function(callID,sdkEr,cookie){}

  • 功能:呼叫他人操作失败响应

  • 参数

    • callID ----- 呼叫全局标识
    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • cookie ----- 自定义用户数据

接受他人呼叫操作成功

AcceptCallSuccess.callback = function(callID,cookie){}

  • 功能:接受他人呼叫操作成功响应

  • 参数

    • callID ----- 呼叫全局标识
    • cookie ----- 自定义用户数据

接受他人呼叫操作失败

AcceptCallFail.callback = function(callID,sdkEr,cookie){}

  • 功能:接受他人呼叫操作失败响应

  • 参数

    • callID ----- 呼叫全局标识
    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • cookie ----- 自定义用户数据

拒绝他人的呼叫成功

RejectCallSuccess.callback = function(callID,cookie){}

  • 功能:拒绝他人的呼叫成功响应

  • 参数

    • callID ----- 呼叫全局标识
    • cookie ----- 自定义用户数据

拒绝他人的呼叫失败

RejectCallFail.callback = function(callID,sdkEr,cookie){}

  • 功能:拒绝他人的呼叫失败响应

  • 参数

    • callID ----- 呼叫全局标识
    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • cookie ----- 自定义用户数据

挂断他人的呼叫成功

HangupCallSuccess.callback = function(callID,cookie){}

  • 功能:挂断他人的呼叫成功响应

  • 参数

    • callID ----- 呼叫全局标识
    • cookie ----- 自定义用户数据

挂断他人的呼叫失败

HangupCallFail.callback = function(callID,sdkEr,cookie){}

  • 功能:挂断呼叫操作失败响应

  • 参数

    • callID ----- 呼叫全局标识
    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • cookie ----- 自定义用户数据

呼叫/接收呼叫/拒绝呼叫/挂断呼叫 通知

通知有人呼入

NotifyCallIn.callback = function(callID,meetObj,callerID,usrExtDat){}

  • 功能:SDK通知自己被呼叫

  • 参数

    • callID ----- 呼叫全局标识
    • meetObj ----- 会议信息
    • callerID ----- 呼叫人员的标识ID
    • usrExtDat ----- 自定义扩展参数

通知呼叫被对方接受

NotifyCallAccepted.callback = function(callID,meetObj,usrExtDat){}

  • 功能:SDK通知自己视频呼叫被对方接受

  • 参数

    • callID ----- 呼叫全局标识
    • meetObj ----- 会议信息
    • usrExtDat ----- 自定义扩展参数

通知呼叫被对方拒绝

NotifyCallRejected.callback = function(callID,sdkErr,usrExtDat){}

  • 功能:SDK通知自己呼叫被对方拒绝

  • 参数

    • callID ----- 呼叫全局标识
    • sdkErr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • usrExtDat ----- 自定义扩展参数

通知呼叫被对方挂断

NotifyCallHungup.callback = function(callID,usrExtDat){}

  • 功能:SDK通知自己呼叫被挂断

  • 参数

    • callID ----- 呼叫全局标识
    • usrExtDat ----- 自定义扩展参数

发送数据

发送小块数据

SendCmd(targetUserId, data)

  • 返回值:分配的任务ID(string)
参数 类型 含义
targetUserId string 目标用户ID
data string 发送的数据

一次性发送不会有进度通知,发送结果事件SendCmdRlst,SendCmd不能被CancelSend

发送大块数据(分块发送)

SendBuffer(targetUserId, data)

  • 返回值:分配的任务ID(string)
参数 类型 含义
targetUserId string 目标用户ID
data string 发送的数据

进度通知事件SendProgress,发送结果事件SendBufferRlst,取消发送CancelSend

取消数据发送

CancelSend(taskID)

  • 返回值:无
参数 类型 含义
taskID string 任务ID

取消数据发送 操作完成则回调CancelSendRlst

发送数据回调函数

发送小块数据

SendCmdRlst.callback = function(taskID,sdkEr,cookie){}

  • 功能:发送小块数据时,SDK通知发送结果

  • 参数

    • taskID ----- 发送任务id
    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • cookie ----- 自定义用户数据

发送大块数据

SendBufferRlst.callback = function(taskID,sdkEr,cookie){}

  • 功能:发送大块数据时,SDK通知发送结果

  • 参数

    • taskID ----- 发送任务id
    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • cookie ----- 自定义用户数据

发送数据时,通知发送进度

SendProgress.callback = function(taskID,sendedLen,totalLen,cookie){}

  • 功能:发送数据时,SDK通知发送进度

  • 参数

    • taskID ----- 发送任务id
    • sendedLen ----- 已发送的数据长度
    • totalLen ----- 需要发送的总长度
    • cookie ----- 自定义用户数据

取消发送响应

CancelSendRlst.callback = function(taskID,sdkEr,cookie){}

  • 功能:取消发送响应

  • 参数

    • taskID ----- 发送任务id
    • sdkEr ----- 操作失败代码,定义见CRVideo_ERR_DEF
    • cookie ----- 自定义用户数据

发送数据通知

通知收到小块数据

NotifyCmdData.callback = function(sourceUserId,data){}

  • 功能:SDK通知收到小块数据

  • 参数

    • sourceUserId ----- 数据来源的用户
    • data ----- 数据类型

通知收到大块数据

NotifyBufferData.callback = function(sourceUserId,data){}

  • 功能:SDK通知收到大块数据

  • 参数

    • sourceUserId ----- 数据来源的用户
    • data ----- 数据类型

掉线通知

通知自己掉线

LineOff.callback = function(sdkEr){}

  • 功能:SDK通知自己掉线

  • 参数

© Carter all right reserved,powered by Gitbook文件修订时间: 2019-08-08 14:04:58

results matching ""

    No results matching ""