rongCloudIM

来自于：融云官方立即使用

• Method
• Constant

注意事项:

使用该模块需要在config.xml中进行如下配置(可参考：https://docs.apicloud.com/Dev-Guide/app-config-manual#35-2)：：)

<intent-filter>
    <action name="android.intent.action.VIEW"/>
    <category name="android.intent.category.DEFAULT"/>
    <data scheme="rong" host="io.rong.fast" pathPrefix="/conversation/"/>
</intent-filter>
<intent-filter>
   <action name="android.intent.action.VIEW" />
   <category name="android.intent.category.DEFAULT" />
   <data host="你的包名" path="/conversationlist" scheme="rong" />
</intent-filter>
<intent-filter>
    <action name="android.intent.action.VIEW" />
    <category name="android.intent.category.DEFAULT" />
    <data host="你的包名" pathPrefix="/push_message" scheme="rong" />
</intent-filter>

其中 data中的host为集成应用的包名

初始化和连接

init configurationParameter connect disconnect logout setConnectionStatusListener getConnectionStatus getCurrentUserId

消息的接收和发送

sendTextMessage sendImageMessage sendVoiceMessage sendLocationMessage sendRichContentMessage sendCommandNotificationMessage sendCommandMessage setOnReceiveMessageListener getOfflineMessageDuration setOfflineMessageDuration searchConversations searchMessages

会话

getConversationList getTopConversationList getBlockedConversationList getConversationListByCount getConversation removeConversation clearConversations setConversationToTop

会话通知状态

getConversationNotificationStatus setConversationNotificationStatus disableLocalNotification

消息的读取和删除

getLatestMessages getHistoryMessages getHistoryMessagesByObjectName getRemoteHistoryMessages deleteMessages clearMessages clearMessagesUnreadStatus recallMessage setOnMessageRecalledListener getUnreadMentionedMessages

未读消息数

getTotalUnreadCount getUnreadCount getUnreadCountByConversationTypes

消息的状态

setMessageReceivedStatus setMessageExtra setMessageSentStatus sendTypingStatus addTypingStatusListener

消息回执

sendReadReceiptMessage addReceiveReadReceiptListener sendReadReceiptRequest sendReadReceiptResponse addReadReceiptListener removeReadReceiptListener

文字消息草稿

getTextMessageDraft saveTextMessageDraft clearTextMessageDraft

讨论组

createDiscussion getDiscussion setDiscussionName addMemberToDiscussion removeMemberFromDiscussion quitDiscussion setDiscussionInviteStatus

聊天室

joinChatRoom quitChatRoom

黑名单

addToBlacklist removeFromBlacklist getBlacklistStatus getBlacklist

消息通知免打扰

setNotificationQuietHours removeNotificationQuietHours getNotificationQuietHours

概述

rongCloudIM 是基于 rongCloud2 模块把音视频相关接口去掉的版本

融云 Rong Cloud 是国内首家专业的即时通讯云服务提供商，专注为互联网、移动互联网开发者提供即时通讯基础能力和云端服务。通过融云平台，开发者不必搭建服务端硬件环境，就可以将即时通讯、实时网络能力快速集成至应用中。

rongCloudIM 封装了融云即时通讯能力库 IMLib SDK 的 API，对融云的相关接口做了一一对应的封装，功能详情可参考目录。

使用 rongCloudIM 模块之前，请先 注册 融云的开发者帐号并申请创建 App，创建 App 后，可以在 开发者后台 获取 App Key 和 App Secret 用于开发。

开发前请先认真阅读相关的 融云开发文档和视频。

iOS 平台推送通知功能详解

本文主要介绍了使用融云 IM 时，何时会收到远程推送、如何使用远程推送、如何获取远程推送的内容。

何时会收到远程推

在使用远程推送之前，您需要先了解融云 SDK 的运行状态。

融云SDK的运行状态及其内容的接受

融云 SDK 根据 iOS App 运行的特性，主要有以下三种运行状态：

1、 前台状态 如字面意思，App 前台可见时模块处于前台状态。此时 App 使用融云的长连接通道来收发消息。

2、 后台活动状态 当 App 进入后台 2 分钟之内，模块于后台活跃状态。此时 App 使用融云的长连接通道接收消息。

3、 后台暂停状态当 App 进入后台 2 分钟之后或被杀进程或被冻结，模块处于后台暂停状态。此时融云的长连接通道会断开，融云 Server 会通过 APNs 将消息以远程推送的形式下发到客户端。 此状态下如果有人给该用户发送消息，融云的服务器会根据 deviceToken 和推送证书将消息发送到苹果推送服务器，苹果服务器会将该消息推送到客户端。

如何使用远程推送

此过程的 1-4 步骤请参考融云官方的 推送开发指南——如何使用远程推送。其中涉及到的 AppID即为 Bundle Identifie，与 APICloud 平台上的包名是同一个东西，在 APICloud 平台上应用的概览里可以查看。

1. 为 App 开启远程推送服务
2. 生成并上传 P12 证书
3. 融云开发者平台上传 p12 证书
4. 生成 provisioning profile 文件
5. 将 provisioning profile 文件上传 APICloud 平台
6. 在 APICloud 平台云编译出 ipa 安装包并安装（正式版发布到苹果商店，通过苹果商店下载安装）
7. 用户允许推送

以上步骤都已经实现后，还需要使用您 App 的用户允许通知，才能收到远程推送。您可以在设备的设置应用中，查看当前App是否允许通知。

如何获取远程推送的内容

远程推送内容的获取

点击通知栏的远程推送时，如果此时 App 已经被系统冻结，则APICloud会将本次推送的内容通过事件监听回调的方式交给开发者。具体使用如下：

api.addEventListener({
    name: 'noticeclicked'
}, function(ret) {
    if (ret && ret.value) {
        var result = ret.value;
    }
})

如果 App 未被系统冻结，则您在 setOnReceiveMessageListener 接口中可以捕获该消息，详情参考 setOnReceiveMessageListener 接口说明。

音视频通话推送功能详细请参考 VoIP 推送设置文档(1-6)。其中步骤6参考 APICloud 平台关于后台运行权限的配置。

android集成小米推送

• 集成小米推送需要依赖APICloud平台的mipush模块
• 在小米开发者平台申请应用，并将appid和appkey配置到init接口中
• 在小米开发者平台申请应用后，需要将APP Secret配置到融云控制台的应用标识中

android集成华为推送

• 集成华为推送需要依赖APICloud平台的huaweiPush模块，并在config中配置huaweiPush模块
• 在华为开发者平台申请应用，并将init接口中的huaweiPush参数设置为true
• 在华为开发者平台申请应用后，需要将华为的相关参数配置到融云控制台的应用标识中

注意

• 从3.1.5版本开始，android上点击推送过来的消息，开发者可以在appintent事件中接收到该消息的内容，可以从appParam参数的rong_params字段中获取；

模块接口

init

初始化融云 SDK，调用 connect 连接前务必保证调用此方法

调用前请在 config.xml 中设置内容如下：

<feature name="rongCloudIM">
    <param name="appKey" value="此处填写 App Key 值" />
</feature>

其中 value 的值请替换为您在融云开发者平台上申请的 App Key 值

init(params, callback(ret, err))

params

miPush:

• 类型：JSON对象
• 描述：(可选项)配置小米推送的信息
• 默认值：无

• 内部字段：

  appId:  //字符串类型；小米后台申请的appid
  appKey: //字符串类型；小米后台申请的appKey

huaweiPush:

• 类型：布尔类型
• 描述：(可选项) 是否集成华为推送
• 默认值：false

callback(ret, err)

ret:

• 类型：JSON 对象
• 描述：初始化的状态，如果 config.xml 中没有设置 appKey 值，会导致失败，错误信息为参数错误
• 内部字段：

{
    status: 'success', // 状态码：success / error
}

err:

• 类型：JSON 对象
• 内部字段：

{
    code: -10002    // 错误码
}

错误说明：

示例代码

var rong = api.require('rongCloudIM');
rong.init(function(ret, err) {
    if (ret.status == 'error')
        api.toast({ msg: err.code });
});

可用性

iOS 系统，Android 系统

可提供的 1.0.0 及更高版本

configurationParameter

配置推送相关参数

configurationParameter({params})

params

alertTitle:

• 类型：字符串
• 默认值：您收到了一条新消息
• 描述：进入后台两分钟内收到通知的显示内容，不传则显示消息内容

showNickname：

• 类型：布尔
• 默认值：false
• 描述：推送提示是否显示昵称，注：设置昵称的方式为：在发送消息接口的extra字段中填写昵称信息，格式为extra:{userInfo:{nickName:”用户昵称”}}

示例代码

var rong = api.require('rongCloudIM');
rong.configurationParameter({
});

可用性

iOS 系统，Android 系统

可提供的 1.0.0 及更高版本

connect

连接融云 IM 服务器，进行后续各种方法操作前务必要先调用此方法

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

params

token:

• 类型：字符串
• 默认值：无
• 描述：从服务端获取的用户身份令牌（Token）

callback(ret, err)

ret:

• 类型：JSON 对象
• 描述：返回的登录成功或者失败的状态
• 内部字段：

{
    status: 'success', // 状态码：success / error
    result:
    {
        userId: '9527' // 当前登录的用户 Id
    }
}

err:

• 类型：JSON 对象
• 内部字段：

{
    code: 31004    // 错误码
}

错误说明：

示例代码

var rong = api.require('rongCloudIM');
rong.init(function(ret, err) {
    if (ret.status == 'error')
        api.toast({ msg: err.code });
});
rong.connect({
    token: 'ThptTWyiPPPvZHvuSiuri82yq+hfEluLjZ78E1qo4hEVSFQNpqdoPu406urMWKN4Z3/olWR+v9JVLAwfOQoLrA=='},function(ret, err) {
    if (ret.status == 'success') api.toast({ msg: ret.result.userId });
});

可用性

iOS 系统，Android 系统

可提供的 1.0.0 及更高版本

disconnect

断开连接

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

params

isReceivePush:

• 类型：布尔
• 默认值：true
• 描述：断开后是否接收 Push

callback(ret)

ret:

• 类型：JSON 对象
• 描述：返回的断开连接成功或者失败的状态
• 内部字段：

{
    status: 'success' // 状态码：success
}

示例代码

var rong = api.require('rongCloudIM');
// 之前调用 init 和 connect 的代码省略
rong.disconnect({
    isReceivePush: true
}, function(ret, err) {
    if ('success' == ret.status) {
        api.toast({ msg: '断开连接成功!' });
    }
}); // 断开，且不再接收 Push

可用性

iOS 系统，Android 系统

可提供的 1.0.0 及更高版本

setConnectionStatusListener

设置连接状态变化的监听器，请在调用 init 方法之后，调用 connect 方法之前设置

setConnectionStatusListener(callback(ret, err))

callback(ret)

ret:

• 类型：JSON 对象
• 描述：连接服务器的回调返回值，参见 连接状态
• 内部字段：

{
    result:
    {
        connectionStatus: 'CONNECTED' // 连接状态
    }
}

示例代码

var rong = api.require('rongCloudIM');
// 之前调用 init 的代码省略
rong.setConnectionStatusListener(function(ret, err) {
    api.toast({ msg: ret.result.connectionStatus });
});
// 之后调用 connect 的代码省略

可用性

iOS 系统，Android 系统

可提供的 1.0.0 及更高版本

sendTextMessage

发送文字消息

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

params

conversationType:

• 类型：字符串
• 默认值：无
• 描述：消息的会话类型，通过改变消息会话类型，可以发送单聊消息、讨论组消息、群聊消息、聊天室消息等，参见 会话类型

targetId:

• 类型：字符串
• 默认值：无
• 描述：消息的接收方 Id。根据不同的 conversationType，可能是用户 Id、讨论组 Id、群组 Id 或聊天室 Id 等

text:

• 类型：字符串
• 默认值：无
• 描述：消息的文字内容

extra:

• 类型：字符串
• 默认值：无
• 描述：消息的附加信息

mentionedInfo:

• 类型：JSON类型
• 默认值：无 (可选)
• 描述：@功能，当conversationType为GROUP或DISCUSSION有效；(ios不支持DISCUSSION)；注：＠ 消息推送会越过所有免打扰逻辑，给用户推送 Push 通知。
• 内部字段：

type:"all"   //(可选项) 字符串类型；@消息类型，默认值：all；取值范围：(all，part);all为@群组里所有人；part为@部分人，
userIdList:['123'] //字符串类型的数组；用户id；当type为part时，需要填写此字段；

callback(ret, err)

ret:

• 类型：JSON 对象
• 描述：返回的消息内容。发送准备时，提供所有消息信息；之后，result 中将只返回 message.messageId 等必要相关的内容
• 内部字段：

发送准备：

{
    status: 'prepare', // 状态码：prepare / success / error
    result:
    {
        message:
        {
            content: {
                text: 'Hello world!',
                extra: ''
            }, // 消息内容
            readReceiptInfo:{   // 注：如果此字段无值，则返回空
               hasRespond:true,          //是否已经发送回执
               isReceiptRequestMessage:true,//是否需要回执消息
               userIdList:{},       //发送回执的用户ID列表 (android不支持)
               userIds:[]      //json数组类型；发送回执的用户ID和时间戳列表 (ios不支持)
            },
          extra: '',
            conversationType: 'PRIVATE', // 参见 会话类型 枚举
            messageDirection: 'SEND', // 消息方向：SEND 或者 RECEIVE
            targetId: '16', // 接收者 Id
            objectName: 'RC:TxtMsg', // 消息类型，参见 http://docs.rongcloud.cn/android_message.html#_内置内容类消息
            sentStatus: 'SENDING', // 发送状态：SENDING, SENT 或 FAILED
            senderUserId: '55', // 发送者 userId
            messageId: 608, // 本地消息 Id
            sentTime: 1418971531533, // 发送消息的时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
            receivedTime: 0, // 收到消息的时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
            messageUId: ''   //消息UID，如果无则显示空字符串
        }
    }
}

成功：

{
    status: 'success', // 状态码：prepare / success / error
    result:
    {
        message:
        {
            messageId: 608 // 本地消息 Id
        }
    }
}

失败：

{
    status: 'error', // 状态码：prepare / success / error
    result:
    {
        message:
        {
            messageId: 608 // 本地消息 Id
        }
    }
}

err:

• 类型：JSON 对象

内部字段：

{
    code: 30003
}

状态码说明：

示例代码

var rong = api.require('rongCloudIM'); 
// 之前调用 init 和 connect 的代码省略
rong.sendTextMessage({
    conversationType: 'PRIVATE',
    targetId: '9527',
    text: 'Hello world.',
    extra: ''
}, function(ret, err) {
    if (ret.status == 'prepare')
        api.toast({ msg: JSON.stringify(ret.result.message) });
    else if (ret.status == 'success')
        api.toast({ msg: ret.result.message.messageId });
    else if (ret.status == 'error')
        api.toast({ msg: err.code });
});

可用性

iOS 系统，Android 系统

可提供的 1.0.0 及更高版本

sendVoiceMessage

发送语音消息

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

params

conversationType:

• 类型：字符串
• 默认值：无
• 描述：消息的会话类型，通过改变消息会话类型，可以发送单聊消息、讨论组消息、群聊消息、聊天室消息等，参见 会话类型

targetId:

• 类型：字符串
• 默认值：无
• 描述：消息的接收方 Id。根据不同的 conversationType，可能是用户 Id、讨论组 Id、群组 Id 或聊天室 Id 等

voicePath:

• 类型：字符串
• 默认值：无
• 描述：语音文件的路径，支持 fs://，如：fs:///voice/123.amr。文件要求为 AMR 格式

duration:

• 类型：数字
• 默认值：无
• 描述：语音消息的时长，单位为秒

extra:

• 类型：字符串
• 默认值：无
• 描述：消息的附加信息

callback(ret, err)

ret:

• 类型：JSON 对象
• 描述：返回的消息内容。发送准备时，提供所有消息信息；之后，result 中将只返回 message.messageId 等必要相关的内容
• 内部字段：

发送准备：

{
    status: 'prepare', // 状态码：prepare / success / error
    result:
    {
        message:
        {
            content: {
                voicePath: '/xxx/xxx/voice.amr',
                duration: 5,
                extra: ''
            }, // 消息内容 
            readReceiptInfo:{   // 注：如果此字段无值，则返回空
               hasRespond:true,          //是否已经发送回执
               isReceiptRequestMessage:true,//是否需要回执消息
               userIdList:{},       //发送回执的用户ID列表 (android不支持)
               userIds:[]      //json数组类型；发送回执的用户ID和时间戳列表 (ios不支持)
            },
            conversationType: 'PRIVATE', // 参见 会话类型 枚举
            messageDirection: 'SEND', // 消息方向：SEND 或者 RECEIVE
            targetId: '16', // 接收者 Id
            objectName: 'RC:VcMsg', // 消息类型，参见 http://docs.rongcloud.cn/android_message.html#_内置内容类消息
            sentStatus: 'SENDING', // 发送状态：SENDING, SENT 或 FAILED
            senderUserId: '55', // 发送者 userId
            messageId: 608, // 本地消息 Id
            sentTime: 1418971531533, // 发送消息的时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
            receivedTime: 0 // 收到消息的时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
            messageUId: ''   //消息UID，如果无则显示空字符串
        }
    }
}

成功：

{
    status: 'success', // 状态码：prepare / success / error
    result:
    {
        message:
        {
            messageId: 608 // 本地消息 Id
        }
    }
}

失败：

{
    status: 'error', // 状态码：prepare / success / error
    result:
    {
        message:
        {
            messageId: 608 // 本地消息 Id
        }
    }
}

err:

• 类型：JSON 对象
• 内部字段：

{
    code: 30003
}

状态码说明：

示例代码

var rong = api.require('rongCloudIM'); 
// 之前调用 init 和 connect 的代码省略
rong.sendVoiceMessage({
    conversationType: 'PRIVATE',
    targetId: '9527',
    voicePath: 'fs:///xxx/xxx/voice.amr',
    duration: 5,
    extra: ''
}, function(ret, err) {
    if (ret.status == 'prepare')
        api.toast({ msg: JSON.stringify(ret.result.message) });
    else if (ret.status == 'success')
        api.toast({ msg: ret.result.message.messageId });
    else if (ret.status == 'error')
        api.toast({ msg: err.code });
});

可用性

iOS 系统，Android 系统

可提供的 1.0.0 及更高版本

sendImageMessage

发送图片消息

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

params

conversationType:

• 类型：字符串
• 默认值：无
• 描述：消息的会话类型，通过改变消息会话类型，可以发送单聊消息、讨论组消息、群聊消息、聊天室消息等，参见 会话类型

targetId:

• 类型：字符串
• 默认值：无
• 描述：消息的接收方 Id。根据不同的 conversationType，可能是用户 Id、讨论组 Id、群组 Id 或聊天室 Id 等

imagePath:

• 类型：字符串
• 默认值：无
• 描述：图片的路径，支持 fs://，如：fs:///image/123.jpg

extra:

• 类型：字符串
• 默认值：无
• 描述：消息的附加信息

isFull:

• 类型：布尔类型
• 描述：是否发送原图
• 默认值：false

callback(ret, err)

ret:

• 类型：JSON 对象
• 描述：返回的消息内容。发送准备时，提供所有消息信息；之后，result 中将只返回 message.messageId 等必要相关的内容
• 内部字段：

发送准备：

{
    status: 'prepare', // 状态码：prepare / progress / success / error
    result:
    {
        message:
        {
            content: {
                imageUrl: '/xxx/xxx/image.jpg',
                thumbPath: '/xxx/xxx/thumb.jpg',
                extra: ''
            }, // 消息内容 
            readReceiptInfo:{   // 注：如果此字段无值，则返回空
               hasRespond:true,          //是否已经发送回执
               isReceiptRequestMessage:true,//是否需要回执消息
               userIdList:{},       //发送回执的用户ID列表 (android不支持)
               userIds:[]      //json数组类型；发送回执的用户ID和时间戳列表 (ios不支持)
            },
            conversationType: 'PRIVATE', // 参见 会话类型 枚举
            messageDirection: 'SEND', // 消息方向：SEND 或者 RECEIVE
            targetId: '16', // 接收者 Id
            objectName: 'RC:ImgMsg', // 消息类型，参见 http://docs.rongcloud.cn/android_message.html#_内置内容类消息
            sentStatus: 'SENDING', // 发送状态：SENDING, SENT 或 FAILED
            senderUserId: '55', // 发送者 userId
            messageId: 608, // 本地消息 Id
            sentTime: 1418971531533, // 发送消息的时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
            receivedTime: 0 // 收到消息的时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
            messageUId: ''   //消息UID，如果无则显示空字符串
        }
    }
}

发送中：

{
    status: 'progress', // 状态码：prepare / progress / success / error
    result:
    {
        message:
        {
            messageId: 608 // 本地消息 Id
        },
        progress: 66 // 发送进度
    }
}

成功：

{
    status: 'success', // 状态码：prepare / progress / success / error
    result:
    {
        message:
        {
            messageId: 608 // 本地消息 Id
        }
    }
}

失败：

{
    status: 'error', // 状态码：prepare / progress / success / error
    result:
    {
        message:
        {
            sentStatus: 'FAILED', // 发送状态：SENDING, SENT 或 FAILED
            messageId: 608 // 本地消息 Id
        }
    }
}

err:

• 类型：JSON 对象
• 内部字段：

{
    code: 30003
}

状态码说明：

示例代码

var rong = api.require('rongCloudIM');
// 之前调用 init 和 connect 的代码省略
rong.sendImageMessage({
    conversationType: 'PRIVATE',
    targetId: '9527',
    imagePath: 'fs:///xxx/xxx/picture.jpg',
    extra: ''
}, function(ret, err) {
    if (ret.status == 'prepare')
        api.toast({ msg: JSON.stringify(ret.result.message) });
    else if (ret.status == 'progress')
        api.toast({ msg: ret.result.progress });
    else if (ret.status == 'success')
        api.toast({ msg: ret.result.message.messageId });
    else if (ret.status == 'error')
        api.toast({ msg: err.code });
});

可用性

iOS 系统，Android 系统

可提供的 1.0.0 及更高版本

sendRichContentMessage

发送图文消息

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

params

conversationType:

• 类型：字符串
• 默认值：无
• 描述：消息的会话类型，通过改变消息会话类型，可以发送单聊消息、讨论组消息、群聊消息、聊天室消息等，参见 会话类型

targetId:

• 类型：字符串
• 默认值：无
• 描述：消息的接收方 Id。根据不同的 conversationType，可能是用户 Id、讨论组 Id、群组 Id 或聊天室 Id 等

title:

• 类型：字符串
• 默认值：无
• 描述：消息的标题

description:

• 类型：字符串
• 默认值：无
• 描述：消息的内容描述

imageUrl:

• 类型：字符串
• 默认值：无
• 描述：消息图片的网络地址

extra:

• 类型：字符串
• 默认值：无
• 描述：消息的附加信息

callback(ret, err)

ret:

• 类型：JSON 对象
• 描述：返回的消息内容。发送准备时，提供所有消息信息；之后，result 中将只返回 message.messageId 等必要相关的内容
• 内部字段：

发送准备：

{
    status: 'prepare', // 状态码：prepare / success / error
    result:
    {
        message:
        {
            content: {
                title: 'Big News',
                description: 'I am Ironman.',
                imageUrl: 'http://p1.cdn.com/fds78ruhi.jpg',
                extra: ''，
                url: ''
            }, // 消息内容
            readReceiptInfo:{   // 注：如果此字段无值，则返回空
               hasRespond:true,          //是否已经发送回执
               isReceiptRequestMessage:true,//是否需要回执消息
               userIdList:{},       //发送回执的用户ID列表 (android不支持)
               userIds:[]      //json数组类型；发送回执的用户ID和时间戳列表 (ios不支持)
            },
            conversationType: 'PRIVATE', // 参见 会话类型 枚举
            messageDirection: 'SEND', // 消息方向：SEND 或者 RECEIVE
            targetId: '16', // 接收者 Id
            objectName: 'RC:ImgTextMsg', // 消息类型，参见 http://docs.rongcloud.cn/android_message.html#_内置内容类消息
            sentStatus: 'SENDING', // 发送状态：SENDING, SENT 或 FAILED
            senderUserId: '55', // 发送者 userId
            messageId: 608, // 本地消息 Id
            sentTime: 1418971531533, // 发送消息的时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
            receivedTime: 0 // 收到消息的时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
            messageUId: ''   //消息UID，如果无则显示空字符串
        }
    }
}

成功：

{
    status: 'success', // 状态码：prepare / success / error
    result:
    {
        message:
        {
            messageId: 608 // 本地消息 Id
        }
    }
}

失败：

{
    status: 'error', // 状态码：prepare / success / error
    result:
    {
        message:
        {
            sentStatus: 'FAILED', // 发送状态：SENDING, SENT 或 FAILED
            messageId: 608 // 本地消息 Id
        }
    }
}

err:

• 类型：JSON 对象
• 内部字段：

{
    code: 30003
}

状态码说明：

示例代码

var rong = api.require('rongCloudIM');
// 之前调用 init 和 connect 的代码省略
rong.sendRichContentMessage({
    conversationType: 'PRIVATE',
    targetId: '9527',
    title: 'Big News',
    description: 'I am Ironman.'
    imageUrl: 'http://ironman.com/xxx/xxx/picture.jpg',
    extra: ''
}, function(ret, err) {
    if (ret.status == 'prepare')
        api.toast({ msg: JSON.stringify(ret.result.message) });
    else if (ret.status == 'success')
        api.toast({ msg: ret.result.message.messageId });
    else if (ret.status == 'error')
        api.toast({ msg: err.code });
});

可用性

iOS 系统，Android 系统

可提供的 1.0.0 及更高版本

sendLocationMessage

发送位置消息

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

params

conversationType:

• 类型：字符串
• 默认值：无
• 描述：消息的会话类型，通过改变消息会话类型，可以发送单聊消息、讨论组消息、群聊消息、聊天室消息等，参见 会话类型

targetId:

• 类型：字符串
• 默认值：无
• 描述：消息的接收方 Id。根据不同的 conversationType，可能是用户 Id、讨论组 Id、群组 Id 或聊天室 Id 等

latitude:

• 类型：数字
• 默认值：无
• 描述：消息的文字内容

longitude:

• 类型：数字
• 默认值：无
• 描述：消息的文字内容

poi:

• 类型：字符串
• 默认值：无
• 描述：消息的文字内容

imagePath:

• 类型：字符串
• 默认值：无
• 描述：地图缩率图的路径，支持 fs://，如：fs:///location_thumb/123.jpg

extra:

• 类型：字符串
• 默认值：无
• 描述：消息的附加信息

callback(ret, err)

ret:

• 类型：JSON 对象
• 描述：返回的消息内容。发送准备时，提供所有消息信息；之后，result 中将只返回 message.messageId 等必要相关的内容
• 内部字段：

发送准备：

{
    status: 'prepare', // 状态码：prepare / progress / success / error
    result:
    {
        message:
        {
            content: {
                latitude: 39.9139
                longitude: 116.3917
                poi: '北京市朝阳区北苑路北辰泰岳大厦',
                imagePath: '/xxx/xxx/location.jpg'
                extra: ''
            }, // 消息内容
            readReceiptInfo:{   // 注：如果此字段无值，则返回空
               hasRespond:true,          //是否已经发送回执
               isReceiptRequestMessage:true,//是否需要回执消息
               userIdList:{},       //发送回执的用户ID列表 (android不支持)
               userIds:[]      //json数组类型；发送回执的用户ID和时间戳列表 (ios不支持)
            },
            conversationType: 'PRIVATE', // 参见 会话类型 枚举
            messageDirection: 'SEND', // 消息方向：SEND 或者 RECEIVE
            targetId: '16', // 接收者 Id
            objectName: 'RC:LBSMsg', // 消息类型，参见 http://docs.rongcloud.cn/android_message.html#_内置内容类消息
            sentStatus: 'SENDING', // 发送状态：SENDING, SENT 或 FAILED
            senderUserId: '55', // 发送者 userId
            messageId: 608, // 本地消息 Id
            sentTime: 1418971531533, // 发送消息的时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
            receivedTime: 0 // 收到消息的时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
            messageUId: ''   //消息UID，如果无则显示空字符串
        }
    }
}

发送中：

{
    status: 'progress', // 状态码：prepare / progress / success / error
    result:
    {
        message:
        {
            messageId: 608 // 本地消息 Id
        },
        progress: 66 // 发送进度
    }
}

成功：

{
    status: 'success', // 状态码：prepare / progress / success / error
    result:
    {
        message:
        {
            messageId: 608 // 本地消息 Id
        }
    }
}

失败：

{
    status: 'error', // 状态码：prepare / progress / success / error
    result:
    {
        message:
        {
            messageId: 608 // 本地消息 Id
        }
    }
}

err:

• 类型：JSON 对象
• 内部字段：

{
    code: 30003
}

状态码说明：

示例代码

var rong = api.require('rongCloudIM');
// 之前调用 init 和 connect 的代码省略
rong.sendLocationMessage({
    conversationType: 'PRIVATE',
    targetId: '9527',
    latitude: 39.9139,
    longitude: 116.3917,
    poi: '北京市朝阳区北苑路北辰泰岳大厦',
    imagePath: 'fs:///xxx/xxx/location.jpg',
    extra: ''
}, function(ret, err) {
    if (ret.status == 'prepare')
        api.toast({ msg: JSON.stringify(ret.result.message) });
    else if (ret.status == 'progress')
        api.toast({ msg: ret.result.progress });
    else if (ret.status == 'success')
        api.toast({ msg: ret.result.message.messageId });
    else if (ret.status == 'error')
        api.toast({ msg: err.code });
});

可用性

iOS 系统，Android 系统

可提供的 1.0.0 及更高版本

sendCommandNotificationMessage

发送命令消息，可以用来实现任何自定义消息的发送

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

params

conversationType:

• 类型：字符串
• 默认值：无
• 描述：消息的会话类型，通过改变消息会话类型，可以发送单聊消息、讨论组消息、群聊消息、聊天室消息等，参见 会话类型

targetId:

• 类型：字符串
• 默认值：无
• 描述：消息的接收方 Id。根据不同的 conversationType，可能是用户 Id、讨论组 Id、群组 Id 或聊天室 Id 等

name:

• 类型：字符串
• 默认值：无
• 描述：命令的名称

data:

• 类型：字符串
• 默认值：无
• 描述：命令的数据

callback(ret, err)

ret:

• 类型：JSON 对象
• 描述：返回的消息内容。发送准备时，提供所有消息信息；之后，result 中将只返回 message.messageId 等必要相关的内容
• 内部字段：

发送准备：

{
    status: 'prepare', // 状态码：prepare / success / error
    result:
    {
        message:
        {
            content: {
                name: 'AddFriend',
                data: '{\"inviteUserId\":123}'
            }, // 消息内容
            readReceiptInfo:{   // 注：如果此字段无值，则返回空
               hasRespond:true,          //是否已经发送回执
               isReceiptRequestMessage:true,//是否需要回执消息
               userIdList:{},       //发送回执的用户ID列表 (android不支持)
               userIds:[]      //json数组类型；发送回执的用户ID和时间戳列表 (ios不支持)
            },
            conversationType: 'PRIVATE', // 参见 会话类型 枚举
            messageDirection: 'SEND', // 消息方向：SEND 或者 RECEIVE
            targetId: '16', // 接收者 Id
            objectName: 'RC:TxtMsg', // 消息类型，参见 http://docs.rongcloud.cn/android_message.html#_内置内容类消息
            sentStatus: 'SENDING', // 发送状态：SENDING, SENT 或 FAILED
            senderUserId: '55', // 发送者 userId
            messageId: 608, // 本地消息 Id
            sentTime: 1418971531533, // 发送消息的时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
            receivedTime: 0 // 收到消息的时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
            messageUId: ''   //消息UID，如果无则显示空字符串
        }
    }
}

成功：

{
    status: 'success', // 状态码：prepare / success / error
    result:
    {
        message:
        {
            messageId: 608 // 本地消息 Id
        }
    }
}

失败：

{
    status: 'error', // 状态码：prepare / success / error
    result:
    {
        message:
        {
            messageId: 608 // 本地消息 Id
        }
    }
}

err:

• 类型：JSON 对象
• 内部字段：

{
    code: 30003
}

状态码说明：

示例代码

var rong = api.require('rongCloudIM'); 
// 之前调用 init 和 connect 的代码省略
rong.sendCommandNotificationMessage({
    conversationType: 'PRIVATE',
    targetId: '9527',
    name: 'AddFriend',
    data: '{\"inviteUserId\":123}'
}, function(ret, err) {
    if (ret.status == 'prepare')
        api.toast({ msg: JSON.stringify(ret.result.message) });
    else if (ret.status == 'success')
        api.toast({ msg: ret.result.message.messageId });
    else if (ret.status == 'error')
        api.toast({ msg: err.code });
});

可用性

iOS 系统，Android 系统

可提供的 1.0.0 及更高版本

sendCommandMessage

发送命令消息，您需要这种类型的消息时可以直接使用，不需要再自定义。此消息不保存、不计数。

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

params

conversationType:

• 类型：字符串
• 默认值：无
• 描述：消息的会话类型，通过改变消息会话类型，可以发送单聊消息、讨论组消息、群聊消息、聊天室消息等，参见 会话类型

targetId:

• 类型：字符串
• 默认值：无
• 描述：消息的接收方 Id。根据不同的 conversationType，可能是用户 Id、讨论组 Id、群组 Id 或聊天室 Id 等

name:

• 类型：字符串
• 默认值：无
• 描述：命令的名称

data:

• 类型：字符串
• 默认值：无
• 描述：命令的数据

callback(ret, err)

ret:

• 类型：JSON 对象
• 描述：返回的消息内容。发送准备时，提供所有消息信息；之后，result 中将只返回 message.messageId 等必要相关的内容
• 内部字段：

发送准备：

{
    status: 'prepare', // 状态码：prepare / success / error
    result:
    {
        message:
        {
            content: {
                name: 'AddFriend',
                data: '{\"inviteUserId\":123}'
            }, // 消息内容
            readReceiptInfo:{   // 注：如果此字段无值，则返回空
               hasRespond:true,          //是否已经发送回执
               isReceiptRequestMessage:true,//是否需要回执消息
               userIdList:{},       //发送回执的用户ID列表 (android不支持)
               userIds:[]      //json数组类型；发送回执的用户ID和时间戳列表 (ios不支持)
            },
            conversationType: 'PRIVATE', // 参见 会话类型 枚举
            messageDirection: 'SEND', // 消息方向：SEND 或者 RECEIVE
            targetId: '16', // 接收者 Id
            objectName: 'RC:TxtMsg', // 消息类型，参见 http://docs.rongcloud.cn/android_message.html#_内置内容类消息
            sentStatus: 'SENDING', // 发送状态：SENDING, SENT 或 FAILED
            senderUserId: '55', // 发送者 userId
            messageId: 608, // 本地消息 Id
            sentTime: 1418971531533, // 发送消息的时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
            receivedTime: 0 // 收到消息的时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
            messageUId: ''   //消息UID，如果无则显示空字符串
        }
    }
}

成功：

{
    status: 'success', // 状态码：prepare / success / error
    result:
    {
        message:
        {
            messageId: 608 // 本地消息 Id
        }
    }
}

失败：

{
    status: 'error', // 状态码：prepare / success / error
    result:
    {
        message:
        {
            messageId: 608 // 本地消息 Id
        }
    }
}

err:

• 类型：JSON 对象
• 内部字段：

{
    code: 30003
}

状态码说明：

示例代码

var rong = api.require('rongCloudIM');
// 之前调用 init 和 connect 的代码省略
rong.sendCommandMessage({
    conversationType: 'PRIVATE',
    targetId: '9527',
    name: 'AddFriend',
    data: '{\"inviteUserId\":123}'
}, function(ret, err) {
    if (ret.status == 'prepare')
        api.toast({ msg: JSON.stringify(ret.result.message) });
    else if (ret.status == 'success')
        api.toast({ msg: ret.result.message.messageId });
    else if (ret.status == 'error')
        api.toast({ msg: err.code });
});

可用性

iOS 系统，Android 系统

可提供的 1.0.0 及更高版本

setOnReceiveMessageListener

设置接收消息的监听器，请在调用 init 方法之后，调用 connect 方法之前设置

所有接收到的消息、通知、状态都经由此处设置的监听器处理。包括私聊消息、讨论组消息、群组消息、聊天室消息以及各种其他消息、通知、状态等

setOnReceiveMessageListener(callback(ret, err))

callback(ret)

ret:

• 类型：JSON 对象
• 描述：接收到的消息内容和剩余消息条数
• 内部字段：

{
     result: {
        message:{
            content: {                   //JSON对象；消息内容
                text: 'Hello world!',
                extra: ''
            },         
            readReceiptInfo:{   // 注：如果此字段无值，则返回空
               hasRespond:true,          //是否已经发送回执
               isReceiptRequestMessage:true,//是否需要回执消息
               userIdList:{},       //发送回执的用户ID列表 (android不支持)
               userIds:[]      //json数组类型；发送回执的用户ID和时间戳列表 (ios不支持)
            },
            conversationType: 'PRIVATE', // 参见 会话类型 枚举
            messageDirection: 'SEND',    // 消息方向：SEND 或者 RECEIVE
            targetId: '55',              // 这里对应消息发送者的 userId
            objectName: 'RC:TxtMsg',     // 消息类型，参见 http://docs.rongcloud.cn/android_message.html#_内置内容类消息
            sentStatus: 'SENDING',       // 发送状态：SENDING, SENT 或 FAILED
            senderUserId: '55',          // 发送者 userId
            messageId: 608,              // 本地消息 Id
            sentTime: 1418971531533,     // 发送消息的时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
            receivedTime: 0,              // 收到消息的时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
            receivedStatus: 'LISTENED' // 消息状态(android不支持) 取值范围：UNREAD，READ，LISTENED，DOWNLOADED，RETRIEVED，MULTIPLERECEIVE
            isRead:true,    //获取是否已读取的状态(ios不支持)
            isListened:true, //获取是否已被收听的状态(ios不支持)
            isDownload:true,   //获取文件是否已经下载的状态(ios不支持)
            isRetrieved:false, //获取是否已经被收取过(ios不支持)
            messageUId: ''   //消息UID，如果无则显示空字符串
            isMultipleReceive: false  //获取是否被其他端同时接收(ios不支持)
        },
        left: 0                         // 剩余未拉取的消息数目
    },
    isPushMsg: false                   //布尔类型；是否是推送消息，本参数仅在iOS平台有效。
                                       //在 iOS 平台上APP收到推送时，有以下几种情况：
                                       //1，应用在前台激活状态，开发者可同本接口获取推送消息，此时 result数据格式如下文说明
                                       //2，应用在后台但未被杀死，此时系统弹出推送提示。若用户点击推送提示，开发者可同本接口获取推送消息，此时 result数据格式如下文说明。若用户不点击推送提示，直接点击app进入应用，则获取
                                       //3，应用未激活，此时收到推送后，系统会弹出提示框，用户点击该提示框，开发者可通过api对象下noticeclicked事件监听到推送消息。
                                       //注意：如果用户不点击推送提示框，而是直接点击app图标进入应用，开发者是收不到推送消息的。
}

档 isPushMsg 为 true 时 result 数据的格式说明：

{
    _j_msgid:20266200178825380,  //数字类型；
    infoid:'0',                  //字符串类型；
    _j_business:1,               //数字类型；
    id:62358',                   //字符串类型；
    aps:{                        //JSON对象
      sound:'default',           //字符串类型；
      badge:1,                   //数字类型；
      alert:'你有新的消息'         //字符串类型；
    },
    _j_uid:12108421449,          //数字类型；
    type:‘8’,                    //字符串类型；
}

示例代码

var rong = api.require('rongCloudIM'); 
// 之前调用 init 的代码省略 
rong.setOnReceiveMessageListener(function(ret, err) {
    api.toast({ msg: JSON.stringify(ret.result.message) });
    api.toast({ msg: ret.result.message.left });
}) 
// 之后调用 connect 的代码省略

可用性

iOS 系统，Android 系统

可提供的 1.0.0 及更高版本

getOfflineMessageDuration

获取当前用户离线消息时间

getOfflineMessageDuration(callback(ret, err))

callback(ret)

ret:

• 类型：JSON 对象
• 描述：获取状态
• 内部字段：

status: true  //布尔类型；获取到的状态
duration: ''  //字符串类型；当前用户离线消息时间，单位：天

err:

• 类型：JSON 对象
• 描述：获取状态
• 内部字段：

errCode: ''  //数字类型；错误码；详情参见：https://www.rongcloud.cn/docs/status_code.html#android_ios_code

示例代码

var rong = api.require('rongCloudIM'); 
rong.getOfflineMessageDuration(function(ret, err) {
    api.toast({ msg: JSON.stringify(ret) });
})

可用性

iOS 系统，Android 系统

可提供的 1.0.0 及更高版本

setOfflineMessageDuration

设置当前用户离线消息存储时间

setOfflineMessageDuration(params, callback(ret, err))

params

duration：

• 类型：数字类型
• 描述：(可选项)用户离线消息存储时间（以天为单位），范围【1~7天】
• 默认值：1

callback(ret)

ret:

• 类型：JSON 对象
• 描述：获取状态
• 内部字段：

status: true  //布尔类型；获取到的状态
time: ''      //字符串类型；设置成功后的时间(毫秒值)(iOS不支持)

err:

• 类型：JSON 对象
• 描述：获取状态
• 内部字段：

errCode: ''  //数字类型；错误码；详情参见：https://www.rongcloud.cn/docs/status_code.html#android_ios_code

示例代码

var rong = api.require('rongCloudIM'); 
rong.setOfflineMessageDuration({duration:2}, function(ret, err) {
    api.toast({ msg: JSON.stringify(ret) });
})

可用性

iOS 系统，Android 系统

可提供的 1.0.0 及更高版本

searchConversations

搜索本地历史消息

searchConversations({params}, callback(ret))

params

conversationTypes:

• 类型：数组类型
• 描述：搜索的会话类型，参见 会话类型

objectNames:

• 类型：数组类型
• 描述：搜索的消息类型。比如：RC:TxtMsg；详情参见：http://docs.rongcloud.cn/android_message.html#_内置内容类消息

keyword:

• 类型：字符串类型
• 描述： 搜索的关键字

callback(ret)

ret:

• 类型：JSON 对象
• 描述：会话信息
• 内部字段：

{
    status: 'success',
    result: [
        {
            conversationTitle: 'Ironman', // 会话标题
            conversationType: 'PRIVATE', // 参见 会话类型 枚举
            draft: '', // 文字消息草稿的内容
            targetId: 'group001', // 消息目标 Id
            latestMessage: {
                text: 'Hello world!',
                extra: ''
            }, // 最后一条消息的内容
            readReceiptInfo:{   // 注：如果此字段无值，则返回空
               hasRespond:true,          //是否已经发送回执
               isReceiptRequestMessage:true,//是否需要回执消息
               userIdList:{},       //发送回执的用户ID列表 (android不支持)
               userIds:[]      //json数组类型；发送回执的用户ID和时间戳列表 (ios不支持)
            },
            sentStatus: 'SENT', // 参见 发送出的消息状态
            *notificationStatus: 'NOTIFY', // 会话通知状态，2.0.0将不再提供此字段，可通过 getConversationNotificationStatus 获取
            objectName: 'RC:TxtMsg', // 消息类型，参见 http://docs.rongcloud.cn/android_message.html#_内置内容类消息
            receivedStatus: 'READ', // 参见 接收到的消息状态
            senderUserId: '55', // 发送消息的用户 Id
            unreadMessageCount: 10, // 本会话的未读消息数
            receivedTime: 1418968547905, // 发送消息的时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
            sentTime: 1418968488063, // 收到消息的时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
            isTop: false, // 置顶状态
            latestMessageId: 608 // 本会话最后一条消息 Id
        }
    ]
}

示例代码

var rong = api.require('rongCloudIM'); 
// 之前调用 init 和 connect 的代码省略
rong.searchConversations({
    conversationTypes: ['PRIVATE'],
    objectNames: ['RC:TxtMsg'],
    keyword:'hello'
}, function(ret) {
    api.toast({ msg: ret.status });
})

可用性

iOS 系统，Android 系统

可提供的 1.0.0 及更高版本

searchMessages

根据会话,搜索本地历史消息。

searchMessages({params}, callback(ret))

params

conversationType:

• 类型：字符串类型
• 描述：指定的会话类型，参见 会话类型

targetId:

• 类型：字符串类型
• 描述：指定的会话 id

keyword:

• 类型：字符串类型
• 描述： 搜索的关键字

count:

• 类型：数字类型
• 描述： 返回的搜索结果数量（iOS平台为返回的最大搜索结果数量）, 安卓平台传0时会返回所有搜索到的消息, 非0时,逐页返回
• 默认值：0

beginTime:

• 类型：数字类型
• 描述： 查询记录的起始时间, 传0时从最新消息开始搜索。（单位：毫秒值）
• 默认值：0

callback(ret)

ret:

• 类型：JSON 对象
• 描述：会话信息
• 内部字段：

{
    status: 'success',
    result: [
        {
            content: {
                text: 'Hello world!',
                extra: ''
            }, // 消息内容
            readReceiptInfo:{   // 注：如果此字段无值，则返回空
               hasRespond:true,          //是否已经发送回执
               isReceiptRequestMessage:true,//是否需要回执消息
               userIdList:{},       //发送回执的用户ID列表 (android不支持)
               userIds:[]      //json数组类型；发送回执的用户ID和时间戳列表 (ios不支持)
            },
          extra: '', // 消息的附加信息，此信息只保存在本地
            conversationType: 'PRIVATE', // 参见 会话类型 枚举
            messageDirection: 'SEND', // 消息方向：SEND 或者 RECEIVE
            targetId: '55', // 这里对应消息发送者的 userId
            objectName: 'RC:TxtMsg', // 消息类型，参见 http://docs.rongcloud.cn/android_message.html#_内置内容类消息
            sentStatus: 'SENDING', // 参见 发送出的消息状态
            senderUserId: '55', // 发送者 userId
            messageId: 608, // 本地消息 Id
            sentTime: 1418971531533, // 发送消息的时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
            receivedTime: 0, // 收到消息的时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
            receivedStatus: 'LISTENED' // 消息状态(android不支持) 取值范围：UNREAD，READ，LISTENED，DOWNLOADED，RETRIEVED，MULTIPLERECEIVE
            isRead:true,    //获取是否已读取的状态(ios不支持)
            isListened:true, //获取是否已被收听的状态(ios不支持)
            isDownload:true,   //获取文件是否已经下载的状态(ios不支持)
            isRetrieved:false, //获取是否已经被收取过(ios不支持)
            isMultipleReceive: false  //获取是否被其他端同时接收(ios不支持)
            messageUId: ''   //消息UID，如果无则显示空字符串
        }
    ]
}

示例代码

var rong = api.require('rongCloudIM'); 
// 之前调用 init 和 connect 的代码省略
rong.searchMessages({
    conversationType: 'PRIVATE',
    targetId: '1234',
    keyword:'hello'
}, function(ret) {
    api.toast({ msg: ret.status });
})

可用性

iOS 系统，Android 系统

可提供的 1.0.0 及更高版本

getConversationList

获取会话列表

会话列表按照时间从前往后排列，如果有置顶会话，则置顶会话在前

getConversationList(callback(ret, err))

callback(ret, err)

ret:

• 类型：JSON 对象
• 描述：会话列表
• 内部字段：

{
    status: 'success',
    result: [
        {
            conversationTitle: 'Ironman', // 会话标题
            conversationType: 'PRIVATE', // 参见 会话类型 枚举
            draft: '', // 文字消息草稿的内容
            targetId: 'group001', // 消息目标 Id
            latestMessage: {
                text: 'Hello world!',
                extra: ''
            }, // 最后一条消息的内容
            readReceiptInfo:{   // 注：如果此字段无值，则返回空
               hasRespond:true,          //是否已经发送回执
               isReceiptRequestMessage:true,//是否需要回执消息
               userIdList:{},       //发送回执的用户ID列表 (android不支持)
               userIds:[]      //json数组类型；发送回执的用户ID和时间戳列表 (ios不支持)
            },
            sentStatus: 'SENT', // 参见 发送出的消息状态
            *notificationStatus: 'NOTIFY', // 会话通知状态，2.0.0将不再提供此字段，可通过 getConversationNotificationStatus 获取
            objectName: 'RC:TxtMsg', // 消息类型，参见 http://docs.rongcloud.cn/android_message.html#_内置内容类消息
            receivedStatus: 'READ', // 参见 接收到的消息状态
            senderUserId: '55', // 发送消息的用户 Id
            unreadMessageCount: 10, // 本会话的未读消息数
            receivedTime: 1418968547905, // 发送消息的时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
            sentTime: 1418968488063, // 收到消息的时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
            isTop: false, // 置顶状态
            latestMessageId: 608 // 本会话最后一条消息 Id,
            mentionedCount: 2   //本会话里自己被＠的消息数量(iOS不支持)
            hasUnreadMentioned:true //会话中是否存在被@的消息,在清除会话未读数的时候，会将此状态置成false(android不支持)
        }
    ]
}

示例代码

var rong = api.require('rongCloudIM'); 
// 之前调用 init 和 connect 的代码省略 
rong.getConversationList(function(ret, err) {
    api.toast({ msg: JSON.stringify(ret.result) });
})

可用性

iOS 系统，Android 系统

可提供的 1.0.0 及更高版本

getTopConversationList

获取置顶会话列表

getTopConversationList(callback(ret))

callback(ret)

ret:

• 类型：JSON 对象
• 描述：会话列表
• 内部字段：

{
    status: 'success',
    result: [
        {
            conversationTitle: 'Ironman', // 会话标题
            conversationType: 'PRIVATE', // 参见 会话类型 枚举
            draft: '', // 文字消息草稿的内容
            targetId: 'group001', // 消息目标 Id
            latestMessage: {
                text: 'Hello world!',
                extra: ''
            }, // 最后一条消息的内容
            readReceiptInfo:{   // 注：如果此字段无值，则返回空
               hasRespond:true,          //是否已经发送回执
               isReceiptRequestMessage:true,//是否需要回执消息
               userIdList:{},       //发送回执的用户ID列表 (android不支持)
               userIds:[]      //json数组类型；发送回执的用户ID和时间戳列表 (ios不支持)
            },
            sentStatus: 'SENT', // 参见 发送出的消息状态
            *notificationStatus: 'NOTIFY', // 会话通知状态，2.0.0将不再提供此字段，可通过 getConversationNotificationStatus 获取
            objectName: 'RC:TxtMsg', // 消息类型，参见 http://docs.rongcloud.cn/android_message.html#_内置内容类消息
            receivedStatus: 'READ', // 参见 接收到的消息状态
            senderUserId: '55', // 发送消息的用户 Id
            unreadMessageCount: 10, // 本会话的未读消息数
            receivedTime: 1418968547905, // 发送消息的时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
            sentTime: 1418968488063, // 收到消息的时间戳，从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
            isTop: false, // 置顶状态
            latestMessageId: 608 // 本会话最后一条消息 Id,
            mentionedCount: 2   //本会话里自己被＠的消息数量(iOS不支持)
            hasUnreadMentioned:true //会话中是否存在被@的消息,在清除会话未读数的时候，会将此状态置成false(android不支持)
        }
    ]
}

示例代码

var rong = api.require('rongCloudIM'); 
// 之前调用 init 和 connect 的代码省略 
rong.getTopConversationList(function(ret, err) {
    api.toast({ msg: JSON.stringify(ret.result) });
})