rongCloud2

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

• 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="你的包名" 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 reconnect disconnect logout setConnectionStatusListener getConnectionStatus getCurrentUserId

消息的接收和发送

sendTextMessage sendImageMessage sendGifMessage sendHQVoiceMessage sendFileMessage sendSightMessage sendVoiceMessage sendLocationMessage sendRichContentMessage sendCommandNotificationMessage sendContactNotificationMessage sendProfileNotificationMessage sendInformationNotificationMessage sendGroupNotificationMessage sendCommandMessage setOnReceiveMessageListener getOfflineMessageDuration setOfflineMessageDuration searchConversations searchMessages

会话

getConversationList getTopConversationList getBlockedConversationList getConversationListByCount getConversation removeConversation clearConversations setConversationToTop

会话通知状态

getConversationNotificationStatus setConversationNotificationStatus disableLocalNotification

消息的读取和删除

getLatestMessages getHistoryMessages getHistoryMessagesByObjectName getRemoteHistoryMessages deleteMessages clearMessages recallMessage setOnMessageRecalledListener getUnreadMentionedMessages

未读消息数

getTotalUnreadCount getUnreadCount getUnreadCountByConversationTypes

消息的状态

setMessageReceivedStatus setMessageExtra setMessageSentStatus sendTypingStatus addTypingStatusListener

消息回执

sendReadReceiptMessage addReceiveReadReceiptListener sendReadReceiptRequest sendReadReceiptResponse addReadReceiptListener removeReadReceiptListener

文字消息草稿

getTextMessageDraft saveTextMessageDraft clearTextMessageDraft

音视频通话

addCallReceiveListener removeCallReceiveListener startCall addCallSessionListener removeCallSessionListener getCallSession isCallEnabled setVideoProfile setEnableBeauty accept hangup addParticipants setVideoView resetVideoView videoViewBringToFront removeVideoView addVideoViewListener changeMediaType isMuted setMuted speakerEnabled setSpeakerEnabled cameraEnabled setCameraEnabled switchCameraMode startAudioRecording stopAudioRecording

讨论组

createDiscussion getDiscussion setDiscussionName addMemberToDiscussion removeMemberFromDiscussion quitDiscussion setDiscussionInviteStatus

群组

syncGroup joinGroup quitGroup

聊天室

joinChatRoom quitChatRoom

黑名单

addToBlacklist removeFromBlacklist getBlacklistStatus getBlacklist

消息通知免打扰

setNotificationQuietHours removeNotificationQuietHours getNotificationQuietHours

论坛示例

为帮助用户更好更快的使用模块，论坛维护了一个示例，示例中包含示例代码、知识点讲解、注意事项等，供您参考。

概述

rongCloud2是rongCloud的优化版

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

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

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

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

APICloud融云模块V2.0.0版更新说明

弃用的方法：

• reconnect

修改的方法：

• sendImageMessage的prepare返回值content中localPath统一为imageUrl，其值不变
• sendRichContentMessage返回值content中加入url字段
• getConversationList和getConversation 安卓返回值去掉字段notificationStatus,该字段取值可通过 getConversationNotificationStatus 获取
• setConnectionStatusListener返回状态值统一成枚举字符串；去掉了status字段
• setOnReceiveMessageListener 去掉了status字段
• setMessageReceivedStatus 状态值统一成枚举字符串
• getConversation/getConversationList 修改recievedStatus，统一为枚举字符串
• 所有的错误err将只返回code，不再有msg，错误码信息参照 融云常见错误码

新增的方法：

• getConnectionStatus // 获取当前连接状态
• logout // 注销登录
• getRemoteHistoryMessages // 获取远端历史消息
• setMessageSentStatus // 设置消息发送状态
• getCurrentUserId // 获取当前用户 Id
• addToBlacklist // 加入黑名单
• removeFromBlacklist // 移出黑名单
• getBlacklistStatus // 获取用户黑名单状态
• getBlacklist // 获取用户黑名单
• setNotificationQuietHours // 设置关闭 Push 时间，在该段时间内您不会收到远程推送提示，若应用刚被切到后台时，可收到本地推送提示，只有在app被杀死时才会走远程推送。
• removeNotificationQuietHours // 删除 Push 设置
• getNotificationQuietHours // 查询 Push 设置
• sendCommandMessage // 不保存、不计数的消息（ObjectName 为 RC:CmdMsg），您需要这种类型的消息时可以直接使用，不需要再自定义。
• disableLocalNotification // 设置本地消息不在通知栏提示

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 平台关于后台运行权限的配置。

注意

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

Android 平台推送集成说明

• 融云默认使用自己平台的推送服务，由于该推送服务属于应用级别的，所以可能受到系统平台的限制，建议您在使用时，在设置里打开自启动权限和通知权限，或者勾选“信任此应用”等，以提高推送到达率

• 集成第三方推送（使用thirdpartPush自定义模块）

thirdpartPush 模块集成了小米、魅族、vivo、oppo平台的推送，在使用该模块之前需要到相应的平台创建应用并获取相应的 appKey & appSecret等信息，并登录融云开发者后台在应用标识中配置相应的信息，并将该模块以自定义模块形式编译打包 注意：需要在调用init方法是配置或开启相应的第三方推送

• config.xml中需要单独配置vivo推送，配置如下:

<!-- vivo 推送配置项 -->
<meta-data name="com.vivo.push.api_key" value="您的 vivo 推送平台生成 AppKey"/>
<meta-data name="com.vivo.push.app_id"  value="您的 vivo 推送平台生成 AppID"/>

• config.xml中需要单独配置华为推送，配置如下:

  <meta-data name="com.huawei.hms.client.appid" value="华为推送appID"/>

• thirdpartPush 下载地址：

模块接口

init

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

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

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

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

init(params, callback(ret, err))

params

miPush:

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

• 内部字段：

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

huaweiPush:

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

meizuPush:

• 类型：JSON对象
• 描述：（可选项）魅族推送配置（需到魅族开发者平台去申请）
• 内部字段：

{
    appId:'',     // 字符串；魅族推送的AppID
    appKey:''   // 字符串；魅族推送 AppKey
}

oppoPush:

• 类型：JSON对象
• 描述：（可选项）oppo推送配置（需到oppo开发者平台去申请）
• 内部字段：

{
    appKey:'',     // 字符串；oppo推送的key
    appSecret:''   // 字符串；oppo推送 secret
}

vivoPush:

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

callback(ret, err)

ret:

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

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

err:

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

{
    code: -10002    // 错误码
}

错误说明 更多状态码：

示例代码

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

可用性

iOS系统，Android系统

可提供的 1.1.0 及更高版本

configurationParameter

配置推送相关参数

configurationParameter({params})

params

alertTitle:

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

showNickname：

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

示例代码

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

可用性

iOS系统，Android系统

可提供的 1.1.0 及更高版本

connect

连接融云 IM 服务器，进行后续各种方法操作前务必要先调用此方法，（Android自3.2.4版本【包括3.2.4】以后，需要开通音视频服务，否则会导致连接失败）

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('rongCloud2');
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.1.0 及更高版本

reconnect

主动重新连接服务器。融云的 SDK 会自动进行重连，一般情况下您不需要调用这个方法；2.0版本弃用该方法。

reconnect(callback(ret, err))

可用性

iOS系统，Android系统

此方法在apicloud融云模块1.1.0中支持，由于融云支持掉线后自动重连，所以在2.0.0版本中弃用该方法

disconnect

断开连接

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

params

isReceivePush:

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

callback(ret)

ret:

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

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

示例代码

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

可用性

iOS系统，Android系统

可提供的 1.1.0 及更高版本

setConnectionStatusListener

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

setConnectionStatusListener(callback(ret, err))

callback(ret)

ret:

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

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

示例代码

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

可用性

iOS系统，Android系统

可提供的 1.1.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('rongCloud2');
// 之前调用 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.1.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('rongCloud2');
// 之前调用 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.1.0 及更高版本

sendHQVoiceMessage

发送高清语音消息

sendHQVoiceMessage({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('rongCloud2');
// 之前调用 init 和 connect 的代码省略
rong.sendHQVoiceMessage({
    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系统

可提供的 3.2.8 及更高版本

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('rongCloud2');
// 之前调用 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.1.0 及更高版本

sendGifMessage

发送 GIF 消息

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

params

conversationType:

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

targetId:

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

imagePath:

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

extra:

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

width:

• 类型：数字
• 描述：gif 图宽度

height:

• 类型：数字
• 描述：gif 图高度

callback(ret, err)

ret:

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

发送准备：

{
    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('rongCloud2');
// 之前调用 init 和 connect 的代码省略
rong.sendGifMessage({
    conversationType: 'PRIVATE',
    targetId: '9527',
    imagePath: 'fs:///xxx/xxx/picture.gif',
    width: 100,
    height: 100,
    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系统

可提供的 3.2.8 及更高版本

sendSightMessage

发送小视频消息

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

params

conversationType:

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

targetId:

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

sightPath:

• 类型：字符串
• 描述：小视频的路径，仅支持 fs://，如：fs:///image/123.jpg

thumbPath:

• 类型：字符串
• 描述：缩略图的路径，仅支持 fs://，如：fs:///image/123.jpg

extra:

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

duration:

• 类型：数字
• 描述：小视频时长

callback(ret, err)

ret:

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

发送准备：

{
    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('rongCloud2');
// 之前调用 init 和 connect 的代码省略
rong.sendSightMessage({
    conversationType: 'PRIVATE',
    targetId: '9527',
    thumbPath: 'fs:///xxx/xxx/picture.jpg',
    sightPath:'',
    duration: 10, 
    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系统

可提供的 3.2.8 及更高版本

sendFileMessage

发送文件消息

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

params

conversationType:

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

targetId:

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

filePath:

• 类型：字符串
• 描述：文件的路径，仅支持 fs://，如：fs:///image/123.jpg

extra:

• 类型：字符串
• 描述：消息的附加信息

callback(ret, err)

ret:

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

发送准备：

{
    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('rongCloud2');
// 之前调用 init 和 connect 的代码省略
rong.sendFileMessage({
    conversationType: 'PRIVATE',
    targetId: '9527',
    filePath: 'fs:///xxx/xxx/picture.gif', 
    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系统

可提供的 3.2.8 及更高版本

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('rongCloud2');
// 之前调用 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.1.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('rongCloud2');
// 之前调用 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 });
});