vanshi-sdk 1.0.4

package/dist/index.d.ts

@@ -0,0 +1,1202 @@
+/**
+ * 接口 [查询群消息已读成员列表。↗](https://yapi.whatimcloud.com/project/123/interface/api/9403) 的 **返回类型**
+ *
+ * @分类 [会话消息↗](https://yapi.whatimcloud.com/project/123/interface/api/cat_766)
+ * @请求头 `POST /sdk/queryGroupMessageReceiptReadMemberList`
+ * @更新时间 `2026-04-27 17:08:54`
+ */
+interface YapiPostSdkQueryGroupMessageReceiptReadMemberListApiResponse {
+    code: string;
+    message: string;
+    data: YapiPostSdkQueryGroupMessageReceiptReadMemberData;
+}
+interface YapiPostSdkQueryGroupMessageReceiptReadMemberData {
+    nextFlag: string;
+    userList: YapiPostSdkQueryGroupMessageReceiptReadMemberListUserListData[];
+    groupID: string;
+}
+interface YapiPostSdkQueryGroupMessageReceiptReadMemberListUserListData {
+    /**
+     * 群组成员昵称。
+     */
+    memberNickname: string;
+    /**
+     * 群角色，1：群主，2：管理员，3：群成员。
+     */
+    memberRole: string;
+    /**
+     * 群成员头像 URL。
+     */
+    memberAvatarUrl: string;
+    userID: string;
+    userName: string;
+    /**
+     * 用户头像
+     */
+    userAvatarUrl: string;
+    /**
+     * 群成员禁言过期时间。为 0 时即不禁言，为 -1 时即永久禁言。
+     */
+    muteExpiredTime: string;
+}
+
+/**
+ * 接口 [查询群消息未读成员列表。↗](https://yapi.whatimcloud.com/project/123/interface/api/9396) 的 **返回类型**
+ *
+ * @分类 [会话消息↗](https://yapi.whatimcloud.com/project/123/interface/api/cat_766)
+ * @请求头 `POST /sdk/queryGroupMessageReceiptUnreadMemberList`
+ * @更新时间 `2026-04-29 15:01:12`
+ */
+interface YapiPostSdkQueryGroupMessageReceiptUnreadMemberListApiResponse {
+    code: string;
+    message: string;
+    data: YapiPostSdkQueryGroupMessageReceiptUnreadMemberData;
+}
+interface YapiPostSdkQueryGroupMessageReceiptUnreadMemberData {
+    nextFlag: string;
+    userList: YapiPostSdkQueryGroupMessageReceiptUnreadMemberListUserListData[];
+    groupID: string;
+}
+interface YapiPostSdkQueryGroupMessageReceiptUnreadMemberListUserListData {
+    /**
+     * 群组成员昵称。
+     */
+    memberNickname: string;
+    /**
+     * 群角色，1：群主，2：管理员，3：群成员。
+     */
+    memberRole: string;
+    /**
+     * 群成员头像 URL。
+     */
+    memberAvatarUrl: string;
+    userID: string;
+    userName: string;
+    /**
+     * 用户头像
+     */
+    userAvatarUrl: string;
+    /**
+     * 群成员禁言过期时间。为 0 时即不禁言，为 -1 时即永久禁言。
+     */
+    muteExpiredTime: string;
+}
+
+/**
+ * 接口 [查询一批消息的回执信息↗](https://yapi.whatimcloud.com/project/123/interface/api/9389) 的 **返回类型**
+ *
+ * @分类 [会话消息↗](https://yapi.whatimcloud.com/project/123/interface/api/cat_766)
+ * @请求头 `POST /sdk/queryMessageReceiptsInfo`
+ * @更新时间 `2026-04-27 16:39:08`
+ */
+interface YapiPostSdkQueryMessageReceiptsInfoApiResponse {
+    code: string;
+    message: string;
+    data: YapiPostSdkQueryMessageReceiptsInfoListData[];
+}
+interface YapiPostSdkQueryMessageReceiptsInfoListData {
+    /**
+     * 回执的状态。
+     */
+    status: string;
+    /**
+     * 消息 ID。
+     */
+    messageID: string;
+    /**
+     * 会话 ID。
+     */
+    conversationID: string;
+    /**
+     * 会话类型。
+     */
+    conversationType: string;
+    /**
+     * 表示该回执的已读人数。
+     */
+    readMemberCount: string;
+    /**
+     * 表示该回执的未读人数
+     */
+    unreadMemberCount: string;
+    /**
+     * 消息回执已读时的服务端时间戳。
+     */
+    readTime: string;
+}
+
+/**
+ * 接口 [设置一批消息的回执变成已读↗](https://yapi.whatimcloud.com/project/123/interface/api/9382) 的 **返回类型**
+ *
+ * @分类 [会话消息↗](https://yapi.whatimcloud.com/project/123/interface/api/cat_766)
+ * @请求头 `POST /sdk/sendMessageReceiptsRead`
+ * @更新时间 `2026-04-27 14:10:58`
+ */
+interface YapiPostSdkSendMessageReceiptsReadApiResponse {
+    code: string;
+    message: string;
+    data: string;
+}
+
+interface IYapiPostSdkClearConversationTotalUnreadMessageCountApiResponse {
+	code: string
+	message: string
+	data: string
+}
+
+interface IYapiPostSdkClearConversationUnreadMessageCountApiResponse {
+	code: string
+	message: string
+	data: IYapiPostSdkClearConversationUnreadMessageCountData
+}
+interface IYapiPostSdkClearConversationUnreadMessageCountData {
+	conversationID: string
+	conversationType: string
+}
+
+interface IYapiPostSdkDeleteConversationApiRequest {
+	
+	conversationID: string
+	
+	conversationType: number
+	
+	config: boolean
+}
+
+
+interface IYapiPostSdkDeleteConversationApiResponse {
+	code: string
+	message: string
+	data: IYapiPostSdkDeleteConversationListData[]
+}
+interface IYapiPostSdkDeleteConversationListData {
+	
+	conversationID: string
+	
+	conversationType: string
+}
+
+interface IYapiPostSdkSendMediaMessageApiResponse {
+	code: string
+	message: string
+	data: YapiPostSdkSendMediaMessageData
+}
+
+interface YapiPostSdkSendMediaMessageData {
+  /**
+   * 消息
+   */
+  massage: string
+  /**
+   * 消息类型:
+   * 1:普通文本消息
+   * 2:自定义二进制消息，可用于传递自定义的二进制消息。该消息类型不支持离线消息和本地存储。
+   * 0:未知类型
+   * 20:弹幕消息，可用于直播间发送的弹幕
+   * 11:图片消息，可用于发送图片消息，仅支持 .jpg, .jpeg, .png, .bmp, .gif, .tiff 图片类型
+   * 12:文件消息
+   * 13:音频消息
+   * 14:视频消息
+   * 30:系统消息
+   * 31:系统消息
+   * 100:合并消息
+   * 200:自定义消息
+   * 32:Tips 消息
+   * 10:组合消息，可用于发送文本、富媒体文件、自定义消息的组合消息。
+   *
+   */
+  type: string
+  /**
+   * 消息拓展
+   */
+  extendedData: string
+  /**
+   * 消息 id
+   */
+  messageID: string
+  /**
+   * 排序 key
+   */
+  orderKey: string
+  /**
+   * 客户端 id
+   */
+  clientSid: string
+  /**
+   * 消息表 id
+   */
+  localMessageID: string
+  /**
+   * 会话 id
+   */
+  conversationID: string
+  /**
+   * 会话类型
+   */
+  conversationType: number
+  /**
+   * 发送者 id
+   */
+  senderUserID: string
+  /**
+   * 0 发送 1 接收
+   */
+  direction: number
+  /**
+   * 消息发送时间戳
+   */
+  timestamp: string
+  /**
+   * 0 不是回执。1 回执进行中。2 回执已完成。3 回执已过期。4 回执已失败。
+   */
+  receiptStatus: number
+  /**
+   * 是否服务端发送消息
+   */
+  isServerMessage: boolean
+  /**
+   * 是否是全员推送消息
+   */
+  isBroadcastMessage: boolean
+  /**
+   * 标识该消息是否为群定向消息
+   */
+  isGroupTargetedMessage: string
+  /**
+   * id
+   */
+  id: string
+  /**
+   * 文件下载地址
+   */
+  fileDownloadUrl: string
+  /**
+   * 如果是视频/语音，时长
+   */
+  duration: string
+  /**
+   * 文件名字
+   */
+  fileName: string
+  /**
+   * 缩略图
+   */
+  thumbnailDownloadUrl: string
+  /**
+   * 缩略图宽度
+   */
+  thumbnailWidth: string
+  /**
+   * 缩略图高度
+   */
+  thumbnailHeight: string
+}
+
+interface IConversation {
+    conversationID?: string;
+    conversationName?: string;
+    type?: number;
+    unreadMessageCount?: number;
+    notificationStatus?: number;
+    isPinned?: boolean;
+}
+interface ApiResponse {
+    code: string;
+    message: string;
+    data: string;
+}
+interface MentionedInfoList {
+    messageID: string;
+    fromUserID: string;
+    type: string;
+    messageSeq: number;
+}
+interface LastMessageData {
+    /**
+     *  标识这条消息的唯一 ID。
+     */
+    msgId: string;
+    /**
+     * 1:普通文本消息
+     * 2:自定义二进制消息，可用于传递自定义的二进制消息。该消息类型不支持离线消息和本地存储。
+     * 0:未知类型
+     * 20:弹幕消息，可用于直播间发送的弹幕
+     * 11:图片消息，可用于发送图片消息，仅支持 .jpg, .jpeg, .png, .bmp, .gif, .tiff 图片类型
+     * 12:文件消息
+     * 13:音频消息
+     * 14:视频消息
+     * 30:系统消息
+     * 31:系统消息
+     * 100:合并消息
+     * 200:自定义消息
+     * 32:Tips 消息
+     * 10:组合消息，可用于发送文本、富媒体文件、自定义消息的组合消息。
+     *
+     */
+    type: string;
+    /**
+     *      * 详情描述：标识一条消息的发送时间。
+     */
+    timestamp: number;
+    /**
+     * 展示本条消息发送者的 userID
+     */
+    fromUserId: string;
+    /**
+     * 会话 id
+     */
+    conversationID: string;
+    /**
+     * 0-发送，1-接收
+     */
+    direction: number;
+    /**
+     * 0-发送中，1-发送成功，2-发送失败
+     */
+    sentStatus: number;
+    /**
+     * 0 单聊会话 1 房间会话 2 群聊会话 3 未知
+     */
+    conversationType: number;
+    /**
+     * orderKey 越大消息越新，可用于消息排序。
+     */
+    orderKey: number;
+    /**
+     * SDK 本地生成的 MessageID，开发者无需关注。
+     */
+    localMessageID: string;
+    /**
+     * 0-不是回执。，1-回执进行中。2-回执已完成。3-回执已过期。3-回执已失败。
+     */
+    receiptStatus: number;
+    /**
+     * 消息拓展字段。
+     */
+    extendedData: string;
+    /**
+     * 该消息是否是全员推送消息。
+     */
+    isBroadcastMessage: boolean;
+    /**
+     * 是否需要提醒所有人。业务表现可为“@所有人”。
+     */
+    isMentionAll: boolean;
+    /**
+     * 提醒一批相关的用户。业务表现可为“@某用户” 。
+     */
+    mentionedUserIDs: string[];
+    /**
+     * 回复消息树对应的根消息的回复消息数量。
+     */
+    rootRepliedCount: number;
+    /**
+     * 回复消息引用的源消息的信息。
+     */
+    repliedInfo: string;
+    /**
+     * 该消息的最后一次置顶的置顶者。
+     */
+    pinnedUserID: string;
+    /**
+     * 该消息最后一次置顶的置顶时间。
+     */
+    pinnedTime: number;
+    /**
+     * 消息内容
+     */
+    message: string;
+}
+interface ConversationItem {
+    conversationID: string;
+    conversationName: string;
+    type: number;
+    unreadMessageCount: number;
+    lastMessage: LastMessageData;
+    orderKey: number;
+    notificationStatus: string;
+    conversationAvatarUrl: string;
+    isPinned: boolean;
+    mentionedInfoList: MentionedInfoList[];
+    conversationAlias: string;
+    draft: string;
+}
+
+interface queryHistoryMessageParams {
+    conversationID: string;
+    conversationType: string;
+    config: {
+        nextMessage?: {
+            type: string;
+            messageID: string;
+        };
+        count: number | string;
+        reverse?: boolean;
+    };
+}
+interface ZIMMessageItem {
+    /**
+     * 消息类型。
+     */
+    type: string;
+    /**
+     * 消息的唯一 ID
+     */
+    messageID: string;
+    /**
+     * 消息的发送时间。
+     */
+    timestamp: number;
+    /**
+     * 消息发送者的 userID。
+     */
+    senderUserID: string;
+    /**
+     * 会话的 ID，相同会话类型下的 ID 是唯一的。
+     */
+    conversationID: string;
+    /**
+     * 用于描述消息的方向是发送还是接收。0 消息已发送。1 消息已接受。
+     */
+    direction: number;
+    /**
+     * 描述消息的发送状态。消息发送中。1 消息发送成功。2 消息发送失败。
+     */
+    sentStatus: number;
+    /**
+     * 该消息所属会话的类型。
+     */
+    conversationType: number;
+    /**
+     * 表示该消息在会话中的序号。
+     */
+    conversationSeq: string;
+    /**
+     * orderKey 越大消息越新，可用于消息排序。
+     */
+    orderKey: string;
+    /**
+     * 描述该消息的回执状态。0 不是回执。1 回执进行中。2 回执已完成。3 回执已过期。4 回执已失败。
+     */
+    receiptStatus: number;
+    /**
+     * 该消息是否是全员推送消息。
+     */
+    isBroadcastMessage: string;
+    /**
+     * 是否需要提醒所有人。业务表现可为“@所有人”。
+     */
+    isMentionAll: boolean;
+    /**
+     * 提醒一批相关的用户。业务表现可为“@某用户”。
+     */
+    mentionedUserIDs: string[];
+    /**
+     * 本条消息最新的编辑者的 userID。
+     */
+    editorUserID: string;
+    /**
+     * 本条消息最新的编辑时间戳。
+     */
+    editedTime: string;
+    /**
+     * 该消息最后一次置顶的置顶时间。
+     */
+    pinnedTime: string;
+    /**
+     * 该消息的最后一次置顶的置顶者。
+     */
+    pinnedUserID: string;
+    /**
+     * 消息记录
+     */
+    message: string;
+    /**
+     * 文件下载地址 (多媒体消息会有记录)
+     */
+    fileDownloadUrl: string;
+    /**
+     * 如果是视频/语音，时长(多媒体消息会有记录)
+     */
+    duration: string;
+    /**
+     * 文件名字 (多媒体消息会有记录)
+     */
+    fileName: string;
+    /**
+     * 缩略图 (多媒体消息会有记录)
+     */
+    thumbnailDownloadUrl: string;
+    /**
+     * 缩略图宽度 (多媒体消息会有记录)
+     */
+    thumbnailWidth: string;
+    /**
+     * 缩略图高度 (多媒体消息会有记录)
+     */
+    thumbnailHeight: string;
+}
+interface ZIMMessageQueriedResult {
+    messageList: ZIMMessageItem[];
+    conversationID: string;
+    conversationType: string;
+}
+declare enum ZIMConversationType {
+    Unknown = -1,
+    Peer = 0,
+    Room = 1,
+    Group = 2
+}
+declare enum SEDMessageType$1 {
+    Unknown = "0",
+    Command = "2",
+    Barrage = "20",
+    Text = "1",
+    Image = "11",
+    File = "12",
+    Audio = "13",
+    Video = "14",
+    System = "30",
+    Revoke = "31",
+    Tips = "32",
+    Combine = "100",
+    Custom = "200"
+}
+interface ZIMSEDMessage {
+    message: string;
+    type: SEDMessageType$1;
+    /**
+     * 自定义的拓展字段
+     */
+    extendedData: string;
+}
+interface ZIMSEDMediaMessage {
+    message: string;
+    type: SEDMessageType$1;
+    /**
+     * 自定义的拓展字段
+     */
+    extendedData: string;
+    file?: File;
+    thumbnailHeight?: string;
+    thumbnailWidth?: string;
+    duration?: string;
+    thumbnailDownloadUrl?: string;
+    fileDownloadUrl?: string;
+    fileName?: string;
+    fileSize?: string;
+}
+interface ZIMMessageSeDResult {
+    /**
+    * 消息
+    */
+    massage: string;
+    /**
+     * 消息类型：
+     * 1:普通文本消息
+     * 2:自定义二进制消息，可用于传递自定义的二进制消息。该消息类型不支持离线消息和本地存储。
+     * 0:未知类型
+     * 20:弹幕消息，可用于直播间发送的弹幕
+     * 11:图片消息，可用于发送图片消息，仅支持 .jpg, .jpeg, .png, .bmp, .gif, .tiff 图片类型
+     * 12:文件消息
+     * 13:音频消息
+     * 14:视频消息
+     * 30:系统消息
+     * 31:系统消息
+     * 100:合并消息
+     * 200:自定义消息
+     * 32:Tips 消息
+     * 10:组合消息，可用于发送文本、富媒体文件、自定义消息的组合消息。
+     *
+     */
+    type: SEDMessageType$1;
+    /**
+     * 消息拓展
+     */
+    extendedData: string;
+    /**
+     * 消息 id
+     */
+    messageID: string;
+    /**
+     * 排序 key
+     */
+    orderKey: string;
+    /**
+     * 客户端 id
+     */
+    clientSid: string;
+    /**
+     * 消息表 id
+     */
+    localMessageID: string;
+    /**
+     * 会话 id
+     */
+    conversationID: string;
+    /**
+     * 会话类型
+     */
+    conversationType: ZIMConversationType;
+    /**
+     * 发送者 id
+     */
+    senderUserID: string;
+    /**
+     * 0 发送 1 接收
+     */
+    direction: number;
+    /**
+     * 消息发送时间戳
+     */
+    timestamp: string;
+    /**
+     * 0 不是回执。1 回执进行中。2 回执已完成。3 回执已过期。4 回执已失败。
+     */
+    receiptStatus: number;
+    /**
+     * 是否服务端发送消息
+     */
+    isServerMessage: boolean;
+    /**
+     * 是否是全员推送消息
+     */
+    isBroadcastMessage: boolean;
+    /**
+     * 标识该消息是否为群定向消息
+     */
+    isGroupTargetedMessage: string;
+    /**
+     * id
+     */
+    id: string;
+}
+interface ZIMMessageRevokeConfig {
+    revokeExtendedData?: string;
+}
+
+interface ZIM {
+    create(): Promise<void>;
+    logout(): Promise<boolean>;
+    isConnected(): boolean;
+    on(event: string, handler: (...args: any[]) => void): void;
+    off(event: string, handler?: (...args: any[]) => void): void;
+    login(values: {
+        token: string;
+    }): Promise<boolean>;
+    queryConversation(params: {
+        count: number;
+        nextConversation: IConversation | undefined;
+        conversationName?: string;
+    }): Promise<ConversationItem[]>;
+    deleteAllConversations(): Promise<ApiResponse>;
+    deleteConversation(params: {
+        conversationID: string;
+        conversationType: ZIMConversationType;
+        config?: boolean;
+    }): Promise<IYapiPostSdkDeleteConversationApiResponse>;
+    clearConversationTotalUnreadMessageCount(): Promise<IYapiPostSdkClearConversationTotalUnreadMessageCountApiResponse>;
+    clearConversationUnreadMessageCount(conversationID: string, conversationType: ZIMConversationType): Promise<IYapiPostSdkClearConversationUnreadMessageCountApiResponse>;
+    queryHistoryMessage(params: queryHistoryMessageParams): Promise<ZIMMessageQueriedResult>;
+    sendMessage(params: {
+        message: ZIMSEDMessage;
+        toConversationID: string;
+        conversationType: ZIMConversationType;
+    }): Promise<ZIMMessageSeDResult>;
+    sendMediaMessage(params: {
+        message: ZIMSEDMediaMessage;
+        toConversationID: string;
+        conversationType: ZIMConversationType;
+    }): Promise<IYapiPostSdkSendMediaMessageApiResponse['data']>;
+    deleteAllConversationMessages(): Promise<{
+        code: string;
+        message: string;
+        data: string;
+    }>;
+    deleteAllMessage(conversationID: string, conversationType: ZIMConversationType): Promise<{
+        code: string;
+        message: string;
+        data: string;
+    }>;
+    deleteMessages(conversationID: string, conversationType: ZIMConversationType, messageList: {
+        messageID: string;
+        type: string;
+    }[]): Promise<{
+        code: string;
+        message: string;
+        data: string;
+    }>;
+    revokeMessage(message: {
+        messageID: string;
+        type: number;
+    }, config?: ZIMMessageRevokeConfig): Promise<{
+        code: string;
+        message: string;
+        data: string;
+    }>;
+    sendMessageReceiptsRead(conversationID: string, conversationType: ZIMConversationType, messageList: string[]): Promise<YapiPostSdkSendMessageReceiptsReadApiResponse>;
+    queryMessageReceiptsInfo(conversationID: string, conversationType: ZIMConversationType, messageList: string[]): Promise<YapiPostSdkQueryMessageReceiptsInfoApiResponse>;
+    queryGroupMessageReceiptUnreadMemberList(groupID: string, config: {
+        count: string;
+        nextFlag: string;
+    }, message: {
+        messageID: string;
+    }): Promise<YapiPostSdkQueryGroupMessageReceiptUnreadMemberListApiResponse>;
+    queryGroupMessageReceiptReadMemberList(groupID: string, config: {
+        count: string;
+        nextFlag: string;
+    }, message: {
+        messageID: string;
+    }): Promise<YapiPostSdkQueryGroupMessageReceiptReadMemberListApiResponse>;
+}
+
+interface IYapiPostSdkQueryConversationApiRequest {
+	nextConversation?: IYapiPostSdkQueryConversationApiRequestNextConversation
+	
+	count: number
+  conversationName?: string
+}
+
+interface IYapiPostSdkQueryConversationApiRequestNextConversation {
+	
+	conversationID?: string
+}
+
+interface IYapiPostSdkDeleteAllConversationsApiResponse {
+	code: string
+	message: string
+	data: string
+}
+
+/**
+ * 查询会话列表
+ * @param payload 查询参数
+ * @returns 会话列表数据
+ */
+declare function queryConversation(payload: IYapiPostSdkQueryConversationApiRequest): Promise<ConversationItem[]>;
+/**
+ * 删除全部会话
+ * @param payload 删除参数
+ * @returns 删除结果
+ */
+declare function deleteAllConversations(): Promise<IYapiPostSdkDeleteAllConversationsApiResponse>;
+/**
+ * 删除单个会话
+ * @param payload 删除参数 (需要 conversationID, conversationType, config)
+ * @returns 删除结果
+ */
+declare function deleteConversation(payload: IYapiPostSdkDeleteConversationApiRequest): Promise<IYapiPostSdkDeleteConversationApiResponse>;
+/**
+ * 清除全部会话未读数
+ * @param payload 清除参数（无需要参数）
+ * @returns 清除结果
+ */
+declare function clearConversationTotalUnreadMessageCount(): Promise<IYapiPostSdkClearConversationTotalUnreadMessageCountApiResponse>;
+/**
+ * 清除单个会话未读数
+ * @param payload 清除参数 (需要 conversationID, conversationType)
+ * @returns 清除结果
+ */
+declare function clearConversationUnreadMessageCount(conversationID: string, conversationType: string | number): Promise<IYapiPostSdkClearConversationUnreadMessageCountApiResponse>;
+
+declare function initSocket(): Promise<void>;
+declare function isSocketConnected(): boolean;
+declare function on(event: string, handler: (...args: any[]) => void): void;
+declare function off(event: string, handler?: (...args: any[]) => void): void;
+
+interface IYapiPostSdkLoginApiRequest {
+  token: string;
+}
+
+declare function login(payload: IYapiPostSdkLoginApiRequest): Promise<boolean>;
+declare function logout(disconnect?: boolean): Promise<boolean>;
+
+interface IYapiPostSdkSendMessageApiRequest {
+	message: IYapiPostSdkSendMessageApiRequestMessage
+	/**
+	 * 消息需要发送的会话 ID。
+	 */
+	toConversationID: string
+	/**
+	 * 类型。Peer=(0) 单聊会话。Room=(1) 房间会话。Group=(2) 群聊会话。Unknown=(3) 未知。
+	 */
+	conversationType: number
+}
+
+interface IYapiPostSdkSendMessageApiRequestMessage {
+	/**
+   * 消息内容
+   */
+  message: string
+  /**
+   * 消息类型:
+   * 1:普通文本消息
+   * 2:自定义二进制消息，可用于传递自定义的二进制消息。该消息类型不支持离线消息和本地存储。
+   * 0:未知类型
+   * 20:弹幕消息，可用于直播间发送的弹幕
+   * 11:图片消息，可用于发送图片消息，仅支持 .jpg, .jpeg, .png, .bmp, .gif, .tiff 图片类型
+   * 12:文件消息
+   * 13:音频消息
+   * 14:视频消息
+   * 30:系统消息
+   * 31:系统消息
+   * 100:合并消息
+   * 200:自定义消息
+   * 32:Tips 消息
+   * 10:组合消息，可用于发送文本、富媒体文件、自定义消息的组合消息。
+   *
+   */
+  type: string
+  /**
+   * 自定义的拓展字段
+   */
+  extendedData: string
+}
+declare enum SEDMessageType {
+  Unknown = '0',
+  Command = '2',
+  Barrage = '20',
+  Text = '1',
+  Image = '11',
+  File = '12',
+  Audio = '13',
+  Video = '14',
+  System = '30',
+  Revoke = '31',
+  Tips = '32',
+  Combine = '100',
+  Custom = '200'
+}
+interface YapiPostSdkSendMessageMessage {
+  /**
+   * 消息
+   */
+  massage: string
+  /**
+   * 消息类型:
+   * 1:普通文本消息
+   * 2:自定义二进制消息，可用于传递自定义的二进制消息。该消息类型不支持离线消息和本地存储。
+   * 0:未知类型
+   * 20:弹幕消息，可用于直播间发送的弹幕
+   * 11:图片消息，可用于发送图片消息，仅支持 .jpg, .jpeg, .png, .bmp, .gif, .tiff 图片类型
+   * 12:文件消息
+   * 13:音频消息
+   * 14:视频消息
+   * 30:系统消息
+   * 31:系统消息
+   * 100:合并消息
+   * 200:自定义消息
+   * 32:Tips 消息
+   * 10:组合消息，可用于发送文本、富媒体文件、自定义消息的组合消息。
+   *
+   */
+  type: SEDMessageType
+  /**
+   * 消息拓展
+   */
+  extendedData: string
+  /**
+   * 消息 id
+   */
+  messageID: string
+  /**
+   * 排序 key
+   */
+  orderKey: string
+  /**
+   * 客户端 id
+   */
+  clientSid: string
+  /**
+   * 消息表 id
+   */
+  localMessageID: string
+  /**
+   * 会话 id
+   */
+  conversationID: string
+  /**
+   * 会话类型
+   */
+  conversationType: number
+  /**
+   * 发送者 id
+   */
+  senderUserID: string
+  /**
+   * 0 发送 1 接收
+   */
+  direction: number
+  /**
+   * 消息发送时间戳
+   */
+  timestamp: string
+  /**
+   * 0 不是回执。1 回执进行中。2 回执已完成。3 回执已过期。4 回执已失败。
+   */
+  receiptStatus: number
+  /**
+   * 是否服务端发送消息
+   */
+  isServerMessage: boolean
+  /**
+   * 是否是全员推送消息
+   */
+  isBroadcastMessage: boolean
+  /**
+   * 标识该消息是否为群定向消息
+   */
+  isGroupTargetedMessage: string
+  /**
+   * id
+   */
+  id: string
+}
+
+interface IYapiPostSdkSendMessageApiResponse {
+	code: string
+	message: string
+	data: YapiPostSdkSendMessageMessage
+}
+
+interface IYapiPostSdkQueryHistoryMessageApiRequest {
+	
+	conversationID: string
+	
+	conversationType: string
+	config: IYapiPostSdkQueryHistoryMessageApiRequestConfig
+}
+interface IYapiPostSdkQueryHistoryMessageApiRequestConfig {
+	nextMessage?: IYapiPostSdkQueryHistoryMessageApiRequestNextMessageConfig
+	
+	count: string
+	
+	reverse?: boolean
+}
+
+interface IYapiPostSdkQueryHistoryMessageApiRequestNextMessageConfig {
+	
+	type: string
+	
+	messageID: string
+}
+
+
+interface IYapiPostSdkQueryHistoryMessageApiResponse {
+	code: string
+	message: string
+	data: IYapiPostSdkQueryHistoryMessageData
+}
+interface IYapiPostSdkQueryHistoryMessageData {
+	messageList: YapiPostSdkQueryHistoryMessageListMessageListData[]
+	
+	conversationID: string
+	
+	conversationType: string
+}
+interface YapiPostSdkQueryHistoryMessageListMessageListData {
+  /**
+   * 消息类型。
+   */
+  type: string
+  /**
+   * 消息的唯一 ID
+   */
+  messageID: string
+  /**
+   * 消息的发送时间。
+   */
+  timestamp: number
+  /**
+   * 消息发送者的 userID。
+   */
+  senderUserID: string
+  /**
+   * 会话的 ID，相同会话类型下的 ID 是唯一的。
+   */
+  conversationID: string
+  /**
+   * 用于描述消息的方向是发送还是接收。0 消息已发送。1 消息已接受。
+   */
+  direction: number
+  /**
+   * 描述消息的发送状态。消息发送中。1 消息发送成功。2 消息发送失败。
+   */
+  sentStatus: number
+  /**
+   * 该消息所属会话的类型。
+   */
+  conversationType: number
+  /**
+   * 表示该消息在会话中的序号。
+   */
+  conversationSeq: string
+  /**
+   * orderKey 越大消息越新，可用于消息排序。
+   */
+  orderKey: string
+  /**
+   * 描述该消息的回执状态。0 不是回执。1 回执进行中。2 回执已完成。3 回执已过期。4 回执已失败。
+   */
+  receiptStatus: number
+  /**
+   * 该消息是否是全员推送消息。
+   */
+  isBroadcastMessage: string
+  /**
+   * 是否需要提醒所有人。业务表现可为“@所有人”。
+   */
+  isMentionAll: boolean
+  /**
+   * 提醒一批相关的用户。业务表现可为“@某用户”。
+   */
+  mentionedUserIDs: string[]
+  /**
+   * 本条消息最新的编辑者的 userID。
+   */
+  editorUserID: string
+  /**
+   * 本条消息最新的编辑时间戳。
+   */
+  editedTime: string
+  /**
+   * 该消息最后一次置顶的置顶时间。
+   */
+  pinnedTime: string
+  /**
+   * 该消息的最后一次置顶的置顶者。
+   */
+  pinnedUserID: string
+  /**
+   * 消息记录
+   */
+  message: string
+  /**
+   * 文件下载地址 (多媒体消息会有记录)
+   */
+  fileDownloadUrl: string
+  /**
+   * 如果是视频/语音，时长(多媒体消息会有记录)
+   */
+  duration: string
+  /**
+   * 文件名字 (多媒体消息会有记录)
+   */
+  fileName: string
+  /**
+   * 缩略图 (多媒体消息会有记录)
+   */
+  thumbnailDownloadUrl: string
+  /**
+   * 缩略图宽度 (多媒体消息会有记录)
+   */
+  thumbnailWidth: string
+  /**
+   * 缩略图高度 (多媒体消息会有记录)
+   */
+  thumbnailHeight: string
+}
+
+interface IYapiPostSdkDeleteAllConversationMessagesApiResponse {
+	code: string
+	message: string
+	data: string
+}
+
+interface IYapiPostSdkDeleteMessagesApiResponse {
+	code: string
+	message: string
+	data: string
+}
+
+interface IYapiPostSdkRevokeMessageApiRequest {
+	message: IYapiPostSdkRevokeMessageApiRequestMessage
+	
+	config?: YapiPostSdkRevokeMessageApiRequestConfig
+}
+
+interface YapiPostSdkRevokeMessageApiRequestConfig {
+  revokeExtendedData: string
+}
+
+interface IYapiPostSdkRevokeMessageApiRequestMessage {
+	
+	type?: number
+	
+	messageID?: string
+}
+
+
+interface IYapiPostSdkRevokeMessageApiResponse {
+	code: string
+	message: string
+	data: string
+}
+
+/**
+ * 发送消息
+ * @param payload 发送消息参数
+ * @returns 发送结果
+ */
+declare function sendMessage(payload: IYapiPostSdkSendMessageApiRequest): Promise<IYapiPostSdkSendMessageApiResponse['data']>;
+/**
+ * 发送媒体消息
+ * @param payload 发送媒体消息参数
+ * @returns 发送结果
+ */
+declare function sendMediaMessage(payload: {
+    message: ZIMSEDMediaMessage;
+    toConversationID: string;
+    conversationType: ZIMConversationType;
+}): Promise<IYapiPostSdkSendMediaMessageApiResponse['data']>;
+/**
+ * 查询历史消息
+ * @param payload 查询参数
+ * @returns 历史消息列表
+ */
+declare function queryHistoryMessage(payload: IYapiPostSdkQueryHistoryMessageApiRequest): Promise<IYapiPostSdkQueryHistoryMessageApiResponse['data']>;
+/**
+ * 删除所有会话的所有消息
+ * @param payload 删除参数
+ * @returns 删除结果
+ */
+declare function deleteAllConversationMessages(): Promise<IYapiPostSdkDeleteAllConversationMessagesApiResponse>;
+/**
+ * 删除消息
+ * @param payload 删除消息参数
+ * @returns 删除结果
+ */
+declare function deleteMessages(conversationID: string, conversationType: ZIMConversationType, messageList: {
+    messageID: string;
+    type: string;
+}[]): Promise<IYapiPostSdkDeleteMessagesApiResponse>;
+/**
+ * 撤回消息
+ * @param payload 撤回消息参数
+ * @returns 撤回结果
+ */
+declare function revokeMessage(message: IYapiPostSdkRevokeMessageApiRequest['message'], config?: IYapiPostSdkRevokeMessageApiRequest['config']): Promise<IYapiPostSdkRevokeMessageApiResponse>;
+declare function deleteAllMessage(conversationID: string, conversationType: ZIMConversationType): Promise<{
+    code: string;
+    message: string;
+    data: string;
+}>;
+
+declare function sendMessageReceiptsRead(conversationID: string, conversationType: ZIMConversationType, messageList: string[]): Promise<YapiPostSdkSendMessageReceiptsReadApiResponse>;
+declare function queryMessageReceiptsInfo(conversationID: string, conversationType: ZIMConversationType, messageList: string[]): Promise<YapiPostSdkQueryMessageReceiptsInfoApiResponse>;
+declare function queryGroupMessageReceiptUnreadMemberList(groupID: string, config: {
+    count: string;
+    nextFlag: string;
+}, message: {
+    messageID: string;
+}): Promise<YapiPostSdkQueryGroupMessageReceiptUnreadMemberListApiResponse>;
+declare function queryGroupMessageReceiptReadMemberList(groupID: string, config: {
+    count: string;
+    nextFlag: string;
+}, message: {
+    messageID: string;
+}): Promise<YapiPostSdkQueryGroupMessageReceiptReadMemberListApiResponse>;
+
+declare const VanshiSdk: ZIM;
+
+export { clearConversationTotalUnreadMessageCount, clearConversationUnreadMessageCount, initSocket as create, VanshiSdk as default, deleteAllConversationMessages, deleteAllConversations, deleteAllMessage, deleteConversation, deleteMessages, isSocketConnected as isConnected, login, logout, off, on, queryConversation, queryGroupMessageReceiptReadMemberList, queryGroupMessageReceiptUnreadMemberList, queryHistoryMessage, queryMessageReceiptsInfo, revokeMessage, sendMediaMessage, sendMessage, sendMessageReceiptsRead };