tencentIm

立即使用

init setUserStatusListener setConnectListener setGroupEventListener seConversationListener seMessageExtConfig setMessageRevokedListener setMessageReceiptListener login logout initStorage getLocalMessage getLoginUser getConversation sendText sendImage sendFace sendSound sendLocation sendFile sendCustom addNewMessageListener getConversations getMessage deleteConversation deleteLocalMessage getUnReadMessageNum setRead createGroup inviteGroupMember applyJoinGroup quitGroup deleteGroupMember getGroupMembers getGroupList deleteGroup modifyGroupOwner getGroupDetailInfo getGroupPublicInfo getSelfInfoInGroup getGroupMembersInfo modifyGroupInfo modifyMemberRoleType modifyMemberSilence modifyMemberNameCard setReceiveMessageOpt getGroupPendencyList reportGroupPendency doGroupPendency getRemoteSelfProfile getLocalSelfProfile getUsersProfile getUserLocalProfile modifySelfProfile getFriendList modifyFriend addFriend deleteFriends doResponse getPendencyList deletePendency pendencyReport addBlackList deleteBlackList getBlackList createFriendGroup deleteFriendGroup addFriendsToFriendGroup deleteFriendsFromFriendGroup renameFriendGroup getFriendGroups setOfflinePushSettings getOfflinePushSettings setAPNS getAPNS setOfflineToken getDeviceBrand doBackground doForeground 附录

模块概述

tencentIm 模块封装了腾讯云通信IM。云通信（Instant Messaging，IM）承载亿级 QQ 用户即时通讯技术，立志成为企业数字化转型的通信助手，为您提供全方位立体化的通信能力，让通信触达全球，智联万物。

iOS相关远程推送

如何使用远程推送

集成推送功能流程如下文所示。此过程中涉及到的 AppID 即为 Bundle Identifie，与 APICloud 平台上的包名是同一个东西，在 APICloud 平台上应用的概览里可以查看。

1. 登录苹果开发者中心申请推送证书，本过程操作详情参考配置腾讯云推送证书

2. 将上一步生成的 p12 证书上传到腾讯云通信IM，在【应用列表】页面，单击目标应用所在列的【应用配置】，进入【基础配置】页面。单击 iOS 推送证书区域的【+添加证书】，选择证书类型，上传 iOS 证书（p.12），设置证书密码，单击【确定】。

3. 将 1 过程中生成的 provisioning profile 文件和证书上传 APICloud 平台，即可在 APICloud 平台云编译出 ipa 安装包并安装（正式版发布到苹果商店，通过苹果商店下载安装）

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

代码中如何获取远程推送的内容

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

api.addEventListener({
    name: 'noticeclicked'
}, function(ret) {
    if (ret && ret.value) {
        var type = ret.type;//0APICloud收到的推送内容，1模块开发者自定义的
        var result = ret.value;//推送内容
    }
})

value数据格式如下：

{
    “localNotification”:false,//是否是本地通知，若为true则下文数据格式同addNewMessageListener接口监听回调的数据格式
    "aps":{
        "alert":{
            "body":"您有一条新消息"  // 消息内容
        },     
        "badge":1,               // 角标数
        "sound":"default"    // 提示音     
     },
    "e":"自定义推送扩展",//自定义推送扩展
    "f":"6001",    // 消息发送方
    "t":"6006",    // 消息接收方     
    "m":"373360335316321408"， // 消息id
    "g":"1421300621769"  // 群组id（如果是单聊则没有该字段）
 }

如果 App 当前为活跃状态且未被系统冻结（按home键2分钟内app在后台运行状态），则您可通过在 addNewMessageListener 接口中监听捕获该消息，详情参考 addNewMessageListener 接口说明。此时若允许本地通知，则模块会弹出本地通知的提示框，用户点击该提示框，iOS系统会启动本App，同时api.addEventListener也会受到消息。

证书到期后，要更换新的推送证书，需要在环信管理后台将旧的删除，之后重新上传，上传时的命名要与旧证书的命名一致。一个appkey下可以传多个证书，这就可以实现夸App聊天，在不同App中初始化sdk的时候，指定不同的推送证书，每个证书对应当前App的bundle id，这样，用户在登录不同的App的时候就会绑定到不同的推送证书，从而实现夸App的聊天和推送。

注意：本模块 iOS 平台上最低适配系统版本为 iOS 8.0

android使用此模块之前必须先配置 config 文件，配置方法如下：

• 名称：tencentIm
• 参数：appid
• 配置示例:

 <feature name="tencentIm">
        <param name="appid" value="1400213323" />
    </feature>

• 字段描述:

  appid：腾讯云通信控制平台获取。

模块接口

init

初始化，其他接口都需要在初始化之后调用

init({params}, callback(ret))

params

appid：

• 类型：数字类型
• 描述：用户标识接入 SDK 的应用 ID，腾讯云通信控制平台，此参数仅支持iOS

logLevel：

• 类型：数字类型
• 描述：（可选项）打印log级别
• 默认：2，iOS默认：0
• 取值范围：0/OFF，2/VERBOSE（iOS不支持），3/DEBUG，4/INFO，5/WARN，6/ERROR

addLogListener：

• 类型：布尔类型
• 描述：（可选项）是否监听log，如果监听将在回调返回
• 默认：false

logPrint：

• 类型：布尔类型
• 描述：（可选项）是否将log打印到控制台，iOS不支持
• 默认：false

logPath:

• 类型：字符串类型
• 描述：（可选项）log日志输入位置，支持fs路径，iOS不支持
• 默认值：设备sdk卡/tencent/imsdklogs/(包名)/

enableReadReceipt：

• 类型：布尔类型
• 描述：（可选项）是否开启消息已读回执，仅支持iOS
• 默认：true

enableAutoReport：

• 类型：布尔类型
• 描述：（可选项）是否开启自动已读上报，仅支持iOS
• 默认：true

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
    log:{                            //JSON对象类型；log内容，仅当addLogListener为true时可能返回
        level:,           //数字类型；log级别，与参数logLevel对应
        tag:'',           //字符串类型；日志tag，iOS不支持
        msg:'',         //字符串类型；日志内容
    }
}

err：

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

{
    msg: '',           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.init({
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setUserStatusListener

监听用户状态

setUserStatusListener({params}, callback(ret))

params

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
    userStatus:'',             //字符串类型，用户状态，取值：offline/被踢下线，sigExpired/签名过期需要刷新，userSig 重新登陆（iOS不支持），onReConnFailed/断线重连失败（android不支持）
    code:0,            //数字类型；错误码，onReConnFailed返回，android不支持
   err:''              //字符串类型；错误信息，onReConnFailed返回，android不支持
}

err：

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

{
    msg: '',           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.setUserStatusListener({
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setConnectListener

监听链接状态

setConnectListener({params}, callback(ret))

params

callback(ret)

ret：

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

{
   status:,                       //布尔类型，是否成功
   action:'',               //字符串类型；链接状态；取值范围：‘connected’/链接成功，‘disConnected’/链接失败，‘wifiNeedAuth’/等待wifi链接(iOS不支持)，‘onDisconnect’/网络连接断开（android不支持），‘onConnecting’/连接中（android不支持）
   code:0,            //数字类型；错误码，disConnected、onDisconnect返回，android不支持
   err:''              //字符串类型；错误信息，disConnected、onDisconnect返回，android不支持
}

err：

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

{
    msg: '',           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.setConnectListener({
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setGroupEventListener

设置群组事件监听

setGroupEventListener({params}, callback(ret))

params

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
    tipsType:,            //数字类型；1/加入群组，2/主动退出群组，3/被踢出群组，4/设置管理员，5/取消管理员，6/修改群资料，7/修改群成员信息，8/新建群（iOS不支持），9/删除群（iOS不支持）
    opUser:'',          //字符串类型；操作者账号
    groupName:'',       //字符串类型；群组名称，iOS返回为群组 ID
    userList:[                 //Json数组类型；被操作账号集合
    '','','',
    ]
}

err：

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

{
    msg: '',           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.setGroupEventListener({
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

seConversationListener

设置会话监听

seConversationListener({params}, callback(ret))

params

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
    onRefresh:true,            //布尔类型，为false时刷新部分会话，否则conversations不会返回，仅支持iOS
    conversations:[{        //Json数组类型；刷新的会话
    peer:'',               //字符串类型；聊天标识，iOS单聊时为对方账号，群聊时为群组Id
    type:,               //数字类型；聊天类型；1/单聊会话，2/群组会话，3/系统会话  
    },
    ]
}

err：

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

{
    msg: '',           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.seConversationListener({
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

seMessageExtConfig

消息扩展设置

seMessageExtConfig({params}, callback(ret))

params

enableStorage：

• 类型：布尔类型
• 描述：（可选项）是否允许消息本地存储
• 默认：true

enableReadReceipt：

• 类型：布尔类型
• 描述：（可选项）是否开启消息已读回执
• 默认：true

enableRecentContact：

• 类型：布尔类型
• 描述：（可选项）是否开启漫游最近联系人
• 默认：true

enableAutoReport：

• 类型：布尔类型
• 描述：（可选项）是否开启自动已读上报
• 默认：true

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
}

err：

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

{
    msg: '',           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.seMessageExtConfig({
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

setMessageRevokedListener

添加消息撤回监听

setMessageRevokedListener({params}, callback(ret))

params

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
    conversationId:''        //字符串类型；撤回消息所在会话id
    conversationType:,    //数字类型；撤回消息会话类型，1/单聊，2/群聊，3/系统消息
    }

err：

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

{
    msg: '',           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.setMessageRevokedListener({
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setMessageReceiptListener

添加消息已读回执监听

setMessageReceiptListener({params}, callback(ret))

params

callback(ret)

ret：

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

{
    receipts[{ //json数组类型；已读回执列表
      conversationId:''        //字符串类型；已读消息所在会话id
      conversationType:,    //数字类型；已读消息会话类型，1/单聊，2/群聊，3/系统消息，目前只支持 C2C 会话
      timestamp:0          //数字类型；收到已读回执时，这个时间戳之前的消息都已读，目前只支持 C2C 会话
   }]
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.setMessageReceiptListener({
}, function(ret) {
    if (ret) {
       alert(JSON.stringify(ret));
    } 
});

可用性

iOS系统，Android系统

可提供的1.0.6及更高版本

login

登陆

login({params}, callback(ret))

params

identifier：

• 类型：字符串类型
• 描述：用户帐号

userSig：

• 类型：字符串类型
• 描述：用户帐号签名，由私钥加密获得

busiId：

• 类型：数字类型
• 描述：企业证书 ID，进入【基础配置】页面，在iOS 推送证书区域的（证书ID），此参数仅支持iOS

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
    token:,                        //布尔类型，是否为设置token返回
}

err：

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

{
    code:,            //数字类型；错误码
    msg: '',           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.login({
identifier:'',
userSig:'',
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

logout

登出

logout({params}, callback(ret))

params

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
}

err：

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

{
    code:,            //数字类型；错误码
    msg: '',           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.logout({
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

initStorage

初始化本地存储，在未登录的情况下加载本地存储。

initStorage({params}, callback(ret))

params

identifier：

• 类型：字符串类型
• 描述：用户账号

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.initStorage({
identifier
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

getLocalMessage

获取本地聊天记录

getLocalMessage({params}, callback(ret))

params

peer：

• 类型：字符串类型
• 描述：聊天标识（群组id 或对方账号）

type：

• 类型：数字类型
• 描述：聊天类型；1/单聊会话，2/群组会话，3/系统会话
• 默认：1

count：

• 类型：数字类型
• 描述：聊天记录条数

continue：

• 类型：布尔类型
• 描述：（可选项）是否获取上次获取的消息之前的消息，需要与上次获取时peer相同
• 默认值：false

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
    messages:[                 //JSON数组，信息
    {
    peer:'',               //字符串类型；聊天标识
    type:,               //数字类型；聊天类型；1/单聊会话，2/群组会话，3/系统会话
    msgId:‘’,            //字符串类型；messageId 当消息生成时，就已经固定
    uniqueId:,      //数字类型；当消息发送成功以后才能固定下来
    sender:'',       //字符串类型；发送者
    messageStatus:, //数字类型；消息状态；1/发送中，2/发送完成，3/发送失败，4/已删除，5/本地消息，6/已撤回,
    timestamp:,  //数字类型；发送时间，服务器生成时间
    seq:,              //数字类型；消息序列号
    isRead:,         //布尔类型；是否已读，iOS不支持
    isReaded:,         //布尔类型；自己是否已读，android不支持
    isPeerReaded:,         //布尔类型；对方是否已读，android不支持
    elems:[         //Json数组类型；根据内部字段type 分为文字消息、图片消息等内容详细信息请查看附录；1/文本消息,4/图片消息，5/语音消息，6/自定义消息，7/文件消息，9/群组消息，10/表情消息，11/位置消息，12/系统消息，15/视频消息
    ],
    groupName:'',       //字符串类型；群组名称，iOS不支持
    },
    {
    }
    ]
}

err：

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

{
    code:,            //数字类型；错误码
    msg: '',           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.getLocalMessage({
peer:'',
count:,
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getLoginUser

获取登陆账户

getLoginUser(callback(ret))

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
    user:'',                       //字符串类型；登陆的账户
}

err：

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

{
    msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.getLoginUser({
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getConversation

获取会话

getConversation({params}, callback(ret))

params

peer：

• 类型：字符串类型
• 描述：聊天标识（群组id 或对方账号）

type：

• 类型：数字类型
• 描述：聊天类型；1/单聊会话，2/群组会话，3/系统会话

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
    conversation:{
    peer:'',               //字符串类型；聊天标识
    type:,               //数字类型；聊天类型；1/单聊会话，2/群组会话，3/系统会话  
    }
}

err：

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

{
    msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.getConversation({
peer:'',
count:,
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

sendText

发送字符串信息

sendText({params}, callback(ret))

params

peer：

• 类型：字符串类型
• 描述：聊天标识（群组id 或对方账号）

type：

• 类型：数字类型
• 描述：聊天类型；1/单聊会话，2/群组会话，3/系统会话

text：

• 类型：字符串类型
• 描述：消息内容

onlineMessage：

• 类型：布尔类型
• 描述：(可选项)是否发送在线消息，iOS不支持
• 默认值：false

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
}

err：

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

{
code:,           //数字类型；错误码
msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.sendText({
peer:'',
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

sendImage

发送图片信息

sendImage({params}, callback(ret))

params

peer：

• 类型：字符串类型
• 描述：聊天标识（群组id 或对方账号）

type：

• 类型：数字类型
• 描述：聊天类型；1/单聊会话，2/群组会话，3/系统会话

imagePath：

• 类型：字符串类型
• 描述：图片路径，支持fs格式

imageLevel：

• 类型：数字类型
• 描述：发送图片质量
• 取值范围：0/原图，1/高压缩图，2/高清图
• 默认：0

onlineMessage：

• 类型：布尔类型
• 描述：(可选项)是否发送在线消息，iOS不支持
• 默认值：false

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
}

err：

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

{
code:,           //数字类型；错误码
msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.sendImage({
peer:'',
type:,
imagePath:'',
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

sendFace

表情消息发送，IM SDK 并不提供表情包，如果开发者有表情包，可使用 index 存储表情在表情包中的索引，由用户自定义，或者直接使用data存储表情二进制信息以及字符串 key，都由用户自定义，IM SDK 内部只做透传。

sendFace({params}, callback(ret))

params

peer：

• 类型：字符串类型
• 描述：聊天标识（群组id 或对方账号）

type：

• 类型：数字类型
• 描述：聊天类型；1/单聊会话，2/群组会话，3/系统会话

index：

• 类型：数字类型
• 描述：表情索引

faceData：

• 类型：字符串类型
• 描述：图片自定义数据base64字符串

onlineMessage：

• 类型：布尔类型
• 描述：(可选项)是否发送在线消息，iOS不支持
• 默认值：false

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
}

err：

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

{
code:,           //数字类型；错误码
msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.sendFace({
peer:'',
type:,
index:,
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

sendSound

发送语音消息

sendSound({params}, callback(ret))

params

peer：

• 类型：字符串类型
• 描述：聊天标识（群组id 或对方账号）

type：

• 类型：数字类型
• 描述：聊天类型；1/单聊会话，2/群组会话，3/系统会话

duration：

• 类型：数字类型
• 描述：语音时长

soundPath：

• 类型：字符串类型
• 描述：语音存储路径，支持fs路径

onlineMessage：

• 类型：布尔类型
• 描述：(可选项)是否发送在线消息，iOS不支持
• 默认值：false

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
}

err：

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

{
code:,           //数字类型；错误码
msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.sendSound({
peer:'',
type:,
duration:,
soundPath:'',
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

sendLocation

发送位置消息

sendLocation({params}, callback(ret))

params

peer：

• 类型：字符串类型
• 描述：聊天标识（群组id 或对方账号）

type：

• 类型：数字类型
• 描述：聊天类型；1/单聊会话，2/群组会话，3/系统会话

desc：

• 类型：字符串类型
• 描述：位置描述

longitude：

• 类型：小数类型
• 描述：经度

latitude：

• 类型：小数类型
• 描述：维度

onlineMessage：

• 类型：布尔类型
• 描述：(可选项)是否发送在线消息，iOS不支持
• 默认值：false

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
}

err：

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

{
code:,           //数字类型；错误码
msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.sendLocation({
peer:'',
type:,
desc:'',
longitude:,
latitude:,
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

sendFile

发送小文件

sendFile({params}, callback(ret))

params

peer：

• 类型：字符串类型
• 描述：聊天标识（群组id 或对方账号）

type：

• 类型：数字类型
• 描述：聊天类型；1/单聊会话，2/群组会话，3/系统会话

filePath：

• 类型：字符串类型
• 描述：文件路径，支持fs格式

fileName：

• 类型：字符串类型
• 描述：文件名称

onlineMessage：

• 类型：布尔类型
• 描述：(可选项)是否发送在线消息，iOS不支持
• 默认值：false

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
}

err：

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

{
    code:,           //数字类型；错误码
    msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.sendFile({
peer:'',
type:,
filePath:'',
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

sendCustom

发送自定义消息

sendCustom({params}, callback(ret))

params

peer：

• 类型：字符串类型
• 描述：聊天标识（群组id 或对方账号）

type：

• 类型：数字类型
• 描述：聊天类型；1/单聊会话，2/群组会话，3/系统会话

data：

• 类型：字符串类型
• 描述：自定义数据，Base64字符串

desc：

• 类型：字符串类型
• 描述：自定义描述

ext：

• 类型：字符串类型
• 描述：推送ext字段，Base64字符串，iOS为正常字符串

sound：

• 类型：字符串类型
• 描述：自定义声音数据，Base64字符串，iOS为正常字符串

onlineMessage：

• 类型：布尔类型
• 描述：(可选项)是否发送在线消息，iOS不支持
• 默认值：false

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
}

err：

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

{
    code:,           //数字类型；错误码
    msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.sendCustom({
peer:'',
type:,
data:'',
desc:'',
sound:'',
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

addNewMessageListener

添加新消息监听

addNewMessageListener({params}, callback(ret))

params

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
    isPushMsg,               //布尔类型，表示是否是远程推送而来的消息，本参数仅在iOS平台有效。
    messages:[               //Json数组类型；消息，只是本地曾经没有过的消息
    {
    peer:'',               //字符串类型；聊天标识
    type:,               //数字类型；聊天类型；1/单聊会话，2/群组会话，3/系统会话
    msgId:‘’,            //字符串类型；messageId 当消息生成时，就已经固定
    uniqueId:,      //数字类型；当消息发送成功以后才能固定下来
    sender:'',       //字符串类型；发送者
    messageStatus:, //数字类型；消息状态；1/发送中，2/发送完成，3/发送失败，4/已删除，5/本地消息，6/已撤回,
    timestamp:,  //数字类型；发送时间，服务器生成时间
    seq:,              //数字类型；消息序列号
    isRead:,         //布尔类型；是否已读
    elems:[         //Json数组类型；根据内部字段type 分为文字消息、图片消息等内容详细信息请查看附录；1/文本消息,4/图片消息，5/语音消息，6/自定义消息，7/文件消息，9/群组消息，10/表情消息，11/位置消息，12/系统消息，13/关系变更通知，15/视频消息
    ],
    groupName:'',       //字符串类型；群组名称，iOS不支持
    },]
}

err：

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

{
    code:,           //数字类型；错误码
    msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.addNewMessageListener({
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getConversations

获取所有会话

getConversations({params}, callback(ret))

params

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
    conversations:[        //Json数组；会话
    {
    peer:'',               //字符串类型；聊天标识
    type:,               //数字类型；聊天类型；1/单聊会话，2/群组会话，3/系统会话  
    }，
    ],
}

err：

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

{
    msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.getConversations({
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getMessage

获取聊天记录

getMessage({params}, callback(ret))

params

peer：

• 类型：字符串类型
• 描述：聊天标识（群组id 或对方账号）

type：

• 类型：数字类型
• 描述：聊天类型；1/单聊会话，2/群组会话，3/系统会话
• 默认：1

count：

• 类型：数字类型
• 描述：聊天记录条数

continue：

• 类型：布尔类型
• 描述：（可选项）是否获取上次获取的消息之前的消息，需要与上次获取时peer相同
• 默认值：false

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
    messages:[                 //JSON数组，信息
    {
    peer:'',               //字符串类型；聊天标识
    type:,               //数字类型；聊天类型；1/单聊会话，2/群组会话，3/系统会话
    msgId:‘’,            //字符串类型；messageId 当消息生成时，就已经固定
    uniqueId:,      //数字类型；当消息发送成功以后才能固定下来
    sender:'',       //字符串类型；发送者
    messageStatus:, //数字类型；消息状态；1/发送中，2/发送完成，3/发送失败，4/已删除，5/本地消息，6/已撤回,
    timestamp:,  //数字类型；发送时间，服务器生成时间
    seq:,              //数字类型；消息序列号
    isRead:,         //布尔类型；是否已读
    elems:[         //Json数组类型；根据内部字段type 分为文字消息、图片消息等内容详细信息请查看附录；1/文本消息,4/图片消息，5/语音消息，6/自定义消息，7/文件消息，9/群组消息，10/表情消息，11/位置消息，12/系统消息，15/视频消息
    ],
    groupName:'',       //字符串类型；群组名称，iOS不支持
    },
    { }
    ]
}

err：

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

{
    code:,            //数字类型；错误码
    msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.getMessage({
peer:'',
count:,
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

deleteConversation

删除会话

deleteConversation({params}, callback(ret))

params

peer：

• 类型：字符串类型
• 描述：聊天标识（群组id 或对方账号）

type：

• 类型：数字类型
• 描述：聊天类型；1/单聊会话，2/群组会话，3/系统会话
• 默认：1

delMessage：

• 类型：布尔类型
• 描述：是否删除消息记录
• 默认：true

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
}

err：

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

{
    msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.deleteConversation({
peer:'',
type:,
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

deleteLocalMessage

删除本地消息记录

deleteLocalMessage({params}, callback(ret))

params

peer：

• 类型：字符串类型
• 描述：聊天标识（群组id 或对方账号）

type：

• 类型：数字类型
• 描述：聊天类型；1/单聊会话，2/群组会话，3/系统会话
• 默认：1

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
}

err：

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

{
code:,              //数字类型；错误码
msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.deleteLocalMessage({
peer:'',
type:,
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getUnReadMessageNum

获取未读消息数量

getUnReadMessageNum({params}, callback(ret))

params

peer：

• 类型：字符串类型
• 描述：聊天标识（群组id 或对方账号）

type：

• 类型：数字类型
• 描述：聊天类型；1/单聊会话，2/群组会话，3/系统会话
• 默认：1

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
    count:,                     //数字类型；未读消息数量
}

err：

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

{
msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.getUnReadMessageNum({
peer:'',
type:,
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setRead

会话进行已读上报

setRead({params}, callback(ret))

params

peer：

• 类型：字符串类型
• 描述：聊天标识（群组id 或对方账号）

type：

• 类型：数字类型
• 描述：聊天类型；1/单聊会话，2/群组会话，3/系统会话
• 默认：1

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
}

err：

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

{
code:,          //数字类型；错误码
msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.setRead({
peer:'',
type:,
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

createGroup

创建群组

createGroup({params}, callback(ret))

params

groupType：

• 类型：字符串类型
• 描述：群组类型
• 取值范围：私有群（Private）、公开群（Public）、 聊天室（ChatRoom）、音视频聊天室（AVChatRoom）和在线成员广播大群（BChatRoom）

groupName：

• 类型：字符串类型
• 描述：群组名称

groupId：

• 类型：字符串类型
• 描述：（可选项）群id

notification：

• 类型：字符串类型
• 描述：（可选项）群公告

introduction：

• 类型：字符串类型
• 描述：（可选项）群简介

faceUrl：

• 类型：字符串类型
• 描述：（可选项）群头像url

maxMemberNum：

• 类型：数字类型
• 描述：（可选项）最大成员数

groupAddOpt：

• 类型：数字类型
• 描述：添加群条件
• 取值范围：0/禁止添加，1/群主邀请，2/任何人都可以添加
• 默认值：2

members：

• 类型：Json数组类型
• 描述：（可选项）初始成员，iOS不支持

• 内部字段：

  ['',         //字符串类型，成员账号
  '',
  ''
  ]

membersInfos：

• 类型：Json数组类型
• 描述：（可选项）初始成员，android不支持

• 内部字段：

  [{'成员账号':'成员角色'}]
  成员角色取值如下：
  0：群成员
  1：群管理员
  2：群主

customInfo：

• 类型：Json对象类型
• 描述：（可选项）自定义信息，设置群自定义字段，需要先到控制台配置相应的 key

• • 内部字段：

    {'key':'value', 
    'key1':'value', 
    }

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
    groupId:'',                 //字符串类型；群id
}

err：

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

{
code:,          //数字类型；错误码
msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.createGroup({
groupName:'',
groupType:,
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

inviteGroupMember

邀请用户进群， 私有群：群成员无需受邀用户同意，直接将其拉入群中。 公开群/聊天室：不允许群成员邀请他人入群。只能由 App 管理员通过 REST API 邀请他人入群。 音视频聊天室：不允许任何人（包括 App 管理员）邀请他人入群。

inviteGroupMember({params}, callback(ret))

params

groupId：

• 类型：字符串类型
• 描述：群id

members：

• 类型：Json数组类型
• 描述：邀请成员

• 内部字段：

  ['',         //字符串类型，成员账号
  '',
  ''
  ]

  callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
    results:[                    //添加结果
    { member:'',       //字符串类型；成员
      result:,              //数字类型；添加结果，0:添加失败；1：添加成功；2：原本是群成员，3：等待对方处理（android不支持）
    }
    ]
}

err：

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

{
code:,          //数字类型；错误码
msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.inviteGroupMember({
groupId:'',
members:[],
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

applyJoinGroup

申请入群

1. 私有群：不能由用户主动申请入群。
2. 公开群、聊天室：可以主动申请进入。
3. 直播大群：可以任意加入群组。
4. 如果群组设置为需要审核，调用doGroupPendency接口同意或者拒绝入群
5. 如果群主设置为任何人可加入，则直接入群成功。

applyJoinGroup({params}, callback(ret))

params

groupId：

• 类型：字符串类型
• 描述：群id

reason：

• 类型：字符串类型
• 描述：入群原因

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否申请成功
}

err：

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

{
code:,          //数字类型；错误码
msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.applyJoinGroup({
groupId:'',
reason:‘’,
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

quitGroup

退出群组，私有群：全员可退出群组。公开群、聊天室和直播大群：群主不能退出。

quitGroup({params}, callback(ret))

params

groupId：

• 类型：字符串类型
• 描述：群id

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
}

err：

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

{
code:,          //数字类型；错误码
msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.quitGroup({
groupId:'',
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

deleteGroupMember

删除群组成员，私有群：只有创建者可删除群组成员。公开群和聊天室：只有管理员和群主可以踢人。直播大群：不能踢人。

deleteGroupMember({params}, callback(ret))

params

groupId：

• 类型：字符串类型
• 描述：群id

members：

• 类型：Json数组类型
• 描述：要删除的成员

• 内部字段：

  ['',         //字符串类型，成员账号
  '',
  ''
  ]

  reason：

• 类型：字符串类型

• 描述：(可选项删除原因

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
    results:[                    //删除结果
    { member:'',       //字符串类型；成员
      result:,              //数字类型；添加结果，0:删除失败；1：删除成功；2：不是群成员
    }
    ]
}

err：

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

{
code:,          //数字类型；错误码
msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.deleteGroupMember({
groupId:'',
members:[],
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getGroupMembers

获取群成员列表

getGroupMembers({params}, callback(ret))

params

groupId：

• 类型：字符串类型
• 描述：群id

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否申请成功
    members:[                    //删除结果
    { member:'',           //字符串类型；成员
      joinTime:,              //数字类型；加入时间
      role:,                     //数字类型；群内角色
    }
    ]
}

err：

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

{
code:,          //数字类型；错误码
msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.getGroupMembers({
groupId:'',
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getGroupList

获取加入群组列表

getGroupList({params}, callback(ret))

params

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
    groups:[                    //Jsong数组类型；已添加群组
    { groupId:'',           //字符串类型；群id
      groupName:'',       //字符串类型；群组名称
      groupType:'',          //字符串类型；群组类型
      faceUrl:'',              //字符串类型；群组头像
      isSilenceAll:,        //布尔类型；是否设置了全员禁言
    }
    ]
}

err：

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

{
code:,          //数字类型；错误码
msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.getGroupList({
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

deleteGroup

解散群组, 对于私有群：任何人都无法解散群组。 对于公开群、聊天室和直播大群：群主可以解散群组。

deleteGroup({params}, callback(ret))

params

groupId：

• 类型：字符串类型
• 描述：群id

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
}

err：

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

{
code:,          //数字类型；错误码
msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.deleteGroup({
groupId:'',
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

modifyGroupOwner

转让群组

modifyGroupOwner({params}, callback(ret))

params

groupId：

• 类型：字符串类型
• 描述：群id

identifier：

• 类型：字符串类型
• 描述：新群主账号

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
}

err：

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

{
code:,          //数字类型；错误码
msg: ‘’,           //字符串类型；错误信息
}

示例代码

var tencentIm = api.require('tencentIm');
tencentIm.modifyGroupOwner({
groupId:'',
identifier:'',
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getGroupDetailInfo

查询群组资料，在群组内使用此接口

getGroupDetailInfo({params}, callback(ret))

params

groupIds：

• 类型：Json数组
• 描述：查询群组id数组

callback(ret)

ret：

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

{
    status:,                       //布尔类型，是否成功
    groupInfos:[            //Json数组，群组信息
    {groupId:'',             //字符串类型；群组id
    groupName:'',          //字符串类型；群组名称
    groupOwner:'',        //字符串类型；群主账号
    createTime:,           //数字类型；创建时间
    lastInfoTime:,         //数字类型；最后群组信息修改时间
    lastMsgTime:,         //数字类型；最后消息时间
    memberNum:,        //数字类型；成员数量
    maxMemberNum:,    //数字类型；最大成员数量
    groupIntroduction:'',     //字符串类型；群简介
    groupNotification:'',       //字符串类型；群公告
    faceUrl:'',                        //字符串类型；群头像类型
    groupType:'',                //字符串类型；群类型
    onlineMemberNum:,     //数字类型；在线群成员数量
    isSilenceAll:,                  //布尔类型；是否全部群成员禁言
    lastMsg:{                      //Json对象类型；最新一条消息，iOS不支持
          peer:'',               //字符串类型；聊天标识
          type:,               //数字类型；聊天类型；1/单聊会话，2/群组会话，3/系统会话
          msgId:‘’,            //字符串类型；messageId 当消息生成时，就已经固定
          uniqueId:,      //数字类型；当消息发送成功以后才能固定下来
          sender:'',       //字符串类型；发送者
          messageStatus:, //数字类型；消息状态；1/发送中，2/发送完成，3/发送失败，4/已删除，5/本地消息，6/已撤回,
          timestamp:,  //数字类型；发送时间，服务器生成时间
          seq:,              //数字类型；消息序列号
          isRead:,         //布尔类型；是否已读
          elems:[         //Json数组类型；根据内部字段type 分为文字消息、图片消息等内容详细信息请查看附录；1/文本消息,4/图片消息，5/语音消息，6/自定义消息，7/文件消息，9/群组消息，10/表情消息，11/位置消息，12/系统消息，15/视频消息
          ],
          groupName:'',       //字符串类型；群组名称，iOS不支持
    },
    }
    ]
}