agoraRTM

接口

createInstance

初始化sdk

createInstance({params}, callback(ret,err))

params

appId:

  • 类型:字符串
  • 描述:(必填项) Agora 为 App 开发者签发的 APP ID。如果你的开发包里没有 App ID,请从声网申请一个新的 App ID。

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code: -1, //错误码
    msg : '' //错误描述信息
}

示例代码

var obj = api.require('agoraRTM');
obj.createInstance({
    appId : '1212222'
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

addEventListener

设置事件回掉

addEventListener(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    evenType: '',   //onConnectionStateChanged 系统的连接状态发生改变回调。
    //onMessageReceived 收到点对点消息回调
    //onTokenExpired Token 已超过 24 小时的签发有效期
    //onPeersOnlineStatusChanged 被订阅用户在线状态改变回调
    state : '',//新连接状态 详见 ConnectionState。
    reason : '',//连接状态改变原因 详见 ConnectionChangeReason 。
    peerId : '',//消息发送者的用户 ID
    message : { //被接收的消息。详见 RtmMessage 。
       messageType : '',
       text : '',
       serverReceivedTs : '',
       isOfflineMessage : '',
    },
    peersStatus : {//用户在线状态列表。详见 PeerOnlineState 。
    },
}

示例代码

var obj = api.require('agoraRTM');
obj.addEventListener(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

removeEventListener

移除事件回掉

removeEventListener()

示例代码

var obj = api.require('agoraRTM');
obj.removeEventListener();

可用性

iOS、Android系统

可提供的1.0.0及更高版本

login

登录

login({params},callback(ret, err))

params

token:

  • 类型:字符串
  • 描述:(可选项)用于登录 Agora RTM 系统的动态密钥。开启动态鉴权后可用。集成及测试阶段请将 token 设置为 null。

userId:

  • 类型:字符串
  • 描述:(必填项)登录 Agora RTM 系统的用户 ID。该字符串不可超过 64 字节或以空格开头。

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code: -1, //错误码
    msg : '' //错误描述信息
}

示例代码

var obj = api.require('agoraRTM');
obj.login({
    userId : '1212222'
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

logout

登出

logout(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code: -1, //错误码
    msg : '' //错误描述信息
}

示例代码

var obj = api.require('agoraRTM');
obj.logout(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

unInitialize

销毁实例(释放当前 RtmClient 实例使用的所有资源。)

unInitialize(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code: -1, //错误码
    msg : '' //错误描述信息
}

示例代码

var obj = api.require('agoraRTM');
obj.unInitialize(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

sendMessageToPeer

发送点对点文本消息

sendMessageToPeer({params},callback(ret, err))

params

peerId:

  • 类型:字符串型
  • 描述:(必填项)接收者的用户 ID

message:

  • 类型:字符串型
  • 描述:(必填项)需要发送的消息

enableOffline:

  • 类型:布尔型
  • 描述:(可选项)是否设置为离线消息。(true: 将该消息设为离线消息。 false: 不将该消息设为离线消息。)
  • 默认值:false

enableHistorical:

  • 类型:布尔型
  • 描述:(可选项)是否保存为历史消息。(true: 将该消息保存为历史消息。 false: 不将该消息保存为历史消息。)
  • 默认值:false

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code: -1, //错误码
    msg : '' //错误描述信息
}

示例代码

var obj = api.require('agoraRTM');
obj.sendMessageToPeer(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

queryPeersOnlineStatus

查询用户状态

queryPeersOnlineStatus({params}, callback(ret, err))

params

peerIds:

  • 类型:数组型
  • 描述:(必填项)用户 ID 列表

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
    data : {...}
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code: -1, //错误码
    msg : '' //错误信息
}

示例代码

var obj = api.require('agoraRTM');
obj.queryPeersOnlineStatus({
    peerIds : ['12','232']
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

subscribePeersOnlineStatus

订阅指定单个或多个用户的在线状态

subscribePeersOnlineStatus({params}, callback(ret, err))

params

peerIds:

  • 类型:数组型
  • 描述:(必填项)用户 ID 列表

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code: -1, //错误码
    msg : '' //错误信息
}

示例代码

var demo = api.require('agoraRTM');
demo.subscribePeersOnlineStatus({
    peerIds: ['','']
}, function(ret, err) {
    alert(JSON.stringify(ret)+"  "+JSON.stringify(err));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

unsubscribePeersOnlineStatus

退订指定单个或多个用户的在线状态

unsubscribePeersOnlineStatus({params},callback(ret, err))

params

peerIds:

  • 类型:数组型
  • 描述:(必填项)用户 ID 列表

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code: -1, //错误码
    msg : '' //错误信息
}

示例代码

var demo = api.require('agoraRTM');
demo.unsubscribePeersOnlineStatus({
    peerIds : ['','']
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

queryPeersBySubscriptionOption

获取某特定内容被订阅的用户列表

queryPeersBySubscriptionOption({params}, callback(ret, err))

params

option:

  • 类型:数字型
  • 描述:(可选项) 被订阅的类型 (0: 订阅指定用户的在线状态。)
  • 默认值:0

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
    data : {...}
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code: -1, //错误码
    msg : '' //错误信息
}

示例代码

var obj = api.require('agoraRTM');
obj.queryPeersBySubscriptionOption(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

setLocalUserAttributes

全量设置本地用户的属性

setLocalUserAttributes({params}, callback(ret, err))

params

attribute :

  • 类型: JSON串
  • 描述:(必填项)待设置的属性

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code: -1, //错误码
    msg : '' //错误信息
}

示例代码

var obj = api.require('agoraRTM');
obj.setLocalUserAttributes({
    'test1': '12222'
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

addOrUpdateLocalUserAttributes

添加或更新本地用户的属性

addOrUpdateLocalUserAttributes({params}, callback(ret, err))

params

attribute :

  • 类型: JSON串
  • 描述:(必填项)待设置的属性

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

示例代码

var obj = api.require('agoraRTM');
obj.addOrUpdateLocalUserAttributes({
    'aaa','12333'
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

deleteLocalUserAttributesByKeys

删除本地用户的指定属性

deleteLocalUserAttributesByKeys({params},callback(ret, err))

params

attributeKeys :

  • 类型: 数组
  • 描述:(必填项)属性名列表

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    'code': -1,   //错误code.
    'msg' : '' //错误信息
}

示例代码

var obj = api.require('agoraRTM');
obj.deleteLocalUserAttributesByKeys({
    attributeKeys : ['','']
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

clearLocalUserAttributes

清空本地用户的属性

clearLocalUserAttributes(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    'code': -1,   //错误code.
    'msg' : '' //错误信息
}

示例代码

var obj = api.require('agoraRTM');
obj.clearLocalUserAttributes(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

getUserAttributes

获取指定用户的全部属性

getUserAttributes({params},callback(ret, err))

params

userId :

  • 类型: 字符串型
  • 描述:(必填项)用户ID

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
    data : {},
    userId : ''
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    'code': -1,   //错误code.
    'msg' : '' //错误信息
}

示例代码

var obj = api.require('agoraRTM');
obj.getUserAttributes({
    userId : ''
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

getUserAttributesByKeys

获取指定用户指定属性名的属性

getUserAttributesByKeys({params},callback(ret, err))

params

userId :

  • 类型: 字符串型
  • 描述:(必填项)用户ID

attributeKeys :

  • 类型: 数组
  • 描述:(必填项)属性名列表

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
    data : {},
    userId : ''
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    'code': -1,   //错误code.
    'msg' : '' //错误信息
}

示例代码

var obj = api.require('agoraRTM');
obj.getUserAttributesByKeys({
    userId : '',
    attributeKeys : ['','']
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

setChannelAttributes

全量设置某指定频道的属性

setChannelAttributes({params},callback(ret, err))

params

channelId :

  • 类型: 字符串型
  • 描述:(必填项)频道 ID

attribute :

  • 类型: JSON串
  • 描述:(必填项)频道属性列表

enableNotificationToChannelMembers :

  • 类型: 布尔型
  • 描述:(可选项)是否通知所有频道成员本次频道属性变更
  • 默认值:false

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    'code': -1,   //错误code.
    'msg' : '' //错误信息
}

示例代码

var obj = api.require('agoraRTM');
obj.setChannelAttributes({
    channelId : '',
    attribute : {...}
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

addOrUpdateChannelAttributes

全量设置某指定频道的属性

addOrUpdateChannelAttributes({params},callback(ret, err))

params

channelId :

  • 类型: 字符串型
  • 描述:(必填项)频道 ID

attribute :

  • 类型: JSON串
  • 描述:(必填项)频道属性列表

enableNotificationToChannelMembers :

  • 类型: 布尔型
  • 描述:(可选项)是否通知所有频道成员本次频道属性变更
  • 默认值:false

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    'code': -1,   //错误code.
    'msg' : '' //错误信息
}

示例代码

var obj = api.require('agoraRTM');
obj.addOrUpdateChannelAttributes({
    channelId : '',
    attribute : {...}
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

deleteChannelAttributesByKeys

删除某指定频道的指定属性

deleteChannelAttributesByKeys({params},callback(ret, err))

params

channelId :

  • 类型: 字符串型
  • 描述:(必填项)频道 ID

attributeKeys :

  • 类型: 数组
  • 描述:(必填项)频道属性列表

enableNotificationToChannelMembers :

  • 类型: 布尔型
  • 描述:(可选项)是否通知所有频道成员本次频道属性变更
  • 默认值:false

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    'code': -1,   //错误code.
    'msg' : '' //错误信息
}

示例代码

var obj = api.require('agoraRTM');
obj.deleteChannelAttributesByKeys({
    channelId : '',
    attributeKeys : ['','']
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

clearChannelAttributes

清空某指定频道的属性

clearChannelAttributes({params},callback(ret, err))

params

channelId :

  • 类型: 字符串型
  • 描述:(必填项)频道 ID

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    'code': -1,   //错误code.
    'msg' : '' //错误信息
}

示例代码

var obj = api.require('agoraRTM');
obj.clearChannelAttributes({
    channelId : '',
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

getChannelAllAttributes

获取某指定频道的全部属性

getChannelAllAttributes({params},callback(ret, err))

params

channelId :

  • 类型: 字符串型
  • 描述:(必填项)频道 ID

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
    data : {...}
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    'code': -1,   //错误code.
    'msg' : '' //错误信息
}

示例代码

var obj = api.require('agoraRTM');
obj.getChannelAllAttributes({
    channelId : '',
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

getChannelAttributesByKeys

获取某指定频道指定属性名的属性

getChannelAttributesByKeys({params},callback(ret, err))

params

channelId :

  • 类型: 字符串型
  • 描述:(必填项)频道 ID

attributeKeys :

  • 类型: 数组
  • 描述:(必填项)属性名列表

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
    data : {...}
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    'code': -1,   //错误code.
    'msg' : '' //错误信息
}

示例代码

var obj = api.require('agoraRTM');
obj.getChannelAttributesByKeys({
    channelId : '',
    attributeKeys : ['','']
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

getChannelMemberCount

查询单个或多个频道的成员人数

getChannelMemberCount({params},callback(ret, err))

params

channelIds :

  • 类型: 数组
  • 描述:(必填项)频道 ID 列表

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
    data : {...}
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    'code': -1,   //错误code.
    'msg' : '' //错误信息
}

示例代码

var obj = api.require('agoraRTM');
obj.getChannelMemberCount({
    channelId : '',
    attributeKeys : ['','']
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

createChannel

创建一个频道实例

createChannel({params},callback(ret, err))

params

channelId:

  • 类型:字符串
  • 描述:(必填项) Agora RTM 频道名称。

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code: -1, //错误码
    msg : '' //错误描述信息
}

示例代码

var obj = api.require('agoraRTM');
obj.createChannel({
    channelId : '1212222'
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

addChannelEventListener

设置渠道事件回掉

addChannelEventListener(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    evenType: '',   //onMemberCountUpdated 频道成员人数更新回调。
    //onAttributesUpdated 频道属性更新回调。返回所在频道的所有属性。
    //onMessageReceived 收到频道消息回调
    //onMemberJoined 远端用户加入频道回调
    //onMemberLeft 频道成员离开频道回调
    memberCount : 0,
    data : {//
    
    },
    message : {
    
    },
    channelId : '',
    userId : '',
}

示例代码

var obj = api.require('agoraRTM');
obj.addChannelEventListener(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

removeChannelEventListener

移除渠道事件回掉

removeChannelEventListener()

示例代码

var obj = api.require('agoraRTM');
obj.removeChannelEventListener();

可用性

iOS、Android系统

可提供的1.0.0及更高版本

joinChannel

用户加入频道

joinChannel(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    'code': -1,   //错误code.
    'msg' : '' //错误信息
}

示例代码

var obj = api.require('agoraRTM');
obj.joinChannel(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

leaveChannel

用户离开频道

leaveChannel(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    'code': -1,   //错误code.
    'msg' : '' //错误信息
}

示例代码

var obj = api.require('agoraRTM');
obj.leaveChannel(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

sendChannelMessage

发送频道消息

sendChannelMessage({params},callback(ret, err))

params

message :

  • 类型: 字符串
  • 描述:(必填项)待发送的消息

enableOffline :

  • 类型: 布尔型
  • 描述:(必填项)是否设置为离线消息。(true: 将该消息设为离线消息。 false: 不将该消息设为离线消息。)
  • 默认值:false

enableHistorical :

  • 类型: 布尔型
  • 描述:(必填项)是否保存为历史消息。(true: 将该消息保存为历史消息。false: 不将该消息保存为历史消息。)
  • 默认值:false

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    'code': -1,   //错误code.
    'msg' : '' //错误信息
}

示例代码

var obj = api.require('agoraRTM');
obj.sendChannelMessage({
    message : '',
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

unChannelInitialize

销毁频道实例

unChannelInitialize(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code: -1, //错误码
    msg : '' //错误描述信息
}

示例代码

var obj = api.require('agoraRTM');
obj.unChannelInitialize(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

getChannelMembers

获取频道成员列表

getChannelMembers(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
    data : {...}
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    'code': -1,   //错误code.
    'msg' : '' //错误信息
}

示例代码

var obj = api.require('agoraRTM');
obj.getChannelMembers(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

getRtmCallManager

获取一个呼叫邀请管理器对象

getRtmCallManager(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code: -1, //错误码
    msg : '' //错误描述信息
}

示例代码

var obj = api.require('agoraRTM');
obj.getRtmCallManager(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

addCallEventListener

设置Call事件回掉

addCallEventListener(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    evenType: '',   //onLocalInvitationReceivedByPeer 返回给主叫:被叫已收到呼叫邀请。
    //onLocalInvitationAccepted 返回给主叫:被叫已接受呼叫邀请。
    //onLocalInvitationRefused 返回给主叫:被叫已拒绝呼叫邀请。
    //onLocalInvitationCanceled 返回给主叫:呼叫邀请已被取消。
    //onLocalInvitationFailure 返回给主叫:呼叫邀请进程失败。
    //onRemoteInvitationReceived 返回给被叫:收到一个呼叫邀请。
    //onRemoteInvitationAccepted 返回给被叫:接受呼叫邀请成功。
    //onRemoteInvitationRefused 返回给被叫:拒绝呼叫邀请成功。
    //onRemoteInvitationCanceled 返回给被叫:主叫已取消呼叫邀请。
    //onRemoteInvitationFailure 返回给被叫:来自主叫的呼叫邀请进程失败。
    calleeId : '',
    callerId : '',
    content : '',
    channelId : '',
    response : '',
    state : '',
    message : '',
    errorCode : '',
    
}

示例代码

var obj = api.require('agoraRTM');
obj.addCallEventListener(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

removeCallEventListener

移除Call事件回掉

removeCallEventListener()

示例代码

var obj = api.require('agoraRTM');
obj.removeCallEventListener();

可用性

iOS、Android系统

可提供的1.0.0及更高版本

sendLocalInvitation

发送呼叫邀请给对方

sendLocalInvitation({params},callback(ret, err))

params

calleeId :

  • 类型: 字符串
  • 描述:(必填项)被呼叫者的 user ID

channelId :

  • 类型: 字符串
  • 描述:(可选项)频道 ID

content :

  • 类型: 字符串
  • 描述:(可选项)可选内容

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    'code': -1,   //错误code.
    'msg' : '' //错误信息
}

示例代码

var obj = api.require('agoraRTM');
obj.sendLocalInvitation({
    calleeId : '',
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

cancelLocalInvitation

取消给对方的呼叫邀请

cancelLocalInvitation({params},callback(ret, err))

params

calleeId :

  • 类型: 字符串
  • 描述:(必填项)被呼叫者的 user ID

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    'code': -1,   //错误code.
    'msg' : '' //错误信息
}

示例代码

var obj = api.require('agoraRTM');
obj.cancelLocalInvitation({
    calleeId : '',
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

acceptRemoteInvitation

接受来自对方的呼叫邀请

acceptRemoteInvitation({params},callback(ret, err))

params

callerId :

  • 类型: 字符串
  • 描述:(必填项)被呼叫者的 user ID

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    'code': -1,   //错误code.
    'msg' : '' //错误信息
}

示例代码

var obj = api.require('agoraRTM');
obj.cancelLocalInvitation({
    callerId : '',
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

refuseRemoteInvitation

拒绝来自对方的呼叫邀请

refuseRemoteInvitation({params},callback(ret, err))

params

callerId :

  • 类型: 字符串
  • 描述:(必填项)被呼叫者的 user ID

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    'code': -1,   //错误code.
    'msg' : '' //错误信息
}

示例代码

var obj = api.require('agoraRTM');
obj.refuseRemoteInvitation({
    callerId : '',
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

renewToken

更新当前的 RTM Token。

renewToken({params},callback(ret, err))

params

token :

  • 类型: 字符串
  • 描述:(必填项)token

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    'code': -1,   //错误code.
    'msg' : '' //错误信息
}

示例代码

var obj = api.require('agoraRTM');
obj.renewToken({
    token : '',
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

getSdkVersion

获取 SDK 版本

getSdkVersion()

ret

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true
    sdkVersion : ''
}

示例代码

var obj = api.require('agoraRTM');
var ret = obj.getSdkVersion();
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

是否仍需要帮助? 请保持联络!
最后更新于 2024/05/20