呦呦色,欧美日韩视频一区二区,国产成人一区

| 開發者中心

新用戶指南 SDK文檔 Rest API IVR API 云通訊首頁

∨ ?Web開發文檔

開發指南

? 云通訊首頁>>開發者中心>>SDK文檔>>Web開發文檔

WEB IM SDK接口說明

本文檔主要為開發人員使用，介紹IM相關H5的接口，如無特別說明，所有方法的返回值均為object對象。

1、初始化SDK

方法	RL_YTX.init(appId,webserver,lvsServer,sig)
參數說明	參數名		必選	說明
	appId		是	應用appid，第三方注冊時分配
	webServer		否	(私有云)WebSocket服務器地址格式為 ip:port
	lvsServer		否	(私有云)附件下載服務器地址格式為 ip:port
	fileSig		否	(私有云)fileSig規則 MD5(公司ID+公司密碼)
返回值	obj	obj.code		調用結果
		obj.msg		消息提示
		obj.unsupport		不支持功能，數組類型，以錯誤碼形式返回

2、登陸

方法	RL_YTX.login(LoginBuilder, callback, onError)
參數說明	參數名	必選	說明
	LoginBuilder	是	RL_YTX. LoginBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(obj){ obj.authState; //Kick Off 是否被踢下線可為空 obj.kickoffText; //Kick Off 被踢下線的提示信息可為空 obj.connectorId; //鑒權成功后，返回連接器編號 obj.version; //服務器消息最大版本號 obj.pversion; //個人資料版本號 obj.softVersion; //軟件最新版本號 obj.historyver; //離線消息開始版本號 obj.authToken; //精簡認證Token }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

3、登出

方法	RL_YTX.logout(callback, onError)
參數說明	參數名	必選	說明
	callback	是	成功回調 function callback(){ }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

4、IM消息監聽

方法	RL_YTX. onMsgReceiveListener(callback)
參數說明	參數名	必選	說明
參數說明	callback	是	通知回調 function callback(obj){ obj.version; //消息版本號 obj.msgType; //消息類型1:文本消息 2:語音消息 3:視頻消息 4:圖片消息 5:位置消息 6:壓縮文件 7:非壓縮文件 11:群組發送@消息 12:狀態消息 obj.msgContent; //文本消息內容 obj.msgSender; //發送者 obj.msgReceiver; //接收者群組Im消息時，接收者為群組id obj.msgDomain; //擴展信息 obj.msgFileName; //消息文件名 obj.msgFileUrl; //消息下載地址 obj.msgDateCreated; //服務器接收消息時間 obj.senderNickName; //發送者昵稱 obj.mcmEvent;//是否MCM消息 0普通消息 1 start消息 2 end消息 53 發送mcm消息 obj.msgFileSize;//附件大小 obj.isAtMsg;//群組@類型消息 true/false }
返回值	無

5、多渠道消息監聽

方法	RL_YTX. onDeskMsgReceiveListener(callback)
參數說明	參數名	必選	說明
參數說明	callback	是	通知回調 function callback(obj){ obj.version; //消息版本號 obj.msgType; //消息類型1:文本消息 2:語音消息 3:視頻消息 4:圖片消息 5:位置消息 6:文件 obj.msgContent; //文本消息內容 obj.msgSender; //發送者 obj.msgReceiver; //接收者群組Im消息時，接收者為群組id obj.msgDomain; //擴展信息 obj.msgFileName; //消息文件名 obj.msgFileUrl; //消息下載地址 obj.msgDateCreated; //服務器接收消息時間 obj.senderNickName; //發送者昵稱 obj.mcmEvent; // mcm消息類型 1 start消息 2 end消息 3發送mcm消息 obj.msgFileSize;//附件大小 }
返回值	無

6、指令（群組通知）消息監聽

方法	RL_YTX. onNoticeReceiveListener(callback)
參數說明	參數名	必選	說明
參數說明	callback	是	通知回調，具體說明請參考附錄中的群組通知參數說明 function callback(obj){ obj.auditType;//1申請加入群組，2邀請加入群組， 3直接加入群組，4解散群組，5退出群組，6踢出群組，7確認申請加入，8確認邀請加入，10管理員修改群組信息， 11用戶修改群組成員名片) obj.groupId; //群組id obj.groupName; //群組名稱 obj.declared; //操作描述 obj.member; //成員賬號 obj.admin; //管理員賬號 obj.adminName; //管理員昵稱 obj.memberName; //成員昵稱 obj.confirm; //操作(1:拒絕2:同意注意:管理員邀請時1為同意) obj.version; //消息版本號 obj.serviceNo; //服務號 obj.ext; //擴展字段 }
返回值	無

7、連接狀態變更

方法	RL_YTX. onConnectStateChangeLisenter(callback)
參數說明	參數名	必選	說明
參數說明	callback	是	通知回調 function callback(obj){ obj.code;//變更狀態 1 斷開連接 2 重練中 3 重練成功 4 被踢下線 5 用戶被后臺踢掉（比如請求太頻繁，后臺把連接斷了） obj.msg;//消息提示 }
返回值	無

8、獲取個人消息

方法	RL_YTX. getMyInfo(callback, onError)
參數說明	參數名	必選	說明
	callback	是	成功回調 function callback(){ obj.version; //個人信息版本號 obj.nickName; //昵稱 obj.sex; //性別 1男 2女 obj.birth; //生日格式 2015-12-31 }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

9、設置個人信息

方法	RL_YTX. uploadPersonInfo(uploadPersonInfoBuilder,callback, onError)
參數說明	參數名	必選	說明
	UploadPersonInfoBuilder	是	RL_YTX.UploadPersonInfoBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(obj){ obj.version; //個人信息版本號 }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

10、發送消息

方法	RL_YTX.sendMsg(MsgBuilder, callback, onError)
參數說明	參數名	必選	說明
	MsgBuilder	是	RL_YTX. MsgBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(obj){ obj.msgId; //客戶傳入消息msgId（已廢棄） obj.msgClientNo // SDK生成的發送者消息id }
	onError	是	失敗回調 function onError(obj){ obj.code //錯誤碼 obj.msgId //客戶傳入消息msgId obj.msgClientNo // SDK生成的發送者消息id }
	progress	否	發送附件時的上傳進度回調 function progress(sended,,total,msgClientNo){ sended;//已發送字節數 total;//總字節數 msgClientNo;// SDK生成的發送者消息id }
返回值	無

11、創建群組

方法	RL_YTX. createGroup(CreateGroupBuilder, callback, onError)
參數說明	參數名	必選	說明
	CreateGroupBuilder	是	RL_YTX. CreateGroupBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(obj){ obj.data;//群組groupId }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

12、解散群組

方法	RL_YTX. dismissGroup(DismissGroupBuilder, callback, onError)
參數說明	參數名	必選	說明
	DismissGroupBuilder	是	RL_YTX. DismissGroupBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(){ }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

13、邀請用戶加入群組

方法	RL_YTX. inviteJoinGroup(InviteJoinGroupBuilder, callback, onError)
參數說明	參數名	必選	說明
	InviteJoinGroupBuilder	是	RL_YTX. InviteJoinGroupBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(){ }
	onError	是	邀請失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

14、處理群組邀請

方法	RL_YTX. confirmInviteJoinGroup(ConfirmInviteJoinGroupBuilder, callback, onError)
參數說明	參數名	必選	說明
	ConfirmInviteJoinGroupBuilder	是	RL_YTX. ConfirmInviteJoinGroupBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(){ }
	onError	是	處理失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

15、申請加入群組

方法	RL_YTX. joinGroup(JoinGroupBuilder, callback, onError)
參數說明	參數名	必選	說明
	JoinGroupBuilder	是	RL_YTX. JoinGroupBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(){ }
	onError	是	申請失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

16、處理加入申請

方法	RL_YTX. confirmJoinGroup(ConfirmJoinGroupBuilder, callback, onError)
參數說明	參數名	必選	說明
	ConfirmJoinGroupBuilder	是	RL_YTX. ConfirmJoinGroupBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(){ }
	onError	是	處理失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

17、退出群組

方法	RL_YTX. quitGroup(QuitGroupBuilder, callback, onError)
參數說明	參數名	必選	說明
	QuitGroupBuilder	是	RL_YTX. QuitGroupBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(){ }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

18、修改群組成員角色

方法	RL_YTX.setGroupMemberRole(SetGroupMemberRoleBuilder, callback, onError)
參數說明	參數名	必選	說明
	SetGroupMemberRoleBuilder	是	RL_YTX.SetGroupMemberRoleBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調function callback(){}
	onError	是	失敗回調失敗回調function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

19、踢出群組成員

方法	RL_YTX. deleteGroupMember(DeleteGroupMemberBuilder, callback, onError)
參數說明	參數名	必選	說明
	DeleteGroupMemberBuilder	是	RL_YTX. DeleteGroupMemberBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(){ }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

20、分頁獲取群組列表

方法	RL_YTX. getGroupList(GetGroupListBuilder, callback, onError)
參數說明	參數名	必選	說明
	GetGroupListBuilder	是	RL_YTX. GetGroupListBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(obj){ for(var i in obj){//群組列表數組 var simple = obj[i]; simple.groupId; //群組id simple.name; //群組名稱 simple.owner;//群組創建者 simple.permission;//群組權限 1：默認可直接加入 2：需要身份驗證 3:私有群組（不能主動加入，僅能管理員邀請） simple.isNotice; //是否提醒 1：提醒；2：不提醒 simple.memberCount;//群組人數 simple.scope;//群組規模 1：臨時組(上限100人) 2普通組(上限300人)3：普通組(上限500人) 4：付費普通組 (上限1000人) 5：付費VIP組（上限2000人） simple.dateCreated;//群組創建時間 simple.target;//群組模式 1討論組 2 普通群組 } }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

21、分頁獲取群組成員

方法	RL_YTX. getGroupMemberList(GetGroupMemberListBuilder, callback, onError)
參數說明	參數名	必選	說明
	GetGroupMemberListBuilder	是	RL_YTX. GetGroupMemberListBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(obj){ for(var i in obj){//群組成員列表 var member = obj[i]; member.member;//成員id member.nickName;//昵稱 member.speakState;//禁言狀態 1:不禁言 2:禁言 member.role;//角色 1:創建者 2:管理員 3：成員 member.sex;//性別 1:男 2：女 } }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

22、群組成員禁言

方法	RL_YTX. forbidMemberSpeak(ForbidMemberSpeakBuilder, callback, onError)
參數說明	參數名	必選	說明
	ForbidMemberSpeakBuilder	是	RL_YTX. ForbidMemberSpeakBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(){ }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

23、獲取群組成員名片

方法	RL_YTX. queryGroupMemberCard(QueryGroupMemberCardBuilder, callback, onError)
參數說明	參數名	必選	說明
	QueryGroupMemberCardBuilder	是	RL_YTX.QueryGroupMemberCardBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(obj){ obj.member; //成員id obj.groupid; //群組id obj.display; //成員昵稱 obj.phone; //成員手機號 obj.mail; //成員郵箱 obj.remark; //成員備注 obj.speakState; //成員禁言狀態 1:未禁言 2:禁言 obj.role; //成員角色 1:創建者 2:管理員 3：成員 obj.sex; //成員性別 1:男 2：女 }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

24、修改群組成員名片

方法	RL_YTX. modifyMemberCard (ModifyMemberCardBuilder, callback, onError)
參數說明	參數名	必選	說明
	ModifyMemberCardBuilder	是	RL_YTX. ModifyMemberCardBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(){ }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

25、搜索群組

方法	RL_YTX. searchGroups(SearchGroupsBuilder, callback, onError)
參數說明	參數名	必選	說明
	SearchGroupsBuilder	是	RL_YTX. SearchGroupsBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(obj){ for(var i in obj){//群組列表 var simple = obj[i]; simple.groupId; //群組id simple.name; //群組名稱 simple.owner;//群組創建者 simple.declared;//群組公告 simple.isNotice; //是否提醒 1：提醒；2：不提醒 simple.memberCount;//群組人數 simple.scope;//群組規模 1：臨時組(上限100人) 2普通組(上限300人)3：普通組(上限500人) 4：付費普通組 (上限1000人) 5：付費VIP組（上限2000人） } }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

26、獲取群組詳情

方法	RL_YTX. getGroupDetail(GetGroupDetailBuilder, callback, onError)
參數說明	參數名	必選	說明
	GetGroupDetailBuilder	是	RL_YTX. GetGroupDetailBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(obj){ obj.creator; //創建者 obj.groupName; //群組名稱 obj.type; //群組類型 obj.province; //省份 obj.city; //城市 obj.scope; //群組大小 obj.declared; //群組公告 obj.dateCreated; //創建時間 obj.numbers; //群組人數 obj.isNotice; //是否免打擾 obj.permission; //群組權限 1：默認可直接加入 2：需要身份驗證 3:私有群組（不能主動加入，僅能管理員邀請） obj.groupDomain; //擴展信息 obj.isApplePush; //是否蘋果離線推送 obj.target;//群組模式 1討論組 2普通群組 }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

27、修改群組信息

方法	RL_YTX. modifyGroup(ModifyGroupBuilder, callback, onError)
參數說明	參數名	必選	說明
	ModifyGroupBuilder	是	RL_YTX. ModifyGroupBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(){ }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

28、群組消息推送設置

方法	RL_YTX. setGroupMessageRule(SetGroupMessageRuleBuilder, callback, onError)
參數說明	參數名	必選	說明
	SetGroupMessageRuleBuilder	是	RL_YTX. SetGroupMessageRuleBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(){ }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

29、獲取解壓縮后的附件

方法	RL_YTX.getFileSource(url, callback, onError)
參數說明	參數名	必選	說明
	url	是	壓縮附件的服務器的位置
	callback	是	成功回調function callback(obj){ Obj.url //解壓縮或的附件的路徑 }
	onError	是	失敗回調失敗回調function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

30、獲取用戶在線狀態

方法	RL_YTX. getUserState(GetUserStateBuilder, callback, onError)
參數說明	參數名	必選	說明
	GetUserStateBuilder	是	RL_YTX. GetUserStateBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(obj){ obj.useracc;//用戶賬號 obj.state;//在線狀態 1:在線 2:離線當用戶為離線狀態時，obj.state,obj.network和obj.device為undefined obj.network;//被查詢人員的網絡狀態 1:WIFI 2:4G 3:3G 4:2G 5:INTERNET 6:other obj.device;//終端類型 1:Android 2:iPhone 10:iPad 11:Android Pad 20:PC 21:H5 }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

32、閱后即焚

方法	RL_YTX.deleteReadMsg(DeleteReadMsgBuilder, callback, onError)
參數說明	參數名	必選	說明
	DeleteReadMsgBuilder	是	RL_YTX. DeleteReadMsgBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(){ }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

33、閱后即焚操作通知

方法	RL_YTX.onMsgNotifyReceiveListener(callback)
參數說明	參數名	必選	說明
參數說明	callback	是	成功回調 function callback(obj){ obj.msgType;//消息類型 obj.sender;//刪除操作者 obj.msgId;//消息id obj.dateCreated;//創建時間 }
返回值	無

34、設置音視頻展示標簽

方法	RL_YTX.setCallView(view,localView)
參數說明	參數名	必選	說明
	view	是	對方視頻展示的HTML標簽
	localView	是	本地視頻展示的HTML標簽
備注	發起或接受音視頻消息前需要調用該接口

35、發送音視頻請求

方法	RL_YTX.makeCall(MakeCallBuilder, callback, onError)
參數說明	參數名	必選	說明
	MakeCallBuilder	是	RL_YTX.MakeCallBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(){ }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

36、接收音視頻請求

方法	RL_YTX.accetpCall(AcceptCallBuilder, callback, onError)
參數說明	參數名	必選	說明
	AcceptCallBuilder	是	RL_YTX.AcceptCallBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(){ }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

37、拒絕音視頻請求

方法	RL_YTX.rejectCall(RejectCallBuilder, callback, onError)
參數說明	參數名	必選	說明
	RejectCallBuilder	是	RL_YTX.RejectCallBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(){ }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

38、取消音視頻

方法	RL_YTX.releaseCall(ReleaseCallBuilder, callback, onError)
參數說明	參數名	必選	說明
	ReleaseCallBuilder	是	RL_YTX. ReleaseCallBuilder對象參考附錄中發送請求參數說明
	callback	是	成功回調 function callback(){ }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

39、音視頻消息通知

方法

RL_YTX.onCallMsgListener(callback)

參數說明

參數名

必選

說明

callback

是

function(obj){

obj.callId;

obj.caller;

obj.called;

obj.callType;//0 音頻 1 視頻

obj.userdata;//自定義參數

obj.state;//1 對方振鈴 2 呼叫中 3 被叫接受 4 呼叫失敗 5 結束通話 6有新的呼叫 7（被叫）已經建立音視頻連接

obj.reason;//失敗原因

obj.code;//狀態碼 200為成功，其他表示因本地原因無法接受音視頻請求(例如不支持音視頻)，具體原因請參照錯誤碼

}

40、準備拍照

方法	RL_YTX.photo.apply(obj, onCanPlay, onError)
參數說明	參數名	必選	說明
	obj	是	Object對象，obj.tag DOM對象，表示預覽圖片的video標簽
	onCanPlay	是	媒體流準備就緒，可以進行拍照的通知回調 function onCanPlay(){ }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

41、拍照

方法	RL_YTX.photo.make()
參數說明j	參數名		必選	說明
	ob	obj.code	是	操作狀態碼 200表示成功，其他為失敗
		obj.blob	否	拍照成功返回的blob對象
		obj.msg	否	操作失敗的錯誤信息

42、取消拍照

方法	RL_YTX.photo. cancel()
參數說明j	參數名		必選	說明
	ob	obj.code	是	操作狀態碼 200表示成功，其他為失敗

43、準備錄音

方法	RL_YTX.audio.apply(obj, onCanPlay, onError)
參數說明	參數名	必選	說明
	obj	是	Object對象，obj.tag DOM對象，表示預覽錄音的audio標簽
	onCanPlay	是	媒體流準備就緒，可以進行錄音的通知回調 function onCanPlay(){ }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

44、錄音

方法	RL_YTX.audio.make()
參數說明j	參數名		必選	說明
	ob	obj.code	是	操作狀態碼 200表示成功，其他為失敗
		obj.blob	否	錄音成功返回的blob對象
		obj.msg	否	操作失敗的錯誤信息

45、取消錄音

方法	RL_YTX.audio.cancel()
參數說明j	參數名		必選	說明
	ob	obj.code	是	操作狀態碼 200表示成功，其他為失敗

46、消息撤回

方法	RL_YTX. msgBack (MsgBackBuilder,callback,onError)
參數說明	參數名	必選	說明
	MsgBackBuilder	是	RL_YTX.MsgBackBuilder對象參考附錄中發送請求參數說明
	callback	是	操作狀態碼 200表示成功 function onCanPlay(){ }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

47、消息已讀

方法	RL_YTX. msgRead (MsgReadBuilder,callbacsk,onError)
參數說明	參數名	必選	說明
	MsgReadBuilder	是	RL_YTX.MsgReadBuilder對象參考附錄中發送請求參數說明
	callback	是	操作狀態碼 200表示成功，其他為失敗 function onCanPlay(){ }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

48、日志關閉

方法	RL_YTX.setLogClose()
返回值	無

49、進入聊天室

方法	RL_YTX.enterChatroom(EnterChatroomBuilder,callback,onerror)
參數說明	參數名	必選	說明
	EnterChatroomBuilder	是	RL_YTX. EnterChatroomBuilder對象參考附錄中發送請求參數說明
	callback	是	登錄成功回調function callback(obj){ obj.allSilence; //是否全員禁言 obj.creator; //房主ID obj.enterTime; //加入時間 obj.keepSilence; //是否被禁言 obj. notice; //提示信息 obj.onlineCount; //在線總人數 obj.roomExt; //房間拓展字段。需自行base64解密 obj.url//直播地址 obj.roomNickname; //房間名稱 obj.userRole //用戶角色（1 創建者 2 管理員 3 普通用戶）
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

50、退出聊天室

方法	RL_YTX.exitChatroom(exitChatroomBuilder,callback,onerror);
參數說明	參數名	必選	說明
	ExitChatroomBuilder	是	RL_YTX.ExitChatroomBuilder對象參考附錄中發送請求參數說明
	callback	是	登錄成功回調function callback(obj){ obj.code//錯誤代碼。200為成功 }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

51、獲取聊天室信息

方法	RL_YTX.fetchChatroomInfo(fetchChatroomInfoBuilder,callback,onerror);
參數說明	參數名	必選	說明
	FetchChatroomInfoBuilder	是	RL_YTX.FetchChatroomInfoBuilder對象參考附錄中發送請求參數說明
	callback	是	登錄成功回調function callback(obj){ obj.allSilence; //是否全員禁言 obj.creator; //房主ID obj.notice; //提示信息 obj.onlineCount; //在線總人數 obj.roomExt; //房間拓展字段。需自行base64解密 obj.roomNickname; //房間名稱
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

52、修改聊天室信息

方法	RL_YTX.updateChatroomInfo(updateChatroomInfoBuilder,callback,onerror);
參數說明	參數名	必選	說明
	UpdateChatroomInfoBuilder	是	RL_YTX. UpdateChatroomInfoBuilder對象參考附錄中發送請求參數說明
	callback	是	登錄成功回調function callback(obj){ obj.code//錯誤代碼。200為成功 }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

53、獲取聊天室成員

方法	RL_YTX.fetchChatroomMembers(fetchChatroomMembersBuilder,callback,onerror);
參數說明	參數名	必選	說明
	FetchChatroomMembersBuilder	是	RL_YTX.FetchChatroomMembersBuilder對象參考附錄中發送請求參數說明
	callback	是	登錄成功回調function callback(obj){ [arr.enterTime //加入時間 arr.infoExt//擴展字段 arr.muteDuration//禁言時長 arr.nickName//個人昵稱 arr.state// 1.禁言 2.取消禁言 3.拉黑 4.取消拉黑默認0 arr.userId //用戶id] }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

54、聊天室角色管理

方法	RL_YTX.updateChatRoomMemberRole(UpdateChatRoomMemberRoleBuilder,callback,onerror);
參數說明	參數名	必選	說明
	UpdateChatRoomMemberRoleBuilder	是	RL_YTX. UpdateChatRoomMemberRoleBuilder對象參考附錄中發送請求參數說明
	callback	是	登錄成功回調function callback(obj){ obj.code//錯誤代碼。200為成功 }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

55、踢出成員

方法	RL_YTX.kickMember(kickMemberBuilder,callback,onerror);
參數說明	參數名	必選	說明
	kickMember	是	RL_YTX. kickMember對象參考附錄中發送請求參數說明
	callback	是	登錄成功回調function callback(obj){ obj.code//錯誤代碼。200為成功 }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

56、聊天室全員禁言/解除禁言

方法	RL_YTX.AllMuteMode(allMuteBuilder,callbak,onerror)
參數說明	參數名	必選	說明
	AllMuteMode	是	RL_YTX.AllMuteMode對象參考附錄中發送請求參數說明
	callback	是	登錄成功回調function callback(obj){ obj.code//錯誤代碼。200為成功 }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

57、拉黑成員

方法	RL_YTX.defriendMember(defriendMemberBuilder,callback,onerror)
參數說明	參數名	必選	說明
	DefriendMemberBuilder	是	RL_YTX. DefriendMemberBuilder對象參考附錄中發送請求參數說明
	callback	是	登錄成功回調function callback(obj){ obj.code//錯誤代碼。200為成功 }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

58、禁言成員

方法	RL_YTX.forbidChatRoomMember(forbidChatRoomMemberBuilder,callback,onerror)
參數說明	參數名	必選	說明
	ForbidChatRoomMemberBuilder	是	RL_YTX. ForbidChatRoomMemberBuilder對象參考附錄中發送請求參數說明
	callback	是	登錄成功回調function callback(obj){ obj.code//錯誤代碼。200為成功 }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

59、修改個人信息

方法	RL_YTX.updateMyChatroomMemberInfo(updateMyChatroomMemberInfoBuilder,callback,onerror);
參數說明	參數名	必選	說明
	UpdateMyChatroomMemberInfoBuilder	是	RL_YTX. UpdateMyChatroomMemberInfoBuilder對象參考附錄中發送請求參數說明
	callback	是	登錄成功回調function callback(obj){ obj.code//錯誤代碼。200為成功 }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

60、消息置頂

方法	RL_YTX.setTopContact(setTopContactBuilder,callback,onError)
參數說明	參數名	必選	說明
	GetRecentContactListBuilder	是	RL_YTX. GetRecentContactListBuilder對象參考附錄中發送請求參數說明
	callback	是	登錄成功回調function callback(obj){ obj.code//錯誤代碼。200為成功 }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

61、獲取置頂列表

方法	RL_YTX. getTopContact (callback,onError)
參數說明	參數名	必選	說明
	callback	是	成功回調function callback(arr){ //返回值為置頂聯系人賬號數組 }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

63、播放AMR音頻文件

方法	RL_YTX.getAudioSource(msgFileUrl,callback,onError)
參數說明	參數名	必選	說明
	msgFileUrl	是	服務器推送的amr文件url
	callback	是	登錄成功回調function callback(obj){ //返回值為可播放的amr音頻地址 }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
返回值	無

64、聊天室通知消息

方法	RL_YTX. onCharRoomEventLinstener (callback)
參數說明	參數名	必選	說明
	callback	是	登錄成功回調function callback(obj){ if(obj.type === 1){//有用戶加入 }else if(obj.type === 2){//修改聊天室通知 }else if(obj.type === 3){//設置角色通知 }else if(obj.type === 4){//有用戶被踢出 }else if(obj.type === 5){//有用戶退出 }else if(obj.type === 6 ){// 全員禁言 }else if(obj.type === 7){//聊天室全員取消禁言 }else if(obj.type === 8){//單人禁言 }else if(obj.type === 9){//成員取消禁言 }else if(obj.type === 10){//拉入黑名單 }else if (obj.type === 11){//成員取消拉黑 }else if(obj.type === 12){//聊天室關閉 }else if(obj.type === 14){//修改聊天室信息 } }
	onError	是	失敗回調 function onError(obj){ obj. code //錯誤碼 obj.msg //錯誤描述 }
	返回值	無

61、附錄

（1）發送請求參數說明

所有的請求對象中，若無特殊說明，均有兩種初新建方式。
第一種為在初始化對象時對此參數直接賦值，
第二種為在初始化一個空對象后，使用setField的方式進行賦值
obj.setField方式可以將第一種新建對象的屬性值覆蓋
例：
MsgBuilder: RL_YTX. MsgBuilder含有6個屬性:
id(客戶端消息id 必選)
text:文本內容必選
file:附件對象必選
type:發送消息類型必選
receiver:接受者必選
domain:自定義字段可選
可使用
1: var builder = new RL_YTX.TextMsgBuilder(id, text,file,type, receiver, domain);
2: var builder = new RL_YTX.TextMsgBuilder();
builder. setId (id); //設置消息ID
builder. setText (text);//設置文本內容
builder.setFile(file);發送附件時的附件對象
builder.setType(type);發送消息類型
builder. setReceiver(id);//設置接收者
builder. setDomain (id);//設置自定義字段
兩種方式進行賦值
如無特殊說明，所有對象的set方法采用駝峰命名法。例如屬性名為_id，則set方法為setId

對象	屬性值			備注
對象	屬性名	必選	說明	備注
RL_YTX. LoginBuilder	type	是	1：完整帳號登錄 2：精簡認證 3：通訊帳號密碼登錄	當為通訊賬號登錄方式時，pwd為必選字段，且sig字段可不傳
	userName	是	用戶賬號或通訊賬號
	pwd	否	通訊密碼
	sig	是	登錄sig值，由頁面請求第三方服務器生成
	timestamp	是	登錄時間戳 yyyyMMddHHmmss格式
RL_YTX. MsgBuilder	id	是	客戶端消息id	text和file屬性最少有一個有值
	text	否	發送消息內容
	file	否	發送圖片或附件時的文件對象
	type	是	發送消息類型 1文本消息 2 語音消息 3 視頻消息 4 圖片消息 5 位置消息 6 壓縮文件消息 7 非壓縮文件消息 11 群組@消息 12 狀態消息
	receiver	是	消息接收者
	domain	否	自定義屬性
	fileName	否	文件名稱
RL_YTX.CreateGroupBuilder	groupName	是	群組名稱
	groupType	否	1: 同學 2: 朋友 3: 同事默認1
	province	否	群組省份
	city	否	群組城市
	scope	否	群組人數范圍 1 100人 2 300人 3 500人 4 1000人 5 2000人默認為1
	declared	否	群組描述
	permission	否	群組權限必選 1：默認可直接加入 2：需要身份驗證 3:私有群組（不能主動加入，僅能管理員邀請）默認為1
	mode	否	創建者退出，群組是否解散必選 1: 不解散 2: 解散默認1
	groupDomain	否	擴展信息
	target	否	1 討論組 2 普通群組默認為2
RL_YTX.DismissGroupBuilder	groupId	是	群組id
RL_YTX.InviteJoinGroupBuilder	groupId	是	群組id	members參數必須為數組
	declared	否	邀請理由
	members	是	邀請成員
	confirm	否	是否需要邀請者確認 1 不需要 2 需要默認為2
RL_YTX.ConfirmInviteJoinGroupBuilder	invitor	是	邀請者
	groupId	是	群組id
	confir	否	是否同意邀請 1 不同意 2同意默認為1
RL_YTX.QuitGroupBuilder	groupid	是	群組id
RL_YTX.GetGroupListBuilder	groupId	否	起始群組id
	pageSize	否	群組分頁大小默認50
	target	否	群組模式 -1 全部 1討論 2群組
RL_YTX.GetGroupMemberListBuilder	groupId	是	群組id
	memberId	否	起始群組成員id
	pageSize	否	成員分頁大小默認50
RL_YTX.JoinGroupBuilder	groupId	是	群組id
RL_YTX.JoinGroupBuilder	declared	否	申請理由
RL_YTX.ConfirmJoinGroupBuilder	groupId	是	群組id
	memberId	是	申請者id
	confirm	是	是否同意1不同意 2同意
RL_YTX.GetGroupDetailBuilder	groupId	是	群組id
RL_YTX.SearchGroupsBuilder	searchType	是	搜索類型 1群組id精確查找 2群組名稱模糊搜索
RL_YTX.SearchGroupsBuilder	keywords	是	搜索關鍵字
RL_YTX.DeleteGroupMemberBuilder	groupId	是	群組id
RL_YTX.DeleteGroupMemberBuilder	memberId	是	成員id
RL_YTX.ForbidMemberSpeakBuilder	groupId	是	群組id
	memberId	是	成員id
	forbidState	否	禁言狀態 1正常 2禁言默認為2
RL_YTX.SetGroupMessageRuleBuilder	groupId	是	群組id
	isNotice	否	是否免打擾 1提醒 2免打擾
	isApplePush	否	蘋果設備離線是否離線推送 1 推送 2 不推送
RL_YTX.QueryGroupMemberCardBuilder	memberId	是	成員id
RL_YTX.QueryGroupMemberCardBuilder	belong	是	群組id
RL_YTX.ModifyMemberCardBuilder	member	是	成語id
	belong	是	群組id
	display	否	修改后的昵稱
	phone	否	修改后的手機號
	mail	否	修改后的郵箱
	remark	否	修改后的備注
RL_YTX.ModifyGroupBuilder	groupId	是	群組id
	groupName	是	群組名稱
	type	否	群組類型 1: 同學 2: 朋友 3: 同事
	province	否	群組省份
	city	否	群組城市
	scope	否	群組規模 1：臨時組(上限100人) 2普通組(上限300人)3：普通組(上限500人) 4：付費普通組 (上限1000人) 5：付費VIP組（上限2000人）
	declared	否	群組公告
	permission	否	群組權限 1：默認可直接加入 2：需要身份驗證 3:私有群組（不能主動加入，僅能管理員邀請）
	groupDomain	否	自定義字段
RL_YTX.AttachMsgBuilder	id	是	客戶端消息id
	file	是	需要發送的附件，為HTML5中的File對象，獲取方式可參考附錄中：發送附件時file對象獲取
	type	是	附件類型。2語音消息 3 視頻消息 4圖片消息 5 位置消息 6文件消息
	receiver	是	消息接收者
	domain	否	自定義屬性
	sendType	否	發送類型 1 IM消息 2多渠道消息默認為1
RL_YTX. DeskMessageStartBuilder	osUnityAccount	是	客服號
RL_YTX. DeskMessageStartBuilder	userData	否	自定義字段
RL_YTX. DeskMessageBuilder	content	是	發送內容	content和file對象最少有一個有值
	file	是	需要發送的附件，為HTML5中的File對象，獲取方式可參考附錄中：發送附件時file對象獲取
	type	是	附件類型。2語音消息 3 視頻消息 4圖片消息 5 位置消息 6文件消息
	userData	是	用戶自定義屬性
	osUnityAccount	否	客服號
	msgId	否	用戶自定義消息id（已廢棄）
	fileName	否	文件名稱
RL_YTX. DeskMessageStopBuilder	osUnityAccount	是	客服號
RL_YTX. DeskMessageStopBuilder	userData	否	自定義字段
RL_YTX.UploadPersonInfoBuilder	nickName	是	用戶昵稱
	sex	否	用戶性別 1:男 2:女默認為1
	birth	否	用戶生日 yyyy-MM-dd格式
	Sign	否	用戶簽名，最大100個漢字
RL_YTX.GetUserStateBuilder	useracc	是	查詢用戶賬號
DeleteReadMsgBuilder	msgid	是	消息接受者收到的msgid
RL_YTX.MakeCallBuilder	called	是	被叫賬號或手機號
	callType	是	呼叫類型 0 音頻 1 音視頻
	nickname	否	網絡電話顯示的昵稱
RL_YTX.AcceptCallBuilder	voipCallId	是	請求的callId
RL_YTX.AcceptCallBuilder	caller	是	請求主叫號碼
RL_YTX.RejectCallBuilder	voipCallId	是	請求的callId
RL_YTX.RejectCallBuilder	caller	是	請求主叫號碼
RL_YTX.ReleaseCallBuilder	voipCallId	是	請求的callId
	caller	是	請求主叫號碼
	called	是	請求被叫號碼
RL_YTX.EnterChatroomBuilder	roomId	是	聊天室ID，用于加入聊天室
	nickName	是	加入聊天室攜帶的昵稱
	infoExt	否	加入聊天室攜帶的拓展字段
	needNotify	否	是否需要通知，（1、不通知，2、通知。默認為2）
	notifyExt	否	通知拓展字段
RL_YTX.ExitChatroomBuilder	roomId	是	聊天室ID	text和file屬性最少有一個有值
	needNotify	否	是否需要通知，（1、不通知，2、通知。默認為2）
	notifyExt	否	通知拓展字段。
RL_YTX.FetchChatroomInfoBuilder	roomId	是	聊天室ID
RL_YTX. UpdateChatroomInfoBuilder	roomId	是	聊天室ID	roomName，announcement，roomExt，allMuteMode最少有一個有值
	roomName	否	修改房間名稱
	announcemen	否	修改房間公告
	roomExt	否	房間信息擴展字段
	allMuteMode	否	是否全員禁言 1 不是 2 是
	needNotify	否	是否需要通知, 1 不通知 2 通知 (默認2)
	notifyExt	否	通知信息擴展字段
RL_YTX. UpdateMyChatroomMemberInfoBuilder	roomId	是	聊天室ID	nickName和infoExt至少要設置一個
	nickName	否	個人昵稱
	infoExt	否	個人信息擴展字段
RL_YTX. UpdateChatRoomMemberRoleBuilder	roomId	是	聊天室ID，用于加入聊天室
	userId	是	用戶id
	type	是	角色類型 1 創建者 2 管理員 3 普通成員
	needNotify	否	是否需要通知，（1、不通知，2、通知。默認為2）
	notifyExt	否	通知拓展字段
RL_YTX. KickMemberBuilder	roomId	是	聊天室ID，用于加入聊天室
	userIds	是	用戶數組id[“id1”,”id2”] 僅管理員可以踢人；如userId是管理員僅創建者可以踢.
	needNotify	否	是否需要通知，（1、不通知，2、通知。默認為2）
	notifyExt	否	通知拓展字段
RL_YTX. AllMuteMode	roomId	是	聊天室ID，用于加入聊天室
	allMuteMode	是	是否全員禁言 1 不是 2 是
	needNotify	否	是否需要通知，（1、不通知，2、通知。默認為2）
	notifyExt	否	通知拓展字段
RL_YTX. DefriendMemberBuilder	roomId	是	聊天室ID，用于加入聊天室
	userIds	是	用戶數組id 僅管理員可以拉黑；如userId是管理員僅創建者可以拉黑.
	state	是	1拉黑 2取消拉黑默認2
	needNotify	否	是否需要通知，（1、不通知，2、通知。默認為2）
	notifyExt	否	通知拓展字段
RL_YTX. ForbidChatRoomMemberBuilder	roomId	是	聊天室ID，用于加入聊天室
	userIds	是	用戶數組id 僅管理員可以禁言；如userId是管理員僅創建者可以禁言.
	state	是	1禁言 2取消禁言(默認2)
	muteDuration	是	單位：秒
	needNotify	否	是否需要通知，（1、不通知，2、通知。默認為2）
	notifyExt	否	通知拓展字段

（2）發送附件時file對象獲取

Html:
<html>
  <body>
     <input type=”file” id=”_file” />
  </body>
</html>
JS:
var file = document.getElementById("_file").files[0];

（3）群組通知參數說明

在下發群組通知時，有些參數是無值的，用戶需要進行判空操作，當為空時，用戶需要自己進行處理提示信息
groupId,groupName 必有值
auditType :
1 用戶申請加入需要驗證的群組時，群主或管理員接收此類型消息，
member,memberName有值declare可能有值
2 群主或管理員邀請用戶直接加入群組時，被邀請者接收此類型消息，
admin,adminName ,confrim有值declare可能有值
此時 confrim為1表示用戶直接加入群組，2表示需用戶處理該請求
3 用戶加入不需要驗證的群組，群組成員接收此類型消息，
member，memberName有值
4 群主或管理員解散群組時，群組成員接收此類型消息，admin有值
5 用戶退出群組時，群組成員接收此類型消息，member，memberName有值
6 群主或管理員踢出用戶時，群組成員接收此類型消息，member有值
7 群主或管理員同意用戶申請加入群組操作時，群組成員接收此類型消息，
member,memberName,confirm有值
8 用戶同意群組邀請，或管理員邀請用戶加入群組(不需要被邀請者確認)時，
群組內其他成員接收此類型消息，
member,memberName,confirm有值
9 群主或管理員修改群組信息時，群組其他成員接收此類型消息，
admin字段有值ext可能有值
10 群組成員名片被修改時，修改者之外的群組用戶接收此類型消息，
member,memberName有值,ext可能有值
如果是管理員修改成員名片admin有值
11 討論組管理員變更時，操作者之外的其他成員收到該類型消息
12 群組管理員變更時，操作者之外的其他成員收到該類型消息
ext字段說明:
json格式字符串，修改群組信息或成員名片后的最新字段,變更了哪些字段，返回哪些字段，群組名和用戶名由外層的groupName,memberName標識
{
groupDeclared:declared,(群公告)
groupType:1,(群組type類型)
groupProvince:bj,(群組省份)
groupCity:bj,(群組城市)
groupScope:2,(群組scope)
groupPermission:1,(群組權限)
email:19274829@qq.com,(用戶郵箱)
phone:18210234584,(用戶手機號)
remark:'test'(用戶備注)
}

av一区二区三区在线观看_久久久久国产一区二区三区_伊人春色在线播放_欧美亚洲国产一区_九九热在线免费视频_久久视频国产