thunbu-im-sdk v1.0.7-alpha

Thunbu IM JSSdk 文档

快速开始

闪布IM JSSDK （Javascript SDK）可以使用在PC/移动网页端应用，也可以使用在Electron、RN、小程序等跨平台应用中，提供全面而完善的即时通讯开发能力，使开发人员通过简单快速的对接集成即时通讯的功能。

1、接入sdk

2、初始化SDK

3、登入

4、消息收发

5、业务相关、历史消息等

6、登出

集成方式

标签引入

<script src="https://flashchart-oss.oss-cn-hangzhou.aliyuncs.com/web-assets/js/shanliao-sdk/0.0.3/thunbuim-web-sdk.js"></script>

这样的话可以使用全局对象 window.SIM 获取sdk的引用。

npm 下载

使用

npm install thunbu-im-sdk --save

或

yarn add thunbu-im-sdk

从远程仓库上下载SDK

使用从远程仓库下载的SDK将附带有Typescript支持，使用标签引入或者文件引入的，也可以移步闪布开发者平台 下载.d.ts文件以获取Typescript支持

Demo 支持

在闪布开发者平台站点上，包含现有SDK的使用实例

实例源代码

浏览器兼容性

因为在某些浏览器内单个方法版本另有差异，这样就导致即使在主流浏览器的低版本中，也有可能出现单个websocket不支持从而出错，详情参见MDN Websocket，当浏览器不兼容时

SIM.init(config, onSuccess, onFail);
// 或者
new SIM({});

会返回一个错误SCOKET_ENOTSUP（-1000）。

小程序接入

小程序相关接入方式需联系开发人员进行沟通集成

初始化

初始化SDK

在所有事情开始之前，必须要先将SIM对象初始化，告诉SIM相关配置是什么，如果是web端，apiBaseUrl 如果传全路径可能会报跨域的问题，这个时候也可以传代理路径，不需要传全路径也可以正常工作，会将接口请求到当前域下的代理路径

从 npm 下载

import SIM from 'thunbu-im-sdk';

const SIMInstance = new SIM({
    serverip: 'ws://localhost:3000/test', // websocket 地址
    apiBaseUrl: 'http://localhost:9000/', // IM http 业务接口访问地址
    debug: false // 是否打开控制台
});

标签引入模式

const SIMInstance = new window.SIM({
    serverip: 'ws://localhost:3000/test', // websocket 地址
    apiBaseUrl: 'http://localhost:9000/', // IM http 业务接口访问地址
    debug: false // 是否打开控制台
});

在初始化成功后，会执行相应的回调方法，若是失败，则会在失败的回调中告知错误原因。

详见错误码列表

监听SIM方法

在初始化完成之后，可以监听由SIM提供的事件

从 npm 下载

    SIMInstance.addEventListener('msg', function (msg) {
    console.log('notice: ', msg); // 接收到新消息
});
SIMInstance.addEventListener('notice', function (res) {
    console.log('notice: ', res); // 接收到通知消息
});
SIMInstance.addEventListener('msgChange', function (res) {
    console.log('msgChange: ', res); // 消息变化通知
});
SIMInstance.addEventListener('connectChange', function (status) {
    console.log('connectChange: ', status); // 链接状态变更
});

标签引入模式

    window.SIM.addEventListener('msg', function (msg) {
    console.log('notice: ', msg); // 接收到新消息
});
window.SIM.addEventListener('notice', function (res) {
    console.log('notice: ', res); // 接收到通知消息
});
window.SIM.addEventListener('msgChange', function (res) {
    console.log('msgChange: ', res); // 消息变化通知
});
window.SIM.addEventListener('connectChange', function (status) {
    console.log('connectChange: ', status); // 链接状态变更
});

登录

登入

在初始化完成之后，开发人员需要操作SIM来告知SDK需要登录到IM服务器了，在通过相关服务（可能是私有化部署的本地后台服务，也可能是闪布服务，具体服务地址视后台地址决定）鉴权后，就可以开始登录IM服务器了~

SIMInstance.login({
    userId: "userId", // 用户ID
    userSig: "userSig", // 用户凭证
    appId: "appId", // 应用ID
    terminal: "terminal", // 终端类型，0为mobile,1为pc或web端
    appversion: "appversion", // 应用版本号
}).then(() => {
    console.log('login success!');
}).catch((err) => {
    console.log('login error! ', err);
});

登录成功之后，会执行相应的回调方法，若是登录失败，则会在失败的回调中告知原因

详见错误码列表

登出

退出登录功能

SIMInstance.logout().then(() => {
    console.log('logout success!');
}).catch((err) => {
    console.log('logout error! ', err);
});

我们来简单的发个消息

我们使用SIM提供的sendMsg方法来完成给小伙伴发消息~

SIMInstance.sendMsg({
    type: 0, // 这里我们定义的 0 就代表是文本消息
    message: { // 消息体内容
        text: 'hello world!' // 文本消息
    },
    receiver: "9527", // 将消息发送给TA，消息的接收者
    securityType: 0, // 安全类型 默认是0
    cross: 0, // 是否跨域
    sender: "9528", // 发送者的ID，你发送的就是你自己咯
    chatType: 0, // 你和Ta的会话类型，单聊为0， 群聊为1
}).then((msgId) => {
    console.log('sendMsg success!', msgId);
}).catch((err) => {
    console.log('sendMsg error! ', err);
});

发送消息后，如果另一端已经处于登录状态并且已经监听了SIM提供的几个事件的话，则会打印出相应的消息体，就已经完成了最基本的消息收发啦🎇

恭喜您！在经过简单的配置之后，终于可以开始发送/接收消息了~ 下面， 我们就可以开始扩展应用的更多功能了！

注意⚠️

我们在后续版本将基于npm进行版本管理，若是需要标签引入的源代码，则可联系客服或者对接人员提供

因为标签引入的模式不利于长期维护以及类型支持，并且我们的文档也是基于npm发布版本的内容进行讲解，包含JavaScript的新特性，所以推荐工程项目内都使用npm下载

基础方法与事件交互

介绍SIM提供的基础方法，包含登入登出、消息发送、事件监听、工具方法等

基础方法

SIM初始化

初始化SIM，在登录之前

类型定义

type SIMInitParams = {
    apiBaseUrl: boolean,
    serverip: boolean,
    debug?: boolean
}

Demo 例子🌰

const SIMInstance = new SIM({
    apiBaseUrl: '/base-api',
    serverip: 'wss://ws.test.com'
}).then(() => {
    console.log('SIM init Success');
}).catch((err) => {
    console.error('SIM init Error:', err);
})

方法参数

SIMInitParams 对象类型

登录SIM： login

使用websocket登录至IM服务器

类型定义

type SIMLoginParams = {
    appId: string,
    userId: string,
    userSig: string,
}

type EmptyFun = (...arg: any) => void;

type login = (parms: SIMLoginParams) => Promise<string>

Demo 例子🌰

SIMInstance.login({
    appId: '1',
    userId: '9527',
    userSig: 'wo-shi-yi-dui-zi-fu-chuan'
}).then(() => {
    console.log('SIM login Success');
}).catch((err) => {
    console.error('SIM login Error:', err);
})

方法参数

SIMLoginParams-对象类型

登出： logout

用户登出 SIM

类型定义

type EmptyFun = (...arg: any) => void;

type logout = (onSuccess?: EmptyFun, onFail?: EmptyFun) => Promise<void>;

Demo 例子🌰

SIMInstance.login().then(() => {
    console.log('SIM logout Success');
}).catch((err) => {
    console.error('SIM logout Error:', err);
})

返回值

Promise<void>

方法参数

无

检查链接情况： testOnLine

检查websocket与服务器链接状态， 该函数并没有返回值，如果检测到连接终端，则会通过事件通知

类型定义

type testOnLine = (delay: number = 300) => void;

Demo 例子🌰

SIMInstance.testOnLine();

方法参数

事件交互

SIM 的变更事件都会通过事件机制反馈给开发者

绑定事件： addEventListener

Demo 例子🌰

SIMInstance.addEventListener('msg', () => {
    console.log('on message:', msg);
});

SIMInstance.addEventListener('notice', (notice) => {
    console.log('on notice:', notice);
});

解绑事件： removeEventListener

可以解绑的事件和可以绑定的事件名称可取值是一样的

类型定义

type removeEventListener = (eventName?: string, callback?: AnyFuncion) => void;

Demo 例子🌰

SIMInstance.removeEventListener('msg', () => {
    console.log('on message:', msg);
});

注意⚠️，如果不传 eventName 或者 eventName为空字符串，SIM将会认为程序需要将所有的监听事件都清除掉，所以务必保证知晓参数完整的必要性

utils - 工具集

在SIM中，我们提供了一些简易的工具集以供开发人员使用

获取uuid： getGuid

通过获取n位随机字符串生成的唯一ID

类型定义

getGuid: (length?: number) => string;

Demo

SIMInstance.utils.getGuid(4);

返回参数

获取图片类型： getImgFormat

通过获取到的文件路径来确定图片类型（主要是根据文件名的后缀）

返回0|1|255 对应不同的图片类型

类型定义

getImgFormat: (filePath: string) => 0 | 1 | 255;

Demo 例子🌰

SIMInstance.utils.getImgFormat("C:\test.png"); // return: 1

返回参数

获取文件类型： getFileFormat

通过获取到的问年间路径来确定文件类型（主要根据文件类型）

返回对应的文件类型

类型定义

getFileFormat: (filePath: string) => 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 255;

Demo 例子🌰

SIMInstance.utils.getImgFormat("C:\test.png"); // return: 3

返回值

IM 统一类型定义

Socket状态码

enum IM_Status {
    /** 成功：200 */
    SUCCEED = 200,
    /** 参数正确：0 */
    ARGS_CORRECT = 0,
    /** 参数错误：-1 */
    ARGS_ERROR = -1,
    /** 未知错误：-99 */
    ERROR_UNKNOWN = -99,
    /** 网络连接中断：-100 */
    NETWORK_OFFLINE = -100,
    /** 请求超时：-101 */
    REQUEST_TIMEOUT = -101,
    /** 不支持h5：-1000 */
    SCOKET_ENOTSUP = -1000,
    /** 连接超时：-1001 */
    SCOKET_TIMEOUT = -1001,
    /** 已连接：-1002 */
    SCOKET_CONNECT = -1002,
    /** 连接中：-1003 */
    SCOKET_CONNECTING = -1003,
    /** 未连接：-1004 */
    SCOKET_UNCONNECT = -1004,
    /** 连接失败：-1005 */
    SCOKET_CONNECT_ERROR = -1005,
    /** 并发太高：-1006 */
    SCOKET_COUNT_ERROR = -1006,
    /** 登陆中：-1100 */
    LOGIN_LOGINING = -1100,
    /** 重复登陆：-1101 */
    LOGIN_REPEAT = -1101,
    /** 未登陆：-1102 */
    LOGIN_NOTLOGIN = -1102
}

IM command 枚举

enum IMCommandEnum {
    CMD_HB = 0,
    /** 命令-登陆：1 */
    CMD_LOGIN = 1,
    /** 命令-登出：2 */
    CMD_LOGOUT = 2,
    /** 命令-上线通知：3 */
    CMD_CONNECT_ONLINE_NOTICE = 3,
    /** 命令-上传终端设备信息：7 */
    CMD_UPLOAD_TERMINAL = 7,
    /** 命令-下线通知：8 */
    CMD_CONNECT_OFFLINE_NOTICE = 8,
    /** 命令-消息：20 */
    CMD_MSG = 20,
    /** 命令-消息-服务端回执：21 */
    CMD_MSG_S_RES = 21,
    /** 命令-消息-客户端回执：22 */
    CMD_MSG_C_RES = 22,
    /** 命令-消息-已读：23 */
    CMD_MSG_READ = 23,
    /** 命令-消息-撤回：24 */
    CMD_MSG_REVOCATION = 24,
    /** 命令-消息-用户删除：25 */
    CMD_MSG_DELETE = 25,
    /** 命令-消息-管理员删除：26 */
    CMD_MSG_ADMIN_DELETE = 26,
    /** 命令-消息-标记-增加：27 */
    CMD_MSG_ADD_TAG = 27,
    /** 命令-消息-标记-删除：28 */
    CMD_MSG_DEL_TAG = 28,
    /** 命令-消息-音视频：29 */
    CMD_MSG_AV = 29,
    /** 命令-离线消息-查询：30 */
    CMD_OFFLINE_MSG_INQUIRE = 30,
    /** 命令-离线消息-回执：31 */
    CMD_OFFLINE_MSG_RECEIPT = 31,
    /** 命令-消息-回复数量变更：33 */
    CMD_MSG_REPLYCOUNT_CHANGE = 33,
    /** 已读通知（服务端发送给消息发送者)= 34 **/
    CMD_MSG_READ_NOTICE = 34,
    /** 主动拉取已读通知（客户端主动拉取已读通知)= 35 **/
    CMD_MSG_GETREAD_NOTICE = 35,
    /** 命令-聊天室-获取列表：50 */
    CMD_CHAT_LIST_GIT = 50,
    /** 命令-聊天室-创建通知：51 */
    CMD_CHAT_CREATE_NOTICE = 51,
    /** 命令-聊天室-免打扰设置：52 */
    CMD_CHAT_DISTURB_CHANGE_SET = 52,
    /** 命令-聊天室-免打扰变更通知：53 */
    CMD_CHAT_DISTURB_CHANGE_NOTICE = 53,
    /** 命令-聊天室-会话消息计数重置：54 */
    CMD_CHAT_MSG_COUNT_SET = 54,
    /** 命令-聊天室-会话消息计数重置通知：55 */
    CMD_CHAT_MSG_COUNT_NOTICE = 55,
    /** 命令-聊天室-获取置顶列表：56 */
    CMD_CHAT_TOP_LIST_GIT = 56,
    /** 命令-聊天室-会话置顶设置：57 */
    CMD_CHAT_TOP_SET = 57,
    /** 命令-聊天室-置顶变更通知：58 */
    CMD_CHAT_TOP_CHANGE_NOTICE = 58,
    /** 命令-聊天室-设置会话不可见通知：59 */
    CMD_CHAT_DELETE_NOTICE = 59,
    /** 命令-聊天室-名称变更：60 */
    CMD_CHAT_NAME_SET = 60,
    /** 命令-聊天室-名称变更通知：61 */
    CMD_CHAT_NAME_CHANGE_NOTICE = 61,
    /** 命令-聊天室-彻底删除通知：62 */
    CMD_CHAT_THOROUGH_DELETE_NOTICE = 62,
    /** 命令-自定义通知：99 */
    CMD_CUSTOOM_NOTICE = 99,
    /** 命令-用户相关-账户信息修改：100 */
    CMD_USER_DETAILS_SET = 100,
    /** 命令-用户相关-账户信息修改通知：101 */
    CMD_USER_DETAILS_CHANGE_NOTICE = 101,
    /** 命令-好友相关-好友申请通知：108 */
    CMD_FRIEND_APPLY_NOTICE = 108,
    /** 命令-好友相关-好友添加成功通知：109 */
    CMD_FRIEND_APPLY_ADD_NOTICE = 109,
    /** 命令-好友相关-好友申请答复通知：110 */
    CMD_FRIEND_APPLY_RESULT_NOTICE = 110,
    /** 命令-好友相关-删除好友：111 */
    CMD_FRIEND_DELETE = 111,
    /** 命令-好友相关-删除好友通知：112 */
    CMD_FRIEND_DELETE_NOTICE = 112,
    /** 命令-好友相关-好友备注修改通知：113 */
    CMD_FRIEND_REMARK_CHANGE_NOTICE = 113,
    /** 命令-好友相关-删除所有好友通知：116 */
    CMD_FRIEND_DELETE_ALL_NOTICE = 116
}

IM 消息体类型

enum MsgTypeEnum {
    Msg_Text = 0,
    Msg_Pic = 1,
    Msg_Audio = 2,
    Msg_Video = 3,
    Msg_File = 4,
    Msg_Read = 5,
    Msg_Withdraw = 6,
    Msg_Delete = 7,
    Msg_MergeForward = 8,
    Msg_GroupVVC = 9,
    Msg_SingleVVC = 10,
    Msg_CustomEmoji = 11,
    Msg_Extra = 10000,
    Msg_Announcement = 20007
}

IM 消息处理

与IM交互，收发、处理IM消息

发送消息：sendMsg

发送即时消息的方法，基本类型以及自定义类型都已经有定义好消息格式

格式详见全局类型定义(#IM 消息体类型)

类型定义

type sendMsg = <T extends SendNormalMsgTypeEnum>(params: SendMsgItem<T>) => Promise<string>

Demo 例子🌰

SIMInstance.sendMsg({
    message: {
        text: 'hello world~',
    },
    receiver: '110',
    securityType: 0,
    chatType: 0,
    cross: 0,
    type: 0,
}).then((messageId) => {
    console.log('send message success! message id is: ', messageId);
}).catch((err) => {
    console.error('send message Error! err:', err);
})

方法参数

SendMsgItem-对象类型

该对象有泛型参数

interface SendMsgItem<T extends SendNormalMsgTypeEnum> {
		receiver: string,
		message: SendMsgContentType<T>,
		securityType: 0|1,
		chatType: ChatTypeEnum,
		cross: 0|1,
		type: T,
		domain?: SendMsgDomainType,
		time?: number,
		groupType?: 0|1|2,
		offlinePush?: boolean,
		offlinePushInfo?: string,
	}

对象成员

SendMsgContentType-对象类型

通过传入的泛型来确认返回的类型，泛型的取值范围是：SendNormalMsgTypeEnum

export type SendMsgContentTypes = {
    [SendNormalMsgTypeEnum.Msg_Text]: SendTextMsgContentType,
    [SendNormalMsgTypeEnum.Msg_Pic]: SendPicMsgContentType,
    [SendNormalMsgTypeEnum.Msg_Audio]: SendAudioMsgContentType,
    [SendNormalMsgTypeEnum.Msg_Video]: SendVideoMsgContentType,
    [SendNormalMsgTypeEnum.Msg_File]: SendFileMsgContentType,
    [SendNormalMsgTypeEnum.Msg_MergeForward]: SendMergeForwardContentType,
    [SendNormalMsgTypeEnum.Msg_CustomEmoji]: SendCustomEmojiContentType,
    [SendNormalMsgTypeEnum.Msg_Extra]: SendExtraMsgContentType,
}
type SendMsgContentType<T extends SendNormalMsgTypeEnum> = SendMsgContentTypes[T];

对象成员

SendNormalMsgTypeEnum-对象类型

/** 发送消息时声明的类型 - 以下类型可以发送 */
export enum SendNormalMsgTypeEnum {
    Msg_Text = 0, //: '文本',
    Msg_Pic = 1, //: '图片',
    Msg_Audio = 2, //: '语音',
    Msg_Video = 3, //: '视频',
    Msg_File = 4, //: '文件',
    Msg_MergeForward = 8, //: '合并转发',
    Msg_CustomEmoji = 11, //: '自定义表情类型',
    Msg_Extra = 10000, //: '扩展类消息',
}

对象成员

ChatTypeEnum-枚举类型

enum ChatTypeEnum {
    SingleChat,
    GroupChat,
    SubscribeChat,
    SubscribeBoxChat = 10,
}

对象成员

SendTextMsgContentType-对象类型

发送文本消息体的内容

export interface SendTextMsgContentType {
    text: string,
    /** @ 的人员列表 */
    members?: string[]
}

对象成员

SendPicMsgContentType-对象类型

发送图片消息体的内容

export interface SendPicMsgContentType {
    /** 0-JPG，1-PNG，225-未知类型 */
    format: 0 | 1 | 255,
    imageList: {
        /** 0-原图  1-缩略大图  2-缩略小图 */
        type: 0 | 1 | 2,
        url: string,
        size: number,
        width: number,
        height: number
    }[]
}

对象成员

SendAudioMsgContentType-对象类型

发送音频文件消息体的内容

export interface SendAudioMsgContentType {
    size: number,
    /** 类型 */
    format: number,
    /** 时长 - 秒 */
    duration: number,
    /** 下载地址 */
    downUrl: string
}

对象成员

SendVideoMsgContentType-对象类型

发送视频文件消息体的内容

    export interface SendVideoMsgContentType {
    /** 视频地址 */
    videoUrl: string,
    /** 视频大小 - b */
    videoSize: number,
    /** 视频时长 - 毫秒 */
    duration: number,
    /** 0-AVI，1-RM，2-RMVB，3-WMV，4-MP4，225-未知类型 */
    videoFormat: 0 | 1 | 2 | 3 | 4 | 255,
    /** 封面地址 */
    coverUrl: string,
    /** 封面宽度 - px */
    coverWidth: number,
    /** 封面高度 - px */
    coverHeight: number,
    /** 封面大小 - kb */
    coverSize: number,
    /** 封面类型，0-JPG，1-PNG，225-未知类型 */
    coverFormat: 0 | 1 | 255,
}

对象成员

SendFileMsgContentType-对象类型

发送文件消息体的内容

export interface SendFileMsgContentType {
    /** 文件类型 */
    format: FileFormatEnum,
    /** 文件大小 - b */
    size: number,
    /** 下载地址 */
    downUrl: string,
    /** 文件名称 */
    filename: string,
}

对象成员

SendMergeForwardContentType-对象类型

发送合并转发消息体的内容

export interface SendMergeForwardContentType {
    title: string,
    content: string,
    ids: string[],
    chatType: ChatTypeEnum,
}

对象成员

SendCustomEmojiContentType-对象类型

发送自定义表情消息体的内容

export interface SendCustomEmojiContentType {
    imgMd: string,
    imgUrl: string,
    size: number,
    width: number,
    height: number
}

对象成员

SendExtraMsgContentType-对象类型

发送自定义消息体的内容

export interface SendExtraMsgContentType {
    data: string // 自行解析，各端约定好
}

已读消息：readMsg

将消息设为已读

类型定义

type readMsg = (params: ReadMsgParamsType) => Promise<string>

Demo 例子🌰

SIMInstance.readMsg({
    id: 'messageID~~~~~~',
    receiver: '110',
    securityType: 0,
    chatType: 0,
    cross: 0,
}).then((messageId) => {
    console.log('readMsg message success! message id is: ', messageId);
}).catch((err) => {
    console.error('readMsg message Error! err:', err);
})

方法参数

ReadMsgParamsType-对象类型

发送已读消息的参数

export interface ReadMsgParamsType {
    id: string,
    chatType: ChatTypeEnum,
    securityType: 0 | 1,
    cross: 0 | 1,
    receiver: string,
    time?: number
}

对象成员

撤回消息： revocationMsg

将消息撤回

类型定义

type revocationMsg = (params: RevocationMsgParamsType)
:
Promise<string>

Demo 例子🌰

SIMInstance.revocationMsg({
    id: 'messageID~~~~~~'
    receiver: '110',
    securityType: 0,
    chatType: 0,
    cross: 0,
}).then((messageId) => {
    console.log('revocationMsg message success! message id is: ', messageId);
}).catch((err) => {
    console.error('revocationMsg message Error! err:', err);
})

方法参数

RevocationMsgParamsType-对象类型

发送撤回消息的参数

export interface RevocationMsgParamsType {
    id: string,
    chatType: ChatTypeEnum,
    securityType: 0 | 1,
    cross: 0 | 1,
    receiver: string,
    time?: number
}

对象成员

获取消息已读状态：fetchMsgReadState

获取消息的已读状态

类型定义

type fetchMsgReadState = (params: FetchMsgReadParamsType)
:
Promise<string>

Demo 例子🌰

SIMInstance.fetchMsgReadState({
    id: 'messageID~~~~~~'
    receiver: '110',
    securityType: 0,
    chatType: 0,
    cross: 0,
    msgType: 0,
}).then((messageId) => {
    console.log('fetchMsgReadState message success! message id is: ', messageId);
}).catch((err) => {
    console.error('fetchMsgReadState message Error! err:', err);
})

方法参数

FetchMsgReadParamsType-对象类型

获取消息的已读状态的参数

    export interface FetchMsgReadParamsType {
    id: string,
    chatType: ChatTypeEnum,
    securityType: 0 | 1,
    cross: 0 | 1,
    receiver: string,
    msgType: MsgTypeEnum,
    time?: number
}

对象成员

删除消息：deleteMsg

删除消息

类型定义

type deleteMsg = (params: DeleteMsgParamsType)
:
Promise<string>

Demo 例子🌰

SIMInstance.deleteMsg({
    id: 'messageID~~~~~~'
    receiver: '110',
    securityType: 0,
    chatType: 0,
    cross: 0,
    msgType: 0,
    delType: 1,
}).then((messageId) => {
    console.log('deleteMsg message success! message id is: ', messageId);
}).catch((err) => {
    console.error('deleteMsg message Error! err:', err);
})

deleteMsg-方法参数

DeleteMsgParamsType-对象类型

删除消息参数

    export interface FetchMsgReadParamsType {
    id: string,
    chatType: ChatTypeEnum,
    securityType: 0 | 1,
    cross: 0 | 1,
    receiver: string,
    msgType: MsgTypeEnum,
    time?: number,
    delType?: 0 | 1,
}

对象成员

获取离线消息：getOfflineMsg

获取离线消息-得到历史消息后会触发msg事件

类型定义

type getOfflineMsg = (params: GetOffLineMsgParamsType)
:
Promise<string>

Demo 例子🌰

SIMInstance.getOfflineMsg({
    queryType: 0
}).then((messageId) => {
    console.log('getOfflineMsg message success! message id is: ', messageId);
}).catch((err) => {
    console.error('getOfflineMsg message Error! err:', err);
})

getOfflineMsg-方法参数

GetOffLineMsgParamsType-对象类型

获取离线消息方法参数

    export interface FetchMsgReadParamsType {
    lastMsgTime?: number,
    loginTime?: number,
    tId?: string,
    queryType: 0 | 1 | 2,
}

对象成员

初始化会话消息统计数量：initMessageCount

初始化会话消息统计数量

类型定义

type initMessageCount = (params: SendInitMessageCountParams)
:
Promise<string>

Demo 例子🌰

SIMInstance.initMessageCount({
    chatId: '123123',
    chatType: 0,
    securityType: 0,
}).then((messageId) => {
    console.log('initMessageCount success! message id is: ', messageId);
}).catch((err) => {
    console.error('initMessageCount Error! err:', err);
})

方法参数

SendInitMessageCountParams-对象类型

初始化会话消息统计数量方法参数

    export interface SendInitMessageCountParams {
    chatId: string,
    chatType: ChatTypeEnum,
    securityType: 0 | 1,
    time?: number
}

对象成员

HTTP 业务相关接口

业务相关接口主要分为以下几个部分

群组相关接口

通过http接口来操作IM中的群组相关功能

获取所有群聊： getAllUserGroup

获取当前用户的所有群组

类型定义

getAllUserGroup: (params: GetAllUserGroupParams) => Promise<any>

Demo 例子🌰

SIMInstance.Group.getAllUserGroup().then(() => {
    console.log('getAllUserGroup success!');
}).catch((err) => {
    console.error('getAllUserGroup Error! err:', err);
})

方法参数

GetAllUserGroupParams-对象类型

获取当前用户的所有群组的参数

interface GetAllUserGroupParams {
    typeArr?: (1|3|4)[];
}

对象成员

返回值

Promise<DefaultResponse<GetAllUserGroupResItem[]>>

GetAllUserGroupResItem-对象类型

interface AllUserGroupItemTypes {
    "id": string,
    "name": string,
    "avatar": string,
    "ownerId": string,
    "maxCount": number,
    "isReview": 0|1,
    "groupType": GroupTypeEnum,
    "appId": string,
    "createTime": number,
    "defaultType": 0|1|2|3,
    "defaultAccounts": string,
    "num": number,
    "invitedToggle": 0|1,
    "atallToggle": 0|1
}

对象成员

修改群信息： modifyGroup

修改群信息

类型定义

modifyGroup: (params: ModifyGroupParams) => Promise<any>

Demo 例子🌰

SIMInstance.Group.modifyGroup({
    groupType: 1,
    groupId: '123123',
}).then(() => {
    console.log('getAllUserGroup success!');
}).catch((err) => {
    console.error('getAllUserGroup Error! err:', err);
})

方法参数

ModifyGroupParams-对象类型

修改群信息的参数

interface ModifyGroupParams {
    groupType: GroupTypeEnum,
    groupId: string,
    groupName?: string,
    avatar?: string,
    isReview?: 0|1,
    notice?: string
}

对象成员

返回值

Promise<DefaultResponse>

@All功能设置： setGroupAtAllToggle

切换@All的设置

类型定义

setGroupAtAllToggle: (params: SetGroupAtAllToggleParams) => Promise<any>

Demo 例子🌰

SIMInstance.Group.setGroupAtAllToggle({
    groupType: 1,
    groupId: '123123',
    toggle: 1
}).then(() => {
    console.log('setGroupAtAllToggle success!');
}).catch((err) => {
    console.error('setGroupAtAllToggle Error! err:', err);
})

方法参数

SetGroupAtAllToggleParams-对象类型

切换@All的设置的参数

interface SetGroupAtAllToggleParams {
		groupType: GroupTypeEnum,
		groupId: string,
		toggle: 0|1
}

对象成员

返回值

Promise<DefaultResponse>

邀请群成员权限设置： setGroupInvitedToggle

更改邀请群成员的设置

类型定义

setGroupInvitedToggle: (params: SetGroupInvitedToggleParams) => Promise<any>

Demo 例子🌰

SIMInstance.Group.setGroupInvitedToggle({
    groupType: 1,
    groupId: '123123',
    toggle: 1
}).then(() => {
    console.log('setGroupInvitedToggle success!');
}).catch((err) => {
    console.error('setGroupInvitedToggle Error! err:', err);
})

方法参数

SetGroupInvitedToggleParams-对象类型

更改邀请群成员的参数

interface SetGroupInvitedToggleParams {
		groupType: GroupTypeEnum,
		groupId: string,
		toggle: 0|1
}

对象成员

返回值

Promise<DefaultResponse>

获取群的简要信息： getGroupIntro

获取群的简要信息

类型定义

getGroupIntro: (params: GetGroupIntroParams) => Promise<any>

Demo 例子🌰

SIMInstance.Group.getGroupIntro({
    groupType: 1,
    groupId: '123123'
}).then(() => {
    console.log('getGroupIntro success!');
}).catch((err) => {
    console.error('getGroupIntro Error! err:', err);
})

方法参数

GetGroupIntroParams-对象类型

获取群的简要信息的参数

interface GetGroupIntroParams {
    groupType: GroupTypeEnum,
    groupId: string,
}

对象成员

返回值

Promise<DefaultResponse<GetAllUserGroupResItem>>

获取群组的详细信息： getGroupDetail

获取群组的详细信息

类型定义

getGroupDetail: (params: GetGroupDetailParams) => Promise<any>

Demo 例子🌰

SIMInstance.Group.getGroupDetail({
    groupType: 1,
    groupId: '123123'
}).then(() => {
    console.log('getGroupDetail success!');
}).catch((err) => {
    console.error('getGroupDetail Error! err:', err);
})

方法参数

GetGroupDetailParams-对象类型

获取群组的详细信息的参数

interface GetGroupDetailParams {
    groupType: GroupTypeEnum,
    groupId: string,
}

对象成员

返回值

Promise<DefaultResponse<GetGroupDetailRes>>

GetGroupDetailRes-对象类型

interface GetGroupDetailRes extends GetAllUserGroupResItem {
    groupMembers: GroupMemberItemType[],
    groupEventExplain?: GroupEventExplainType
}

对象成员

该对象继承了GroupMemberItemType对象，继承过来的属性将不再描述

获取群组的详细信息 - 列表获取： getGroupDetailList

获取群组的详细信息 - 列表获取

类型定义

getGroupDetailList: (params: GetGroupListDetailParams) => Promise<any>

Demo 例子🌰

SIMInstance.Group.getGroupDetailList({
    groupType: 1,
    groupIds: ['123123', '22342342121']
}).then(() => {
    console.log('getGroupDetail success!');
}).catch((err) => {
    console.error('getGroupDetail Error! err:', err);
})

方法参数

GetGroupDetailParams-对象类型

获取群组的详细信息 - 列表获取的参数

interface GetGroupDetailParams {
		groupType: GroupTypeEnum,
		groupIds: string[],
}

对象成员

搜索群组： searchGroups

通过群组名称和群组类型来搜索当前用户拥有的群组

类型定义

searchGroups: (params: SearchGroupsParams) => Promise<any>

Demo 例子🌰

SIMInstance.Group.searchGroups({
    groupName: 'hello'
}).then(() => {
    console.log('searchGroups success!');
}).catch((err) => {
    console.error('searchGroups Error! err:', err);
})

方法参数

SearchGroupsParams-对象类型

查询匹配条件的群组的参数

interface SearchGroupsParams {
		groupName: string,
		typeJsonArray: (0|1|2|3)[],
}

对象成员

邀请加入： inviteJoinGroup

邀请加入群聊

类型定义

inviteJoinGroup: (params: InviteGroupParams) => Promise<any>

Demo 例子🌰

SIMInstance.Group.inviteJoinGroup({
    groupType: '1',
    groupId: '123123123',
    userIds: ['9572', '9528'],
}).then(() => {
    console.log('inviteJoinGroup success!');
}).catch((err) => {
    console.error('inviteJoinGroup Error! err:', err);
})

方法参数

JoinGroupParams-对象类型

加入群组的参数

interface JoinGroupParams {
    groupType: GroupTypeEnum,
    groupId: string,
    userIds: string[]
}

对象成员

返回值

Promise<DefaultResponse>

转让群主： changeGroupOwner

转让群主

类型定义

changeGroupOwner: (params: ChangeOwnerParams) => Promise<any>

Demo 例子🌰

SIMInstance.Group.changeGroupOwner({
    groupType: 1,
    groupId: '123123',
    newOwnerId: '9528'
}).then(() => {
    console.log('changeGroupOwner success!');
}).catch((err) => {
    console.error('changeGroupOwner Error! err:', err);
});

方法参数

ChangeOwnerParams-对象类型

加入群组的参数

interface ChangeOwnerParams {
		groupType: GroupTypeEnum,
		groupId: string,
		newOwnerId: string,
}

对象成员

返回值

Promise<DefaultResponse>

获取群组管理员： getGroupManagers

获取群组管理员

类型定义

getGroupManagers: (params: GetGroupManagerParams) => Promise<any>

Demo 例子🌰

SIMInstance.Group.getGroupManagers({
    groupType: 1,
    groupId: '123123',
}).then(() => {
    console.log('getGroupManagers success!');
}).catch((err) => {
    console.error('getGroupManagers Error! err:', err);
});

方法参数

GetGroupManagerParams-对象类型

获取群组管理员的参数

interface GetGroupManagerParams {
		groupType: GroupTypeEnum,
		groupId: string,
}

对象成员

返回值

Promise<DefaultResponse<GroupMemberItemType>>

获取群组成员Id集合： getGroupMemberIds

获取群组成员Id集合

类型定义

getGroupMemberIds: (params: GetGroupMemberIdsParams) => Promise<any>

Demo 例子🌰

SIMInstance.Group.getGroupMemberIds({
    groupType: 1,
    groupId: '123123',
}).then(() => {
    console.log('getGroupMemberIds success!');
}).catch((err) => {
    console.error('getGroupMemberIds Error! err:', err);
});

方法参数

GetGroupMemberIdsParams-对象类型

获取群组成员Id集合的参数

interface GetGroupMemberIdsParams {
		groupType: GroupTypeEnum,
		groupId: string,
}

对象成员

返回值

Promise<DefaultResponse<string[]>>

获取群组成员集合： getGroupMemberList

获取群组成员集合

类型定义

getGroupMemberList: (params: GetGroupMemberListParams) => Promise<any>

Demo 例子🌰

SIMInstance.Group.getGroupMemberList({
    groupType: 1,
    groupId: '123123',
}).then(() => {
    console.log('getGroupMemberList success!');
}).catch((err) => {
    console.error('getGroupMemberList Error! err:', err);
});

方法参数

GetGroupMemberListParams-对象类型

获取群组成员集合的参数

interface GetGroupMemberListParams {
		groupType: GroupTypeEnum,
		groupId: string,
}

对象成员

返回值

Promise<DefaultResponse<GroupMemberItemType[]>>

将人员移出群聊： deleteGroupMember

将人员移出群聊

类型定义

deleteGroupMember: (params: DeleteGroupMemberParams) => Promise<any>

Demo 例子🌰

SIMInstance.Group.deleteGroupMember({
    groupType: 1,
    groupId: '123123',
    userIds: ['9527', '9528']
}).then(() => {
    console.log('deleteGroupMember success!');
}).catch((err) => {
    console.error('deleteGroupMember Error! err:', err);
});

方法参数

DeleteGroupMemberParams-对象类型

将人员移出群聊的参数

interface DeleteGroupMemberParams {
		groupType: GroupTypes.GroupTypeEnum,
		groupId: string,
		userIds: string[]
}

对象成员

返回值

Promise<DefaultResponse>

退出群组： quitGroup

当前用户操作 - 退出群组

类型定义

quitGroup: (params: QuitGroupParams) => Promise<any>

Demo 例子🌰

SIMInstance.Group.quitGroup({
    groupType: 1,
    groupId: '123123',
}).then(() => {
    console.log('quitGroup success!');
}).catch((err) => {
    console.error('quitGroup Error! err:', err);
});

方法参数

QuitGroupParams-对象类型

退出群组的参数

interface QuitGroupParams {
		groupType: GroupTypes.GroupTypeEnum,
		groupId: string,
}

对象成员

返回值

Promise<DefaultResponse>

修改群成员角色： setGroupMemberRole

修改群成员角色

类型定义

setGroupMemberRole: (params: SetGroupMemberRoleParams) => Promise<any>

Demo 例子🌰

SIMInstance.Group.setGroupMemberRole({
    groupType: 1,
    groupId: '123123',
    managerIds: ['9527', '9528'],
    type: 1
}).then(() => {
    console.log('setGroupMemberRole success!');
}).catch((err) => {
    console.error('setGroupMemberRole Error! err:', err);
});

方法参数

SetGroupMemberRoleParams-对象类型

修改群成员角色的参数

interface SetGroupMemberRoleParams {
		groupType: GroupTypes.GroupTypeEnum,
		groupId: string,
		managerIds: string[],
		type: 1|2,
}

对象成员

返回值

Promise<DefaultResponse>

群组模块通用接口类型定义

GroupTypeEnum-对象类型

群组类型枚举

export enum GroupTypeEnum {
    InnerGroup= 1,
    EventGroup = 3,
    OuterGroup = 4,
    OrgGroup = 5,
    MeetingGroup = 6
}

对象成员

GroupMemberItemType-对象类型

群成员信息

interface GroupMemberItemType {
		"appId": string,
		"groupId": string,
		"userId": string,
		"role": GroupUserRoleEnum,
		"nickname": string,
		"petName": string,
		"nicknamePy": string,
		"disturb": 0,
		"delFlag": 0,
		"createTime": number,
		"updateTime": number,
		"beInviteId"?: string,
		beOwnerTime?: string,
}

GroupMemberItemType-对象成员

GroupEventExplainType-对象类型

群公告消息

interface GroupEventExplainType {
/** 建群人-account */
    "createBy": string,
    /** 建群人-name */
    "createName": string,
    /** 建群时间 */
    "createTime": number,
    /** 是否解散：0正常，1解散 */
    "delFlag": boolean,
    /** 附件地址JSON数组格式 */
    "fileInfo": string,
    /** 群组ID  */
    "groupId": string,
    /** 事件ID */
    "id": string,
    /** 图片地址JSON数组格式  */
    "imageInfo": string,
    /** 文字内容 */
    "text": string
}

GroupEventExplainType-对象成员

DefaultResponse-对象类型

群组类型枚举

interface DefaultResponse<T = {}> {
    code: number,
    message: string,
    success: boolean,
    data: T
}

对象成员

人员相关接口

通过http接口来操作IM中的人员用户相关功能

批量获取用户账号信息： fetchMultiPersonalData

批量获取用户账号信息

类型定义

fetchMultiPersonalData: (params: FetchMultiPersonalDataParams) => Promise<any>

Demo 例子🌰

SIMInstance.User.fetchMultiPersonalData({
    accounts: ['9527', '9528'],
}).then(() => {
    console.log('fetchMultiPersonalData success!');
}).catch((err) => {
    console.error('fetchMultiPersonalData Error! err:', err);
});

方法参数

FetchMultiPersonalDataParams-对象类型

批量获取用户账号信息的参数

interface FetchMultiPersonalDataParams {
		accounts: string[]
}

对象成员

返回值

export interface FetchMultiPersonalDataResItem {
    account: string
    avatar: string
    createTime: string
    definition: string
    disablePush: number
    nicknamePy: string
    petName: string
    userNickname: string
    userStatus: number
    userId: number
}
Promise<DefaultResponse<FetchMultiPersonalDataResItem>>

FetchMultiPersonalDataResItem-对象成员

会话相关接口

通过http接口来操作IM中的会话相关功能

设置会话： setChatSession

设置会话

类型定义

setChatSession: (params: SetChatSessionParams) => Promise<any>

Demo 例子🌰

SIMInstance.Chat.setChatSession({
    sessionId: '1234',
    securityType: 0,
    sessionType: 0,
    isTop: 1,
}).then((res) => {
    console.log('setChatSession success!', res);
}).catch((err) => {
    console.error('setChatSession Error! err:', err);
});

方法参数

SetChatSessionParams-对象类型

设置会话的参数

interface SetChatSessionParams {
		sessionId: string,
		securityType: 0|1,
		sessionType: ChatTypeEnum,
		isTop?: 0|1,
		notDisturb?: 0|1
}

对象成员

返回值

Promise<DefaultResponse>

获取会话详情信息： getChatInfo

获取会话详情信息

类型定义

getChatInfo: (params: SetChatSessionParams) => Promise<any>

Demo 例子🌰

SIMInstance.Chat.getChatInfo({
    sessionId: '123123',
    securityType: 0,
    sessionType: 0,
}).then((res) => {
    console.log('getChatInfo success!', res);
}).catch((err) => {
    console.error('getChatInfo Error! err:', err);
});

方法参数

GetChatInfoParams-对象类型

获取会话详情信息的参数

interface GetChatInfoParams {
		sessionId: string,
		securityType: 0|1,
		sessionType: SIMTypes.ChatTypeEnum,
}

对象成员

返回值

	export interface GetChatInfoTypes {
    "id": string,
    "appId": string,
    "account": string,
    "sessionId": string,
    "sessionName": string,
    "avatar": string,
    "sessionType": SIMTypes.ChatTypeEnum,
    "groupType": GroupTypes.GroupTypeEnum,
    "toppingTime": string,
    "toppingTimeLong": string,
    "isTop": 0|1,
    "securityType": 0|1,
    "notDisturb": 0|1,
    "isShow": 0|1,
    "createTime": string,
    "updateTime": string,
    "lastMsg": IMReceiveTypes.DefaultMsg,
    "isAt": 0|1,
    "invalid": 0|1|2|3|10,
    "cross": 0|1,
    "sessionLevel": 0|1
}
Promise<DefaultResponse<GetChatInfoTypes>>

GetChatInfoTypes-对象成员

获取所有会话： getAllChat

获取所有会话 - 有增量选项

类型定义

getAllChat: (params: GetAllChatParams) => Promise<any>

Demo 例子🌰

SIMInstance.Chat.getAllChat().then((res) => {
    console.log('getAllChat success!', res);
}).catch((err) => {
    console.error('getAllChat Error! err:', err);
});

方法参数

GetAllChatParams-对象类型

获取所有会话的参数

interface GetAllChatParams {
    sessionLevel?: 0|1,
    lastPullTime?: number
}

对象成员

返回值

Promise<DefaultResponse<GetChatInfoTypes[]>>

删除会话： deleteChat

删除会话（设置为不可见）

类型定义

deleteChat: (params: DeleteChatParams) => Promise<any>

Demo 例子🌰

SIMInstance.Chat.deleteChat({
    sessionId: '123123',
    securityType: 0,
    sessionType: 0,
}).then((res) => {
    console.log('deleteChat success!', res);
}).catch((err) => {
    console.error('deleteChat Error! err:', err);
});

方法参数

DeleteChatParams-对象类型

删除会话的参数

interface DeleteChatParams {
    sessionId: string,
    sessionType: ChatTypeEnum,
    securityType: 0|1,
}

对象成员

返回值

Promise<DefaultResponse>

删除会话： destroyChat

删除会话（彻底删除）

类型定义

destroyChat: (params: DeleteChatParams) => Promise<any>

Demo 例子🌰

SIMInstance.Chat.destroyChat({
    sessionId: '123123',
    securityType: 0,
    sessionType: 0,
}).then((res) => {
    console.log('destroyChat success!', res);
}).catch((err) => {
    console.error('destroyChat Error! err:', err);
});

方法参数

返回值

Promise<DefaultResponse>

消息相关接口

通过http接口来操作IM中的消息相关功能

获取消息： getMsgListAndCdMsgById

获取指定区间内消息和被指令修改的消息

类型定义

getMsgListAndCdMsgById: (params: GetMsgListAndCdMsgByIdParams) => Promise<any>

Demo 例子🌰

SIMInstance.Message.getMsgListAndCdMsgById({
    sessionId: '1239',
    sessionType: 0,
    securityType: 0,
}).then((res) => {
    console.log('getMsgListAndCdMsgById success!', res);
}).catch((err) => {
    console.error('getMsgListAndCdMsgById Error! err:', err);
});

方法参数

GetMsgListAndCdMsgByIdParams-对象类型

获取指定区间内消息和被指令修改的消息的参数

interface GetMsgListAndCdMsgByIdParams {
		sessionId: string,
		sessionType: ChatTypeEnum,
		securityType: 0|1,
		msgId?: string,
		rows?: number,
		type?: 0|1|2
}

对象成员

返回值

interface GetMsgListAndCdMsgRes {
    msg: DefaultMsg[],
    cdMsg: CdMsgBody[]
}
Promise<DefaultResponse<GetMsgListAndCdMsgRes>>

历史记录搜索： searchMsg

历史记录搜索

类型定义

searchMsg: (params: SearchMsgParams) => Promise<any>

Demo 例子🌰

SIMInstance.Message.searchMsg({
    sessionId: '9527',
    sessionType: 0,
    securityType: 0,
    type: 0
}).then((res) => {
    console.log('searchMsg success!', res);
}).catch((err) => {
    console.error('searchMsg Error! err:', err);
});

方法参数

SearchMsgParams-对象类型

历史记录搜索的参数

interface SearchMsgParams {
		sessionId: string,
		sessionType: SIMTypes.ChatTypeEnum,
		securityType: 0|1,
		msgId?: string,
		searchName?: string,
		rows?: number,
		type: 0|1|2
}

对象成员

返回值

Promise<DefaultResponse<DefaultMsg[]>>

获取已读状态： getMsgReadData

获取已读状态

类型定义

getMsgReadData: (params: GetMsgReadDataParams) => Promise<any>

Demo 例子🌰

SIMInstance.Message.getMsgReadData({
    msgId: '123123123'
}).then((res) => {
    console.log('getMsgReadData success!', res);
}).catch((err) => {
    console.error('getMsgReadData Error! err:', err);
});

方法参数

GetMsgReadDataParams-对象类型

获取已读状态的参数

interface GetMsgReadDataParams {
    msgId: string,
}

对象成员

返回值

interface GetMsgReadDataRes {
    "appId": number,
    "avatar": string,
    "createBy": string,
    "createDate": string,
    "delFlag": 0|1,
    "groupId": string,
    "id": string,
    "isRead": string,
    "msgId": string,
    "owner": string,
    "petName": string,
    "readDate": string,
    "remarks": string,
    "securityType": 0|1,
    "tId": string,
    "updateBy": string,
    "updateDate": string,
    "userName": string
}
Promise<DefaultResponse<GetMsgReadDataRes[]>>

GetMsgReadDataRes-对象成员

获取回复数据： getReplyList

获取回复数据

类型定义

getReplyList: (params: GetReplyListParams) => Promise<any>

Demo 例子🌰

SIMInstance.Message.getReplyList({
    msgId: '123123123',
    sessionType: 0
}).then((res) => {
    console.log('getReplyList success!', res);
}).catch((err) => {
    console.error('getReplyList Error! err:', err);
});

方法参数

GetReplyListParams-对象类型

获取回复数据的参数

interface GetReplyListParams {
		msgId: string,
		sessionType: ChatTypeEnum
}

对象成员

返回值

Promise<DefaultResponse<DefaultMsg[]>>

获取消息详情： getMessageDetails

获取消息详情-列表获取

类型定义

getMessageDetails: (params: GetMessageDetailsParams) => Promise<any>

Demo 例子🌰

SIMInstance.Message.getMessageDetails({
    msgIds: ['123123123', '123433412'],
    sessionType: 0
}).then((res) => {
    console.log('getMessageDetails success!', res);
}).catch((err) => {
    console.error('getMessageDetails Error! err:', err);
});

方法参数

GetMessageDetailsParams-对象类型

获取消息详情的参数

interface GetMessageDetailsParams {
    msgIds: string[],
    sessionType: SIMTypes.ChatTypeEnum,
}

对象成员

返回值

Promise<DefaultResponse<DefaultMsg[]>>

标记消息： signMessage

标记消息

类型定义

signMessage: (params: SignMessageParams) => Promise<any>

Demo 例子🌰

SIMInstance.Message.signMessage({
    sessionId: '123123',
    sessionType: 0,
    securityType: 0,
    msgId: '123123123',
    cross: 0
}).then((res) => {
    console.log('signMessage success!', res);
}).catch((err) => {
    console.error('signMessage Error! err:', err);
});

方法参数