## BytedIM 类型: `class` IM 类，所有 API 交互都通过该类的实例来操作，实例化支持的参数参见 [IMOption](293539#imoption)。 - **API** | 方法 | 描述 | | :-- | :-- | | [init](#bytedim-init) | 初始化 SDK。
初始化时会完成与服务端的消息游标同步和历史信息同步。 | | [createCustomMessage](#bytedim-createcustommessage) | 创建自定义消息。 | | [createTextMessage](#bytedim-createtextmessage) | 创建文本消息。 | | [sendMessage](#bytedim-sendmessage) | 发送消息。 | | [deleteMessage](#bytedim-deletemessage) | 删除消息。（直播群不适用） | | [recallMessage](#bytedim-recallmessage) | 撤回消息。（直播群不适用） | | [modifyMessage](#bytedim-modifymessage) | 更新消息内容 (content) 或 ext 或 at 用户列表（支持同时更新）（直播群不适用） | | [getMessageByServerId](#bytedim-getmessagebyserverid) | 根据指定会话中的消息服务端 ID 获取对应消息（直播群不适用） | | [getMessageReferenceList](#bytedim-getmessagereferencelist) | 获取引用消息链。（直播群不适用）
若消息 B 引用了消息 A，消息 C 引用了消息 B，那么 A -> B -> C 就是一条引用消息链。通过 A、B、C 任意一条消息都可以获取这条消息链。 | | [modifyMessageProperty](#bytedim-modifymessageproperty) | 设置消息属性，常见使用场景：给某条消息点赞、加急等。（直播群不适用） | | [getConversation](#bytedim-getconversation) | 获取指定单个本地会话。（直播群需通过 getConversationOnline 直接从服务端获取） | | [getConversationOnline](#bytedim-getconversationonline) | 请求服务端更新本地会话后，获取指定单个会话。 | | [getConversationList](#bytedim-getconversationlist) | 获取本地会话列表。 | | [getConversationListOnline](#bytedim-getconversationlistonline) | 请求服务端更新本地会话后，获取会话列表。直播群列表请使用 [getLiveConversationListOnline](293536#getliveconversationlistonline)。 | | [getMessagesByConversation](#bytedim-getmessagesbyconversation) | 从服务器获取会话内区间的消息，默认情况下从本地最早的消息开始拉取 (cursor = conversation.firstMessageIndex) 。拉取直播群区间消息请使用 getLiveGroupHistoryMessageListOnline。 | | [getUserConversationList](#bytedim-getuserconversationlist) | 请求服务器获取用户的会话列表。 | | [createConversation](#bytedim-createconversation) | 创建群聊。 | | [leaveConversation](#bytedim-leaveconversation) | 离开群组。 | | [deleteConversation](#bytedim-deleteconversation) | 删除会话。（直播群不适用） | | [dissolveConversation](#bytedim-dissolveconversation) | 解散群聊。 | | [setConversationSettingInfo](#bytedim-setconversationsettinginfo) | 设置会话附加信息，如置顶、免打扰、收藏等。（直播群不适用） | | [setConversationWeakMuteConfig](#bytedim-setconversationweakmuteconfig) | 配置会话低打扰模式。（直播群不适用） | | [upsertConversationSettingExtInfo](#bytedim-upsertconversationsettingextinfo) | 更新 Setting ext 拓展信息。（直播群不适用） | | [setConversationCoreInfo](#bytedim-setconversationcoreinfo) | 设置群聊信息。 | | [upsertConversationCoreExtInfo](#bytedim-upsertconversationcoreextinfo) | 更新 Core ext 拓展信息。 | | [getConversationListByTop](#bytedim-getconversationlistbytop) | 获取顶置会话。（直播群不适用） | | [getConversationListByFavorite](#bytedim-getconversationlistbyfavorite) | 获取收藏会话。（直播群不适用） | | [markConversationRead](#bytedim-markconversationread) | 标记会话已读，以清除未读数。（直播群不适用） | | [sendMessageReadReceipts](#bytedim-sendmessagereadreceipts) | 标记指定会话中的指定消息消息已读（发送已读回执）（v1.11.0 新增，在群聊中使用消息级已读回执需联系技术支持开通；直播群不适用） | | [getMessagesReadReceiptOnline](#bytedim-getmessagesreadreceiptonline) | 获得指定消息的已读回执（v1.11.0 新增，在群聊中使用消息级已读回执需联系技术支持开通；直播群不适用） | | [markConversationMessagesRead](#bytedim-markconversationmessagesread) | 标记会话内的所有消息已读（发送已读回执）（v1.11.0 新增，在群聊中使用消息级已读回执需联系技术支持开通；仅支持单聊，群聊和直播群不适用） | | [addParticipants](#bytedim-addparticipants) | 添加群成员。（直播群不适用，如需加入直播群请在用户端加入直播群 joinLiveGroup） | | [removeParticipants](#bytedim-removeparticipants) | 移除普通群成员/移除直播群内其它成员，v1.1.0 新增直播群功能。
注：如需自己退出直播群，请使用 leaveLiveGroup | | [updateParticipant](#bytedim-updateparticipant) | 更新群成员信息。 | | [getParticipants](#bytedim-getparticipants) | 获取 SDK 本地维护的群成员列表。（直播群不适用） | | [getParticipantsOnline](#bytedim-getparticipantsonline) | 从服务端获取群成员列表。 | | [setConversationMute](#bytedim-setconversationmute) | 设置群禁言（会话维度）。 | | [setParticipantMuteTime](#bytedim-setparticipantmutetime) | 设置群禁言（成员维度）。 | | [sendP2PMessage](#bytedim-sendp2pmessage) | 发送自定义透传消息（直播群不适用） | | [dispose](#bytedim-dispose) | 手动卸载 SDK。 | ### init 初始化 SDK。初始化时会完成与服务端的消息游标同步和历史信息同步。 - **类型** ```ts (params?: { convLimit?: number; msgLimit?: number; convTotal?: number;}) => Promise ``` - **注意** 可设置 [IMOption](293539#imoption) disableInitPull 关闭历史信息同步。 - **参数** - **params** 类型: { convLimit?: number | undefined; msgLimit?: number | undefined; convTotal?: number | undefined; } | undefined - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | convLimit | `number | undefined` | 每次调用初始化拉取接口时，会话数量限制。 | | msgLimit | `number | undefined` | 每次调用初始化拉取接口时，每个对话返回的消息数量限制。 | | convTotal | `number | undefined` | 初始化拉取的会话总数量限制。该值非 0 时，当本地会话数量大于等于该值时停止拉取。 | - **返回值** 类型: Promise<[InitResult](293539#initresult)\> 初始化结果。 ### createCustomMessage 创建自定义消息。 - **类型** ```ts (params: { conversation: Conversation; content: string; clientId?: string | undefined; ext?: { [k: string]: string; } | undefined; mentionedUsers?: string[] | undefined; insert?: boolean | undefined; referenceMessage?: Message | undefined; referenceHint?: string | undefined; }) => Promise ``` - **参数** - **params** 类型:

{ conversation: [Conversation](293539#conversation); content: string; clientId?: string | undefined; ext?: { [k: string]: string; } | undefined; mentionedUsers?: string[] | undefined; insert?: boolean | undefined; referenceMessage?: [Message](293539#message) | undefined; referenceHint?: string | undefined; }

{ conversation: [Conversation](293539#conversation); content: string; clientId?: string | undefined; ext?: { [k: string]: string; } | undefined; mentionedUsers?: string[] | undefined; insert?: boolean | undefined; referenceMessage?: [Message](293539#message) | undefined; referenceHint?: string | undefined; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 当前发送消息的会话。 | | content | `string` | 消息体。 | | clientId | `string | undefined` | 客户端 ID。 | | ext | `{ [k: string]: string; } | undefined` | 消息拓展属性。 | | mentionedUsers | `string[] | undefined` | 需要 @ 的用户列表。 | | insert | `boolean | undefined` | 消息创建后是否 process 处理（新消息处理流程）。 | | referenceMessage | `Message | undefined` | 引用的消息。 | | referenceHint | `string | undefined` | 业务透传的引用信息，传入自定义引用线索。 | - **返回值** 创建的消息，参看 [Message](293539#message)。 ### sendMessage 发送消息。 - **类型** ```ts (params: { message: Message; priority?: im_proto.MessagePriority;}) => Promise ``` - **参数** - **params** 类型: { message: [Message](293539#message); priority?: im_proto.[MessagePriority](293539#messagepriority) | undefined; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | message | `Message` | 要发送的消息，由 `createXxxMessage` 接口创建。 | | priority | `im_proto.MessagePriority | undefined` | 消息的优先级（适用于直播群消息） | - **返回值** 发送消息结果。 ### deleteMessage 删除消息。（直播群不适用） - **类型** ```ts (params: { message: Message; localOnly?: boolean;}) => Promise ``` - **参数** - **params** 类型: { message: [Message](293539#message); localOnly?: boolean | undefined; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | message | `Message` | 待删除的消息。 | | localOnly | `boolean | undefined` | 是否仅删除本地，不同步到服务端。 | ### recallMessage 撤回消息。（直播群不适用） - **类型** ```ts (params: { message: Message;}) => Promise ``` - **参数** - **params** 类型: { message: [Message](293539#message); } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | message | `Message` | 待撤回的消息。 | ### modifyMessage 更新消息内容 (content) 或 ext 或 at 用户列表（支持同时更新）（直播群不适用） - **类型** ```ts (params: { message: Message; ext?: { [k: string]: string; } | undefined; content?: string | undefined; mentionedUsers?: string[] | undefined; }) => Promise<{ message: Message; }> ``` - **参数** - **params** 类型:

{ message: [Message](293539#message); ext?: { [k: string]: string; } | undefined; content?: string | undefined; mentionedUsers?: string[] | undefined; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | message | `Message` | 消息 | | ext | `{ [k: string]: string; } | undefined` | （可选）需要更新的拓展信息（与旧的合并） | | content | `string | undefined` | （可选）修改后的消息内容 | | mentionedUsers | `string[] | undefined` | （可选）新的被 at 的用户列表 | - **返回值** 被修改的消息 ### getMessageByServerId 根据指定会话中的消息服务端 ID 获取对应消息（直播群不适用） - **类型** ```ts (params: { conversation: Conversation; serverMessageId: string; online?: boolean;}) => Promise ``` - **参数** - **params** 类型: { conversation: [Conversation](293539#conversation); serverMessageId: string; online?: boolean | undefined; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 会话信息。 | | serverMessageId | `string` | 消息的 serverId。 | | online | `boolean | undefined` | 是否必须从服务端获取，默认会先从本地返回 | - **返回值** 参看 [Message](293539#message)。 ### getMessageReferenceList 获取引用消息链。（直播群不适用）若消息 B 引用了消息 A，消息 C 引用了消息 B，那么 A -> B -> C 就是一条引用消息链。通过 A、B、C 任意一条消息都可以获取这条消息链。 - **类型** ```ts (params: { message: Message;}) => Promise ``` - **参数** - **params** 类型: { message: [Message](293539#message); } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | message | `Message` | 消息体。 | - **返回值** 类型: Promise<[Message](293539#message)[]\> 引用消息链。 ### modifyMessageProperty 设置消息属性，常见使用场景：给某条消息点赞、加急等。（直播群不适用） - **类型** ```ts (params: { message: Message; modifyContent: Array<{ key: string; operation?: im_proto.OPERATION_TYPE; value?: string; idempotentId?: string; }>;}) => Promise ``` - **注意** 消息加急本质上是修改消息属性，在中台侧仅为一个状态变更。加急之后的附加操作（如全局提醒、短信电话提醒等）需要业务方自行处理。 - **参数** - **params** 类型:

{ message: [Message](293539#message); modifyContent: Array<{ key: string; operation?: im_proto.[OPERATION_TYPE](293539#operation_type); value?: string; idempotentId?: string;}\>; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | message | `Message` | 消息体。 | | modifyContent | `{ key: string; operation?: im_proto.OPERATION_TYPE | undefined; value?: string | undefined; idempotentId?: string | undefined; }[]` | 消息属性。 | | modifyContent.key | `string` | 表情回应消息，例如 OK/点赞/done 等。 | | modifyContent.operation | `im_proto.OPERATION_TYPE | undefined` | 操作类型。 | | modifyContent.value | `string | undefined` | 对应 content。也可以什么都不存，只代表有这个 key。 | | modifyContent.idempotentId | `string | undefined` | 幂等 ID。通常为 user ID，防止对单个点赞动作重复操作。 | - **返回值** 类型: Promise<[ModifyMessagePropertyResult](293539#modifymessagepropertyresult)\> 设置消息属性结果。 ### getConversation 获取指定单个本地会话。（直播群需通过 getConversationOnline 直接从服务端获取） - **类型** ```ts (params: { conversationId: string;}) => Conversation ``` - **参数** - **params** 类型: { conversationId: string; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversationId | `string` | 会话 ID。 | - **返回值** 参看 [Conversation](293539#conversation)。 ### getConversationOnline 请求服务端更新本地会话后，获取指定单个会话。 - **类型** ```ts (params: { conversationId?: string; shortId: string; type: im_proto.ConversationType;}) => Promise ``` - **参数** - **params** 类型: { conversationId?: string | undefined; shortId: string; type: im_proto.[ConversationType](293539#conversationtype); } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | shortId | `string` | 会话 shortId。 | | type | `im_proto.ConversationType` | 会话类型。 | - **返回值** 参看 [Conversation](293539#conversation)。 ### getConversationList 获取本地会话列表。 - **类型** ```ts (params?: { filter?: ((c: Conversation) => boolean) | undefined; }) => Conversation[] ``` - **参数** - **params** 类型: { filter?: ((c: [Conversation](293539#conversation)) =\> boolean) | undefined; } 默认值: `' {}'` - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | filter | `((c: Conversation) => boolean) | undefined` | 过滤条件，默认过滤陌生人会话和空会话。 | ### getConversationListOnline 请求服务端更新本地会话后，获取会话列表。直播群列表请使用 [getLiveConversationListOnline](293536#getliveconversationlistonline)。 - **类型** ```ts (params?: { filter?: ((c: Conversation) => boolean) | undefined; }) => Promise ``` - **参数** - **params** 类型: { filter?: ((c: [Conversation](293539#conversation)) =\> boolean) | undefined; } 默认值: `' {}'` - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | filter | `((c: Conversation) => boolean) | undefined` | 过滤条件，默认过滤陌生人会话和空会话。 | ### getMessagesByConversation 从服务器获取会话内区间的消息，默认情况下从本地最早的消息开始拉取 (cursor = conversation.firstMessageIndex) 。拉取直播群区间消息请使用 getLiveGroupHistoryMessageListOnline。 - **类型** ```ts (params: { conversation: Conversation; cursor?: string | Long | Message; direction?: im_proto.MessageDirection; limit?: number; limitIndex?: Long;}) => Promise<{ messages: Message[]; hasMore: boolean; cursor: Long; }> ``` - **注意** 如果需要获得某个会话本地已有的消息，需调用 [conversation.getMessageList()](293539#conversation-getmessagelist)。 - **参数** - **params** 类型:

{ conversation: [Conversation](293539#conversation); cursor?: string | Long | [Message](293539#message) | undefined; direction?: im_proto.[MessageDirection](293539#messagedirection) | undefined; limit?: number | undefined; limitIndex?: Long | undefined; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 会话信息。 | | cursor | `string | Long | Message | undefined` | 拉取消息位置游标。 | | limit | `number | undefined` | 拉取消息数量，默认 20 条。 | | limitIndex | `Long | undefined` | 保留参数，无意义。 | - **返回值** 会话内的消息列表，其中消息结构参看 [Message](293539#message)。 ### getUserConversationList 请求服务器获取用户的会话列表。 - **类型** ```ts (params: { type: im_proto.ConversationType; inboxType?: number; cursor?: Long | string; limit?: number; sortType?: im_proto.SortType; includeRole?: number; excludeRole?: number; withCold?: boolean;}) => Promise<{ conversation: Conversation[]; hasMore: boolean; cursor: Long; }> ``` - **参数** - **params** 类型:

{ type: im_proto.[ConversationType](293539#conversationtype); inboxType?: number | undefined; cursor?: string | Long | undefined; limit?: number | undefined; sortType?: im_proto.[SortType](293539#sorttype) | undefined; includeRole?: number | undefined; excludeRole?: number | undefined; withCold?: boolean | undefined; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | type | `im_proto.ConversationType` | 会话类型。 | | inboxType | `number | undefined` | 信箱类型。 | | cursor | `string | Long | undefined` | 拉取消息位置游标。 | | limit | `number | undefined` | 单次拉取消息数量。 | | sortType | `im_proto.SortType | undefined` | 排序类型。 | | includeRole | `number | undefined` | 查询群聊类型时，包含的群聊角色，参看 [GroupRole](293539#grouprole)。 | | excludeRole | `number | undefined` | 查询群聊类型时，排除的群聊角色，参看 [GroupRole](293539#grouprole)。 | | withCold | `boolean | undefined` | 保留参数，无意义。 | - **返回值** 用户会话列表和分页消息，其中会话结构参看 [Conversation](293539#conversation)。 ### createConversation 创建群聊。 - **类型** ```ts (params: { participants: string[] | string; bizExt?: { [k: string]: string; } | undefined; inboxType?: number | undefined; type?: im_proto.ConversationType | undefined; persistent?: boolean | undefined; idempotentId?: string | undefined; name?: string | undefined; avatarUrl?: string | undefined; desc?: string | undefined; }) => Promise ``` - **参数** - **params** 类型:

{ participants: string[] | string; bizExt?: { [k: string]: string; } | undefined; inboxType?: number | undefined; type?: im_proto.[ConversationType](293539#conversationtype) | undefined; persistent?: boolean | undefined; idempotentId?: string | undefined; name?: string | undefined; avatarUrl?: string | undefined; desc?: string | undefined; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | participants | `string | string[]` | 会话内的用户 ID。 | | bizExt | `{ [k: string]: string; } | undefined` | 业务拓展信息。 | | inboxType | `number | undefined` | 信箱类型。 | | type | `im_proto.ConversationType | undefined` | 会话类型。 | | persistent | `boolean | undefined` | 持久化幂等，默认为 true，不建议修改。 | | idempotentId | `string | undefined` | 幂等 ID。由业务方自己生成，以同样的幂等 ID 创建群聊会话时，会返回之前已经创建好的群聊会话。 | | name | `string | undefined` | 群名称。 | | avatarUrl | `string | undefined` | 群头像的 url 链接。 | | desc | `string | undefined` | 群描述。 | - **返回值** 类型: Promise<[CreateConversationResult](293539#createconversationresult)\> 创建结果。 ### leaveConversation 离开群组。 - **类型** ```ts (params: { conversation: Conversation;}) => Promise ``` - **参数** - **params** 类型: { conversation: [Conversation](293539#conversation); } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 会话信息。 | ### deleteConversation 删除会话。（直播群不适用） - **类型** ```ts (params: { conversation: Conversation; localOnly?: boolean;}) => Promise ``` - **参数** - **params** 类型: { conversation: [Conversation](293539#conversation); localOnly?: boolean | undefined; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 待删除的会话。 | | localOnly | `boolean | undefined` | 是否仅在本地删除，不同步到服务端。
默认值为 false，即本地和服务端均删除。 | ### dissolveConversation 解散群聊。 - **类型** ```ts (params: { conversation: Conversation;}) => Promise ``` - **参数** - **params** 类型: { conversation: [Conversation](293539#conversation); } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 会话信息。 | ### setConversationSettingInfo 设置会话附加信息，如置顶、免打扰、收藏等。（直播群不适用） - **类型** ```ts (params: { conversation: Conversation; stickOnTop?: boolean; mute?: boolean; favorite?: boolean; pushStatus?: PushStatus;}) => Promise ``` - **参数** - **params** 类型:

{ conversation: [Conversation](293539#conversation); stickOnTop?: boolean | undefined; mute?: boolean | undefined; favorite?: boolean | undefined; pushStatus?: [PushStatus](293539#pushstatus) | undefined; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 会话信息。 | | stickOnTop | `boolean | undefined` | 是否置顶。 | | mute | `boolean | undefined` | 是否免打扰。 | | favorite | `boolean | undefined` | 是否收藏。 | | pushStatus | `PushStatus | undefined` | 消息推送模式。 | - **返回值** 类型: Promise<[SetConversationSettingInfoResult](293539#setconversationsettinginforesult)\> 设置结果。 ### setConversationWeakMuteConfig 配置会话低打扰模式。（直播群不适用） - **类型** ```ts (params: { conversation: Conversation; config: ConversationSettingWeakMuteInfo;}) => Promise<{ success: boolean; payload: Conversation; checkCode: Long; checkMsg: string; statusCode: number; statusMsg: string; }> ``` - **参数** - **params** 类型:

{ conversation: [Conversation](293539#conversation); config: [ConversationSettingWeakMuteInfo](293539#conversationsettingweakmuteinfo); }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 会话信息。 | | config | `ConversationSettingWeakMuteInfo` | 会话低打扰模式配置。 | ### upsertConversationSettingExtInfo 更新 Setting ext 拓展信息。（直播群不适用） - **类型** ```ts (params: { conversation: Conversation; ext?: { [k: string]: string; } | undefined; }) => Promise<{ success: boolean; payload: Conversation; checkCode: Long; checkMsg: string; statusCode: number; statusMsg: string; }> ``` - **参数** - **params** 类型: { conversation: [Conversation](293539#conversation); ext?: { [k: string]: string; } | undefined; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 会话信息。 | | ext | `{ [k: string]: string; } | undefined` | 拓展信息。 | ### setConversationCoreInfo 设置群聊信息。 - **类型** ```ts (params: { conversation: Conversation; name?: string | undefined; desc?: string | undefined; icon?: string | undefined; notice?: string | undefined; isNameSet?: boolean | undefined; isDescSet?: boolean | undefined; isIconSet?: boolean | undefined; isNoticeSet?: boolean | undefined; ext?: { [k: string]: string; } | undefined; bizExt?: { [k: string]: string; } | undefined;})=> Promise ``` - **参数** - **params** 类型:

{ conversation: [Conversation](293539#conversation); name?: string | undefined; desc?: string | undefined; icon?: string | undefined; notice?: string | undefined; isNameSet?: boolean | undefined; isDescSet?: boolean | undefined; isIconSet?: boolean | undefined; isNoticeSet?: boolean | undefined; ext?: { [k: string]: string; } | undefined; bizExt?: { [k: string]: string; } | undefined; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 会话信息。 | | name | `string | undefined` | 群名称。 | | desc | `string | undefined` | 群描述。 | | icon | `string | undefined` | 群头像的 url 链接。 | | notice | `string | undefined` | 群公告。 | | isNameSet | `boolean | undefined` | 是否设置群名称。 | | isDescSet | `boolean | undefined` | 是否设置群描述。 | | isIconSet | `boolean | undefined` | 是否设置群头像。 | | isNoticeSet | `boolean | undefined` | 是否设置群公告。 | | ext | `{ [k: string]: string; } | undefined` | 拓展信息。 | | bizExt | `{ [k: string]: string; } | undefined` | 业务拓展信息。 | - **返回值** 类型: Promise<[SetConversationSettingInfoResult](293539#setconversationsettinginforesult)\> 群聊信息设置结果。 ### upsertConversationCoreExtInfo 更新 Core ext 拓展信息。 - **类型** ```ts (params: { conversation: Conversation; ext?: { [k: string]: string; } | undefined; }) => Promise<{ success: boolean; payload: Conversation; checkCode: Long; checkMsg: string; statusCode: number; statusMsg: string; }> ``` - **参数** - **params** 类型: { conversation: [Conversation](293539#conversation); ext?: { [k: string]: string; } | undefined; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 会话信息。 | | ext | `{ [k: string]: string; } | undefined` | 拓展信息。 | - **返回值** 更新结果。 ### getConversationListByTop 获取顶置会话。（直播群不适用） - **类型** ```ts (params?: { cursor?: string | Long; limit?: number; inboxType?: number;}) => Promise<{ conversation: Conversation[]; hasMore: boolean; cursor: Long; }> ``` - **参数** - **params** 类型: { cursor?: string | Long | undefined; limit?: number | undefined; inboxType?: number | undefined; } 默认值: `' {}'` - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | cursor | `string | Long | undefined` | 拉取位置游标，默认值为 0。 | | limit | `number | undefined` | 拉取数量，默认值为 10。 | | inboxType | `number | undefined` | 信箱类型。 | - **返回值** 获取到的会话，其中会话结构参看 [Conversation](293539#conversation)。 ### getConversationListByFavorite 获取收藏会话。（直播群不适用） - **类型** ```ts (params?: { cursor?: string | Long; limit?: number; inboxType?: number;}) => Promise<{ conversation: Conversation[]; hasMore: boolean; cursor: Long; }> ``` - **参数** - **params** 类型: { cursor?: string | Long | undefined; limit?: number | undefined; inboxType?: number | undefined; } 默认值: `' {}'` - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | cursor | `string | Long | undefined` | 拉取位置游标，默认值为 0。 | | limit | `number | undefined` | 拉取数量，默认值为 10。 | | inboxType | `number | undefined` | 信箱类型。 | - **返回值** 获取到的会话，其中会话结构参看 [Conversation](293539#conversation)。 ### markConversationRead 标记会话已读，以清除未读数。（直播群不适用） - **类型** ```ts (params: { conversation: Conversation; readIndex?: string | Long | Message; convUnreadCount?: number; totalUnreadCount?: number;}) => Promise ``` - **参数** - **params** 类型:

{ conversation: [Conversation](293539#conversation); readIndex?: string | Long | [Message](293539#message) | undefined; convUnreadCount?: number | undefined; totalUnreadCount?: number | undefined; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 会话信息。 | | readIndex | `string | Long | Message | undefined` | 要标记到的最新消息的 indexInConversation。默认为会话的 lastMessageIndex（最后一条消息的 index）。 | | convUnreadCount | `number | undefined` | 会话中未读消息数。 | | totalUnreadCount | `number | undefined` | 总未读消息数。 | ### sendMessageReadReceipts 标记指定会话中的指定消息消息已读（发送已读回执）（v1.11.0 新增，在群聊中使用消息级已读回执需联系技术支持开通；直播群不适用） - **类型** ```ts (params: { conversation: Conversation; messages: Message[];}) => Promise<{}> ``` - **参数** - **params** 类型: { conversation: [Conversation](293539#conversation); messages: [Message](293539#message)[]; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 会话信息。 | | messages | `Message[]` | 要标记的消息 | - **返回值** （无数据返回） ### getMessagesReadReceiptOnline 获得指定消息的已读回执（v1.11.0 新增，在群聊中使用消息级已读回执需联系技术支持开通；直播群不适用） - **类型** ```ts (params: { conversation: Conversation; messages: Message[];}) => Promise ``` - **参数** - **params** 类型: { conversation: [Conversation](293539#conversation); messages: [Message](293539#message)[]; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 会话信息。 | | messages | `Message[]` | 要获取已读回执的消息 | - **返回值** 消息已读回执 ### markConversationMessagesRead 标记会话内的所有消息已读（发送已读回执）（v1.11.0 新增，在群聊中使用消息级已读回执需联系技术支持开通；仅支持单聊，群聊和直播群不适用） - **类型** ```ts (params: { conversation: Conversation; readIndex?: string | Long | Message;}) => Promise<{}> ``` - **参数** - **params** 类型:

{ conversation: [Conversation](293539#conversation); readIndex?: string | Long | [Message](293539#message) | undefined; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 会话信息。 | | readIndex | `string | Long | Message | undefined` | 要标记到的最新消息的 indexInConversation。默认为会话的 lastMessageIndex（最后一条消息的 index）。 | - **返回值** （无数据返回） ### addParticipants 添加群成员。（直播群不适用，如需加入直播群请在用户端加入直播群 joinLiveGroup） - **类型** ```ts (params: { conversation: Conversation; participant: Participant | Participant[] | string[] | string; bizExt?: { [k: string]: string; } | undefined; isDropReconnect?: boolean | undefined; _participantInfos?: { user_id?: Long | null | undefined; alias?: string | null | undefined; ext?: { [k: string]: string; } | null | undefined; avatar_url?: string | null | undefined; }[] | undefined; }) => Promise ``` - **参数** - **params** 类型:

{ conversation: [Conversation](293539#conversation); participant: [Participant](293539#participant) | [Participant](293539#participant)[] | string[] | string; bizExt?: { [k: string]: string; } | undefined; isDropReconnect?: boolean | undefined; _participantInfos?: { user_id?: Long | null | undefined; alias?: string | null | undefined; ext?: { [k: string]: string; } | null | undefined; avatar_url?: string | null | undefined; }[] | undefined; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 会话信息。 | | participant | `string | string[] | Participant | Participant[]` | 待添加的群成员 ID 列表。 | | bizExt | `{ [k: string]: string; } | undefined` | 业务拓展信息。 | | isDropReconnect | `boolean | undefined` | 是否是掉线重连。若用户因网络波动等原因掉线，SDK 会在网络恢复后自动重连。 | - **返回值** 类型: Promise<[AddParticipantResult](293539#addparticipantresult)\> 添加成员结果。 ### removeParticipants 移除普通群成员/移除直播群内其它成员，v1.1.0 新增直播群功能。注：如需自己退出直播群，请使用 leaveLiveGroup - **类型** ```ts (params: { conversation: Conversation; participant: Participant | Participant[] | string | string[]; bizExt?: { [k: string]: string; } | undefined; }) => Promise ``` - **参数** - **params** 类型:

{ conversation: [Conversation](293539#conversation); participant: [Participant](293539#participant) | [Participant](293539#participant)[] | string | string[]; bizExt?: { [k: string]: string; } | undefined; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 会话信息。 | | participant | `string | string[] | Participant | Participant[]` | 待移除的群成员 ID 列表。 | | bizExt | `{ [k: string]: string; } | undefined` | 业务拓展信息。 | - **返回值** 类型: Promise<[RemoveParticipantResult](293539#removeparticipantresult)\> 移除成员结果。 ### updateParticipant 更新群成员信息。 - **类型** ```ts (params: { conversation: Conversation; userId: string; role?: number | undefined; alias?: string | undefined; avatarUrl?: string | undefined; bizExt?: { [k: string]: string; } | undefined; }) => Promise ``` - **参数** - **params** 类型:

{ conversation: [Conversation](293539#conversation); userId: string; role?: number | undefined; alias?: string | undefined; avatarUrl?: string | undefined; bizExt?: { [k: string]: string; } | undefined; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 会话信息。 | | userId | `string` | 成员的用户 ID。 | | role | `number | undefined` | 成员角色。
0 为普通成员，1 为群主。 | | alias | `string | undefined` | 成员群昵称。 | | avatarUrl | `string | undefined` | 成员头像（直播群适用） | | bizExt | `{ [k: string]: string; } | undefined` | 业务拓展信息。 | - **返回值** 类型: Promise<[UpdateParticipantResult](293539#updateparticipantresult)\> 更新结果。 ### getParticipants 获取 SDK 本地维护的群成员列表。（直播群不适用） - **类型** ```ts (params: { conversation: Conversation;}) => Participant[] ``` - **参数** - **params** 类型: { conversation: [Conversation](293539#conversation); } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 会话信息。 | ### getParticipantsOnline 从服务端获取群成员列表。 - **类型** ```ts (params: { conversation: Conversation; limit?: number; cursor?: Long;}) => Promise<{ participants: Participant[]; hasMore: boolean; cursor: Long; }> ``` - **参数** - **params** 类型: { conversation: [Conversation](293539#conversation); limit?: number | undefined; cursor?: Long | undefined; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 会话信息。 | | limit | `number | undefined` | 单页拉取消息数量。 | | cursor | `Long | undefined` | 下一页拉取消息位置游标。 | - **返回值** 群成员列表与分页信息，其中成员结构参看 [Participant](293539#participant)。 ### setConversationMute 设置群禁言（会话维度）。 - **类型** ```ts (params: { conversation: Conversation; block: boolean; normalOnly?: boolean;}) => Promise ``` - **参数** - **params** 类型: { conversation: [Conversation](293539#conversation); block: boolean; normalOnly?: boolean | undefined; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 会话信息。 | | block | `boolean` | 是否禁言。 | | normalOnly | `boolean | undefined` | 是否只禁言普通群成员。 | - **返回值** 参看 [Conversation](293539#conversation)。 ### setParticipantMuteTime 设置群禁言（成员维度）。 - **类型** ```ts (params: { conversation: Conversation; block: boolean; blockDuration: { [k: string]: string | number | Long; }; bizExt?: { [k: string]: string; } | undefined; }) => Promise ``` - **参数** - **params** 类型:

{ conversation: [Conversation](293539#conversation); block: boolean; blockDuration: { [k: string]: string | number | Long; }; bizExt?: { [k: string]: string; } | undefined; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 会话信息。 | | block | `boolean` | 是否禁言。 | | blockDuration | `{ [k: string]: string | number | Long; }` | 禁言用户和时间。key 是用户 ID；value 是禁言时间，单位为秒。{111: 1000} 表示把用户 111 禁言 1000 秒。 | | bizExt | `{ [k: string]: string; } | undefined` | 业务拓展信息。 | - **返回值** 参看 [Conversation](293539#conversation)。 ### sendP2PMessage 发送自定义透传消息（直播群不适用） - **类型** ```ts (params: { conversation: Conversation; sendType: im_proto.SendType; msgType: number; content: string; ext?: { [k: string]: string; } | undefined; visibleUser?: string[] | undefined; invisibleUser?: string[] | undefined; }) => Promise ``` - **参数** - **params** 类型:

{ conversation: [Conversation](293539#conversation); sendType: im_proto.[SendType](293539#sendtype); msgType: number; content: string; ext?: { [k: string]: string; } | undefined; visibleUser?: string[] | undefined; invisibleUser?: string[] | undefined; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 会话 | | sendType | `im_proto.SendType` | 发送类型（按会话推送或按用户推送，参见 SendType） | | msgType | `number` | 消息类型 | | content | `string` | 消息内容 | | ext | `{ [k: string]: string; } | undefined` | 拓展信息 | | visibleUser | `string[] | undefined` | 可见用户 | | invisibleUser | `string[] | undefined` | 不可见用户 | - **返回值** （无数据返回） ### dispose 手动卸载 SDK。 - **类型** ```ts () => void ``` ## MultimediaPlugin 类型: `class` 多媒体消息插件，在 IM 实例化时传入后，IM 实例增加发送媒体消息的方法。 - **API** | 方法 | 描述 | | :-- | :-- | | [createImageMessage](#multimediaplugin-createimagemessage) | 创建图片消息。 | | [createAudioMessage](#multimediaplugin-createaudiomessage) | 创建音频消息。 | | [createVideoMessage](#multimediaplugin-createvideomessage) | 创建视频消息。 | | [createFileMessage](#multimediaplugin-createfilemessage) | 创建文件消息。 | | [refreshFileUrl](#multimediaplugin-refreshfileurl) | 根据消息内容刷新文件 URL。 | | [validateFileUrl](#multimediaplugin-validatefileurl) | 校验文件 URL 是否在有效期。 | | [getImageResizeUrls](#multimediaplugin-getimageresizeurls) | 获取图片 URL（缩放、转码）。 | | [cancelMediaFileMessagUpload](#multimediaplugin-cancelmediafilemessagupload) | 取消文件上传。 | ### createImageMessage 创建图片消息。 - **类型** ```ts (params: { conversation: Conversation; fileInfo: FileInfo; clientId?: string | undefined; ext?: { [k: string]: string; } | undefined; mentionedUsers?: string[] | undefined; insert?: boolean | undefined; referenceMessage?: Message | undefined; referenceHint?: string | undefined; }) => Promise ``` - **参数** - **params** 类型:

{ conversation: [Conversation](293539#conversation); fileInfo: [FileInfo](293539#fileinfo); clientId?: string | undefined; ext?: { [k: string]: string; } | undefined; mentionedUsers?: string[] | undefined; insert?: boolean | undefined; referenceMessage?: [Message](293539#message) | undefined; referenceHint?: string | undefined; }

{ conversation: [Conversation](293539#conversation); fileInfo: [FileInfo](293539#fileinfo); clientId?: string | undefined; ext?: { [k: string]: string; } | undefined; mentionedUsers?: string[] | undefined; insert?: boolean | undefined; referenceMessage?: [Message](293539#message) | undefined; referenceHint?: string | undefined; }

{ conversation: [Conversation](293539#conversation); fileInfo: [FileInfo](293539#fileinfo); clientId?: string | undefined; ext?: { [k: string]: string; } | undefined; mentionedUsers?: string[] | undefined; insert?: boolean | undefined; referenceMessage?: [Message](293539#message) | undefined; referenceHint?: string | undefined; }

{ conversation: [Conversation](293539#conversation); fileInfo: [FileInfo](293539#fileinfo); clientId?: string | undefined; ext?: { [k: string]: string; } | undefined; mentionedUsers?: string[] | undefined; insert?: boolean | undefined; referenceMessage?: [Message](293539#message) | undefined; referenceHint?: string | undefined; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 会话信息。 | | fileInfo | `FileInfo` | 文件信息。 | | clientId | `string | undefined` | 客户端 ID。 | | ext | `{ [k: string]: string; } | undefined` | 消息拓展属性。 | | mentionedUsers | `string[] | undefined` | 需要 @ 的用户列表。 | | insert | `boolean | undefined` | 消息创建后是否 process 处理（新消息处理流程）。 | | referenceMessage | `Message | undefined` | 引用的消息。 | | referenceHint | `string | undefined` | 业务透传的引用信息，传入自定义引用线索。 | - **返回值** 创建的消息，参看 [Message](293539#message)。 ### refreshFileUrl 根据消息内容刷新文件 URL。 - **类型** ```ts (params: { message: Message; ignoreCache?: boolean;}) => Promise ``` - **参数** - **params** 类型: { message: [Message](293539#message); ignoreCache?: boolean | undefined; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | message | `Message` | 消息内容。 | | ignoreCache | `boolean | undefined` | 是否忽略缓存。 | - **返回值** 参看 [Message](293539#message)。 ### validateFileUrl 校验文件 URL 是否在有效期。 - **类型** ```ts (params: { message: Message; delta?: number;}) => boolean ``` - **参数** - **params** 类型: { message: [Message](293539#message); delta?: number | undefined; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | message | `Message` | 消息内容 | | delta | `number | undefined` | 有效期偏移量，单位秒，默认提前30s认定过期 | - **返回值** 类型: boolean ### getImageResizeUrls 获取图片 URL（缩放、转码）。 - **类型** ```ts (params: { uri: string; format?: string; width: number; height: number;}) => Promise ``` - **参数** - **params** 类型: { uri: string; format?: string | undefined; width: number; height: number; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | uri | `string` | 图片 URI。 | | format | `string | undefined` | 图片格式，目前支持 jpeg, png, webp, gif。 | | width | `number` | 图片宽度。 | | height | `number` | 图片高度。 | - **返回值** 类型: Promise 图片 URL。 ### cancelMediaFileMessagUpload 取消文件上传。 - **类型** ```ts (params: { message: Message;}) => Promise ``` - **参数** - **params** 类型: { message: [Message](293539#message); } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | message | `Message` | 取消发送中的消息。 | - **返回值** 类型: Promise 文件是否取消成功。 ## LivePlugin 类型: `class` 直播群插件，在 IM 实例化时传入后，IM 实例增加直播群相关的方法。v1.1.0 新增。 - **API** | 方法 | 描述 | | :-- | :-- | | [joinLiveGroup](#liveplugin-joinlivegroup) | 加入直播群，加入成功时会启动直播 ping 和断线恢复重进（接口基于 addParticipants） | | [leaveLiveGroup](#liveplugin-leavelivegroup) | 离开直播群，并且会停止直播 ping（接口基于 removeParticipants） | | [setParticipantBlockTime](#liveplugin-setparticipantblocktime) | 拉黑直播群成员。 | | [getMuteParticipantsOnline](#liveplugin-getmuteparticipantsonline) | 获取直播群禁言成员列表。 | | [getBlockParticipantsOnline](#liveplugin-getblockparticipantsonline) | 获取直播群被拉黑成员列表。 | | [getLiveParticipantMuteWhiteListOnline](#liveplugin-getliveparticipantmutewhitelistonline) | 获取直播群禁言白名单。 | | [addLiveParticipantMuteWhiteList](#liveplugin-addliveparticipantmutewhitelist) | 添加指定成员到直播群禁言白名单。 | | [removeLiveParticipantMuteWhiteList](#liveplugin-removeliveparticipantmutewhitelist) | 从直播群禁言白名单移除指定成员。 | | [getLiveConversationListOnline](#liveplugin-getliveconversationlistonline) | 获取直播群列表。 | | [getLiveParticipantsOnline](#liveplugin-getliveparticipantsonline) | 获取直播群在线成员列表。 | | [getLiveParticipantCountOnline](#liveplugin-getliveparticipantcountonline) | 获取直播群在线人数 | | [getLiveParticipantInfoOnline](#liveplugin-getliveparticipantinfoonline) | 获取直播群指定成员状态信息（例如是否在线、最后活跃时间），v1.1.2 新增。 | | [getLiveParticipantDetailOnline](#liveplugin-getliveparticipantdetailonline) | 获取直播群指定成员资料（例如成员在群中的昵称、头像），v1.5.0 新增。 | | [getLiveGroupHistoryMessageListOnline](#liveplugin-getlivegrouphistorymessagelistonline) | 获取直播群历史消息 | | [updateLiveConversationMarks](#liveplugin-updateliveconversationmarks) | 更新直播群内的标记类型 | | [getLiveConversationMarksOnline](#liveplugin-getliveconversationmarksonline) | 获取直播群内的标记类型 | | [updateLiveParticipantsMarks](#liveplugin-updateliveparticipantsmarks) | 更新直播群内指定成员的标记，需要先在群中创建好对应标记类型 | ### joinLiveGroup 加入直播群，加入成功时会启动直播 ping 和断线恢复重进（接口基于 addParticipants） - **类型** ```ts (params: { conversation: Conversation; bizExt?: { [key: string]: string; } | undefined; avatarUrl?: string | undefined; alias?: string | undefined; participantExt?: { [k: string]: string; } | undefined; }) => Promise<...> ``` - **参数** - **params** 类型:

{ conversation: [Conversation](293539#conversation); bizExt?: { [key: string]: string; } | undefined; avatarUrl?: string | undefined; alias?: string | undefined; participantExt?: { [k: string]: string; } | undefined; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 直播群 | | bizExt | `{ [key: string]: string; } | undefined` | 业务拓展信息 | | avatarUrl | `string | undefined` | 进群后自己的群头像 | | alias | `string | undefined` | 进群后自己的群昵称 | | participantExt | `{ [k: string]: string; } | undefined` | 进群后自己的成员信息扩展字段 | - **返回值** 添加成员结果。 ### leaveLiveGroup 离开直播群，并且会停止直播 ping（接口基于 removeParticipants） - **类型** ```ts (params: { conversation: Conversation; bizExt?: { [key: string]: string; } | undefined; }) => Promise ``` - **参数** - **params** 类型: { conversation: [Conversation](293539#conversation); bizExt?: { [key: string]: string; } | undefined; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 直播群 | | bizExt | `{ [key: string]: string; } | undefined` | 业务拓展信息 | - **返回值** 移除成员结果。 ### setParticipantBlockTime 拉黑直播群成员。 - **类型** ```ts (params: { conversation: Conversation; block: boolean; blockDuration: { [k: string]: string | number | Long; }; bizExt?: { [k: string]: string; } | undefined; }) => Promise ``` - **参数** - **params** 类型:

{ conversation: [Conversation](293539#conversation); block: boolean; blockDuration: { [k: string]: string | number | Long; }; bizExt?: { [k: string]: string; } | undefined; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 会话信息。 | | block | `boolean` | 是否拉黑。 | | blockDuration | `{ [k: string]: string | number | Long; }` | 用户ID/拉黑时长。 | | bizExt | `{ [k: string]: string; } | undefined` | | - **返回值** 拉黑的消息。 ### getMuteParticipantsOnline 获取直播群禁言成员列表。 - **类型** ```ts (params: { conversation: Conversation; limit?: number; cursor?: Long;}) => Promise<{ participants: any; hasMore: any; cursor: any; }> ``` - **参数** - **params** 类型: { conversation: [Conversation](293539#conversation); limit?: number | undefined; cursor?: Long | undefined; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 直播群信息。 | | limit | `number | undefined` | 每页多少条，默认 20 条。 | | cursor | `Long | undefined` | 游标。 | - **返回值** 成员列表信息。 ### getBlockParticipantsOnline 获取直播群被拉黑成员列表。 - **类型** ```ts (params: { conversation: Conversation; limit?: number; cursor?: Long;}) => Promise<{ participants: any; hasMore: any; cursor: any; }> ``` - **参数** - **params** 类型: { conversation: [Conversation](293539#conversation); limit?: number | undefined; cursor?: Long | undefined; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 直播群信息。 | | limit | `number | undefined` | 每页多少条，默认 20 条。 | | cursor | `Long | undefined` | 游标。 | - **返回值** 成员列表信息。 ### getLiveParticipantMuteWhiteListOnline 获取直播群禁言白名单。 - **类型** ```ts (params: { conversation: Conversation; cursor?: Long; limit?: number;}) => Promise<{ participants: any; hasMore: any; cursor: any; }> ``` - **参数** - **params** 类型: { conversation: [Conversation](293539#conversation); cursor?: Long | undefined; limit?: number | undefined; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 需要获取的直播群 | | cursor | `Long | undefined` | 游标。 | | limit | `number | undefined` | 每页多少条，默认 20 条。 | - **返回值** 直播群禁言白名单。 ### addLiveParticipantMuteWhiteList 添加指定成员到直播群禁言白名单。 - **类型** ```ts (params: { conversation: Conversation; participantIds: string[];}) => Promise<{ failedParticipantIds: string[]; }> ``` - **参数** - **params** 类型: { conversation: [Conversation](293539#conversation); participantIds: string[]; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 直播群 | | participantIds | `string[]` | 成员 ID | - **返回值** 添加失败的成员 ID。 ### removeLiveParticipantMuteWhiteList 从直播群禁言白名单移除指定成员。 - **类型** ```ts (params: { conversation: Conversation; participantIds: string[];}) => Promise<{ failedParticipantIds: string[]; }> ``` - **参数** - **params** 类型: { conversation: [Conversation](293539#conversation); participantIds: string[]; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 直播群 | | participantIds | `string[]` | 成员 ID | - **返回值** 移除失败的成员 ID。 ### getLiveConversationListOnline 获取直播群列表。 - **类型** ```ts (params: { cursor?: Long; policy?: number; limit?: number;}) => Promise<{ conversation: any; hasMore: any; cursor: any; }> ``` - **参数** - **params** 类型: { cursor?: Long | undefined; policy?: number | undefined; limit?: number | undefined; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | cursor | `Long | undefined` | 游标。 | | policy | `number | undefined` | 过滤条件 1: 所有的群 3: 自己是群主的群。默认返回所有群。 | | limit | `number | undefined` | 每页多少条，默认 20 条。 | - **返回值** 直播群列表信息。 ### getLiveParticipantsOnline 获取直播群在线成员列表。 - **类型** ```ts (params: { conversation: Conversation; limit?: number; cursor?: Long; markType?: string;}) => Promise<{ participants: any; hasMore: any; cursor: any; }> ``` - **注意** + 使用国内环境时，支持拉取最新加群的 10,000 个在线成员。 + 使用海外环境时，支持拉取最新加群的 3,000 个在线成员。 - **参数** - **params** 类型:

{ conversation: [Conversation](293539#conversation); limit?: number | undefined; cursor?: Long | undefined; markType?: string | undefined; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 直播群信息。 | | limit | `number | undefined` | 每页多少条，默认 20 条。 | | cursor | `Long | undefined` | 游标。 | | markType | `string | undefined` | 成员标记 | - **返回值** 在线成员列表信息。 ### getLiveParticipantCountOnline 获取直播群在线人数 - **类型** ```ts (params: { conversation: Conversation;}) => Promise<{ count: number; }> ``` - **参数** - **params** 类型: { conversation: [Conversation](293539#conversation); } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 直播群信息。 | - **返回值** 在线人数 ### getLiveParticipantInfoOnline 获取直播群指定成员状态信息（例如是否在线、最后活跃时间），v1.1.2 新增。 - **类型** ```ts (params: { conversation: Conversation; participantIds: string[];}) => Promise> ``` - **参数** - **params** 类型: { conversation: [Conversation](293539#conversation); participantIds: string[]; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 直播群 | | participantIds | `string[]` | 要查询的用户 ID | - **返回值** 类型: Promise\> 直播群指定成员状态信息。 ### getLiveParticipantDetailOnline 获取直播群指定成员资料（例如成员在群中的昵称、头像），v1.5.0 新增。 - **类型** ```ts ({ conversation, participantIds }: { conversation: Conversation; participantIds: string[];}) => Promise ``` - **参数** - **{conversation, participantIds}** 类型: { conversation: [Conversation](293539#conversation); participantIds: string[]; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 直播群 | | participantIds | `string[]` | 要查询的用户 ID | - **返回值** 类型: Promise<[Participant](293539#participant)[]\> 直播群指定成员资料。 ### getLiveGroupHistoryMessageListOnline 获取直播群历史消息 - **类型** ```ts (params: { conversation: Conversation; limit?: number; fromIndex?: Long; direction?: im_proto.MessageDirection;}) => Promise<{ messages: Message[]; hasMore: boolean; nextIndex: Long; }> ``` - **参数** - **params** 类型:

{ conversation: [Conversation](293539#conversation); limit?: number | undefined; fromIndex?: Long | undefined; direction?: im_proto.[MessageDirection](293539#messagedirection) | undefined; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 直播群信息。 | | limit | `number | undefined` | 每页多少条，默认 20 条。 | | fromIndex | `Long | undefined` | 查询起始下标，默认为 Long.MAX_VALUE（配合查询方向） | - **返回值** 对应区间消息列表（从新到旧）和下一页起始下标 ### updateLiveConversationMarks 更新直播群内的标记类型 - **类型** ```ts (params: { markAction?: im_proto.MarkAction; conversation: Conversation; markTypes: string[];}) => Promise<{}> ``` - **参数** - **params** 类型:

{ markAction?: im_proto.[MarkAction](293539#markaction) | undefined; conversation: [Conversation](293539#conversation); markTypes: string[]; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | markAction | `im_proto.MarkAction | undefined` | 标记操作（添加或删除） | | conversation | `Conversation` | 直播群 | | markTypes | `string[]` | 标记类型 | - **返回值** （无数据返回） ### getLiveConversationMarksOnline 获取直播群内的标记类型 - **类型** ```ts (params: { conversation: Conversation;}) => Promise<{ markTypes: string[] | null | undefined; }> ``` - **参数** - **params** 类型: { conversation: [Conversation](293539#conversation); } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | conversation | `Conversation` | 直播群 | - **返回值** 群里已有的标记类型 ### updateLiveParticipantsMarks 更新直播群内指定成员的标记，需要先在群中创建好对应标记类型 - **类型** ```ts (params: { markAction?: im_proto.MarkAction; conversation: Conversation; participantIds: string[]; markTypes: string[];}) => Promise<{ checkCode: Long; checkMsg: string; failedParticipant: string[]; rawResp: im_proto.IBatchUpdateConversationParticipantResponseBody | null | undefined; }> ``` - **参数** - **params** 类型:

{ markAction?: im_proto.[MarkAction](293539#markaction) | undefined; conversation: [Conversation](293539#conversation); participantIds: string[]; markTypes: string[]; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | markAction | `im_proto.MarkAction | undefined` | 标记操作（添加或删除） | | conversation | `Conversation` | 直播群 | | participantIds | `string[]` | 成员 ID | | markTypes | `string[]` | 标记类型 | - **返回值** 操作结果（例如失败的成员） ## ContactPlugin 类型: `class` 联系人插件，提供好友关系等能力；在 IM 实例化时传入后，IM 实例增加联系人相关的方法。v1.2.0 新增。注：使用用户资料能力需先通过服务端 API 注册对应的用户。 - **API** | 方法 | 描述 | | :-- | :-- | | [getFriendReceiveApplyListOnline](#contactplugin-getfriendreceiveapplylistonline) | 获取好友申请列表。 | | [getFriendListOnline](#contactplugin-getfriendlistonline) | 获取好友列表。 | | [applyFriend](#contactplugin-applyfriend) | 申请添加好友。 | | [deleteFriend](#contactplugin-deletefriend) | 删除好友。 | | [replyFriendApply](#contactplugin-replyfriendapply) | 回应好友申请。 | | [markFriendReceiveApplyAsRead](#contactplugin-markfriendreceiveapplyasread) | 标记好友申请已读。（用于同步申请未读数等场景） | | [addUserToBlack](#contactplugin-addusertoblack) | 将指定用户加入黑名单 | | [removeUserFromBlack](#contactplugin-removeuserfromblack) | 将指定用户从黑名单移除 | | [userIsInMyBlack](#contactplugin-userisinmyblack) | 检查用户是否在黑名单中 | | [updateBlackUserState](#contactplugin-updateblackuserstate) | 更新指定用户黑名单条目（例如更新 ext） | | [getBlacklistOnline](#contactplugin-getblacklistonline) | 获取用户黑名单 | | [updateFriend](#contactplugin-updatefriend) | 更新好友信息 | | [getUserProfilesOnline](#contactplugin-getuserprofilesonline) | 获取用户资料 | | [setUserProfile](#contactplugin-setuserprofile) | 设置用户资料 | ### getFriendReceiveApplyListOnline 获取好友申请列表。 - **类型** ```ts (params: { cursor?: Long; limit?: number; direction?: im_proto.DirectionForContactApi;}) => Promise<{ list: FriendApply[]; totalCount: number; cursor: Long | null | undefined; hasMore: boolean | null | undefined; unreadCount: number; }> ``` - **参数** - **params** 类型:

{ cursor?: Long | undefined; limit?: number | undefined; direction?: im_proto.[DirectionForContactApi](293539#directionforcontactapi) | undefined; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | cursor | `Long | undefined` | 分页游标，首页拉取可使用 0。 | | limit | `number | undefined` | 查询条数，默认 20 条。 | - **返回值** 好友申请列表与分页信息，其中好友申请列表参看 [FriendApply](293539#friendapply)。 ### getFriendListOnline 获取好友列表。 - **类型** ```ts (params: { cursor?: Long; limit?: number;}) => Promise<{ list: Friend[]; totalCount: number; cursor: Long | null | undefined; hasMore: boolean | null | undefined; }> ``` - **参数** - **params** 类型: { cursor?: Long | undefined; limit?: number | undefined; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | cursor | `Long | undefined` | 分页游标，首页拉取可使用 0。 | | limit | `number | undefined` | 查询条数，默认 20 条。 | - **返回值** 好友列表与分页信息，其中好友信息参看 [Friend](293539#friend)。 ### applyFriend 申请添加好友。 - **类型** ```ts ({ userId, ext }: { userId: string; ext?: { [key: string]: string; } | undefined; }) => Promise<{ status: number | null | undefined; checkCode: Long | null | undefined; checkMessage: string | null | undefined; index: Long | null | undefined; applyId: string | null | undefined; }> ``` - **参数** - **{ userId, ext }** 类型: { userId: string; ext?: { [key: string]: string; } | undefined; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | userId | `string` | 接收方用户 ID。 | | ext | `{ [key: string]: string; } | undefined` | 业务扩展字段。 | - **返回值** 申请添加好友结果。 ### deleteFriend 删除好友。 - **类型** ```ts ({ userIds }: { userIds: string[];}) => Promise<{ failedInfos: { failedReason: string; failedCode: im_proto.StatusCode; failedUserId: string; }[]; }> ``` - **参数** - **{userIds}** 类型: { userIds: string[]; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | userIds | `string[]` | 需要删除的用户 ID。 | - **返回值** 删除失败列表。 ### replyFriendApply 回应好友申请。 - **类型** ```ts (params: { userId: string; attitude: ReplyFriendAttitude; ext?: { [key: string]: string; } | undefined; }) => Promise<{ failedInfos: { failedReason: string; failedCode: im_proto.StatusCode; failedUserId: string; }[]; }> ``` - **参数** - **params** 类型:

{ userId: string; attitude: [ReplyFriendAttitude](293539#replyfriendattitude); ext?: { [key: string]: string; } | undefined; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | userId | `string` | 回复的申请用户 ID。 | | attitude | `ReplyFriendAttitude` | 好友申请回应状态。 | | ext | `{ [key: string]: string; } | undefined` | 业务扩展字段。 | - **返回值** 回复失败列表。 ### markFriendReceiveApplyAsRead 标记好友申请已读。（用于同步申请未读数等场景） - **类型** ```ts ({ readIndex }: { readIndex: Long;}) => Promise ``` - **参数** - **{readIndex}** 类型: { readIndex: Long; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | readIndex | `Long` | 已读取的申请下标。 | ### addUserToBlack 将指定用户加入黑名单 - **类型** ```ts ({ userIds, ext }: { userIds: string[]; ext?: { [key: string]: string; } | undefined; }) => Promise<{ failedInfos: { failedReason: string; failedCode: im_proto.StatusCode; failedUserId: string; }[]; }> ``` - **参数** - **{userIds, ext}** 类型: { userIds: string[]; ext?: { [key: string]: string; } | undefined; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | userIds | `string[]` | 用户 ID | | ext | `{ [key: string]: string; } | undefined` | 业务扩展字段。 | - **返回值** 请求失败的列表 ### removeUserFromBlack 将指定用户从黑名单移除 - **类型** ```ts ({ userIds, }: { userIds: string[];}) => Promise<{ failedInfos: { failedReason: string; failedCode: im_proto.StatusCode; failedUserId: string; }[]; }> ``` - **参数** - **{ userIds, }** 类型: { userIds: string[]; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | userIds | `string[]` | 用户 ID | - **返回值** 请求失败的列表 ### userIsInMyBlack 检查用户是否在黑名单中 - **类型** ```ts ({ userIds, }: { userIds: string[];}) => Promise<{ [k: string]: boolean; }> ``` - **参数** - **{ userIds, }** 类型: { userIds: string[]; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | userIds | `string[]` | 用户 ID | - **返回值** 字典对象，key 为用户 ID，value 为是否在黑名单中 ### updateBlackUserState 更新指定用户黑名单条目（例如更新 ext） - **类型** ```ts ({ userIds, ext }: { userIds: string[]; ext?: { [key: string]: string; } | undefined; }) => Promise<{ failedInfos: { failedReason: string; failedCode: im_proto.StatusCode; failedUserId: string; }[]; }> ``` - **参数** - **{userIds, ext}** 类型: { userIds: string[]; ext?: { [key: string]: string; } | undefined; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | userIds | `string[]` | 用户 ID | | ext | `{ [key: string]: string; } | undefined` | 业务扩展字段。 | - **返回值** 请求失败的列表 ### getBlacklistOnline 获取用户黑名单 - **类型** ```ts (params: { cursor?: Long; limit?: number; direction?: im_proto.DirectionForContactApi;}) => Promise<{ list: BlackUserInfo[]; totalCount: number; cursor: Long | null | undefined; hasMore: boolean | null | undefined; }> ``` - **参数** - **params** 类型:

{ cursor?: Long | undefined; limit?: number | undefined; direction?: im_proto.[DirectionForContactApi](293539#directionforcontactapi) | undefined; }

- **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | cursor | `Long | undefined` | 分页游标，首页拉取可使用 0。 | | limit | `number | undefined` | 查询条数，默认 20 条。 | - **返回值** 黑名单列表与分页信息 ### updateFriend 更新好友信息 - **类型** ```ts ({ userId, ext, alias }: { userId: string; ext?: { [key: string]: string; } | undefined; alias?: string | undefined; }) => Promise ``` - **参数** - **{userId, ext, alias}** 类型: { userId: string; ext?: { [key: string]: string; } | undefined; alias?: string | undefined; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | userId | `string` | 要修改的好友用户 ID | | ext | `{ [key: string]: string; } | undefined` | 好友信息扩展字段 | | alias | `string | undefined` | 好友备注 | - **返回值** （无数据返回） ### getUserProfilesOnline 获取用户资料 - **类型** ```ts ({ userIds }: { userIds: string[];}) => Promise<{ list: UserProfile[]; failedUids: string[]; }> ``` - **参数** - **{userIds}** 类型: { userIds: string[]; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | userIds | `string[]` | 用户 ID | ### setUserProfile 设置用户资料 - **类型** ```ts (profile: { nickname?: string | undefined; portrait?: string | undefined; ext?: { [k: string]: string; } | undefined; }) => Promise<{ profile: UserProfile | null; }> ``` - **参数** - **profile** 类型: { nickname?: string | undefined; portrait?: string | undefined; ext?: { [k: string]: string; } | undefined; } - **成员** | 名称 | 类型 | 描述 | | :-- | :-- | :-- | | nickname | `string | undefined` | 昵称 | | portrait | `string | undefined` | 头像 | | ext | `{ [k: string]: string; } | undefined` | 业务自定义扩展字段 | ## EventBus 类型: `class` - **API** | 方法 | 描述 | | :-- | :-- | | [subscribe](#eventbus-subscribe) | 创建一个事件订阅 | | [unsubscribe](#eventbus-unsubscribe) | 取消一个事件订阅 | ### subscribe 创建一个事件订阅 - **类型** ```ts (event: T, func: EventHandler) => Subscription ``` - **参数** - **event** 类型: T 事件类型，参看 [IMEvent](293537#imevent)。 - **func** 类型: [EventHandler](293539#eventhandler)<[IMEventTypeMap](293537#imeventtypemap)[T]\> 事件回调函数。 - **返回值** 类型: Subscription<[IMEventTypeMap](293537#imeventtypemap)[T]\> 回调函数 Index ### unsubscribe 取消一个事件订阅 - **类型** ```ts (event: IMEvent, handler: Subscription) => void ``` - **参数** - **event** 类型: [IMEvent](293537#imevent) 事件类型 - **handler** 类型: [Subscription](293539#subscription) 回调函数 Index

实时音视频