客户端 SDK--实时音视频-火山引擎

文档中心

立即注册

导航

客户端 SDK

最近更新时间：2024.10.08 18:46:22首次发布时间：2023.04.24 11:11:45

说明

即时通讯 IM 目前支持免费试用，你可以前往控制台创建免费试用版 AppId 体验 IM 功能。详情参看创建 IM 免费试用应用。
为更好提供问题排查服务，微信小程序端从 1.2 版本升级时，需补充 https://apmplus.volces.com;https://gator.volces.com; 到小程序白名单，具体参见微信小程序集成说明。

1.18

2024-10-08

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	1.18.0	1.18.0	/	/
UIKit 版本	1.18.0	1.18.0	/	/

版本更新如下：

SDK 返回消息发送失败的错误原因。
功能 Android iOS
SDK 返回消息发送失败的错误原因
getCheckCode
getCheckMessage
getLocalExtra
checkCode
checkMessage
localExt
Android 撤回消息回调优化：1.18 及以上版本，消息撤回后，消息发送端和接收端均收到 onRecallMessage 回调；历史版本，消息撤回后，消息发送端收到 onRecallMessage 回调，消息接收端收到 onUpdateMessage 回调。

功能	Android	iOS
SDK 返回消息发送失败的错误原因	getCheckCode getCheckMessage getLocalExtra	checkCode checkMessage localExt

1.17

2024-08-26

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	1.17.0	1.17.0	1.17.0	1.17.0
UIKit 版本	1.17.0	1.17.0	/	/

版本更新如下：

Android、iOS、web 端 SDK 更新了配置组件。其中 Android、iOS 端升级到此版本时，请参见以下集成指南调整相关配置：
平台集成 SDK 指南
Android
不含 UI 集成方案
含 UI 集成方案
iOS
不含 UI 集成方案
含 UI 集成方案
服务端稳定性能优化。
修复已知问题。

平台	集成 SDK 指南
Android	不含 UI 集成方案含 UI 集成方案
iOS	不含 UI 集成方案含 UI 集成方案

1.16

2024-07-24

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	1.16.0	1.16.1	1.16.0	1.16.0
UIKit 版本	1.16.0	1.16.1	/	/

版本更新如下：

支持获取用户当前会话内的未读消息。
功能 Android iOS
获取用户当前会话内的未读消息 getConversationUnreadMessageList getConversationUnReadMessageList:option:completion:
支持按消息清除会话未读数。
功能 Android iOS
按消息清除会话未读数 markConversationRead markConversationRead:beforeMessage:completion:
支持取消文件上传。
功能 Android iOS Web 微信小程序
取消文件上传 cancelMediaFileMessageUpload cancelMediaFileMessageUpload: completion: cancelMediaFileMessagUpload cancelMediaFileMessagUpload

功能	Android	iOS
获取用户当前会话内的未读消息	getConversationUnreadMessageList	getConversationUnReadMessageList:option:completion:

功能	Android	iOS
按消息清除会话未读数	markConversationRead	markConversationRead:beforeMessage:completion:

功能	Android	iOS	Web	微信小程序
取消文件上传	cancelMediaFileMessageUpload	cancelMediaFileMessageUpload: completion:	cancelMediaFileMessagUpload	cancelMediaFileMessagUpload

1.15

2024-06-27

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	1.15.0	1.15.0	1.15.0	1.15.0
UIKit 版本	1.15.0	1.15.0	/	/

版本更新如下：

支持下载消息体附件。
功能 Android iOS
下载消息体附件 downloadFile downloadFile:remoteURL:progressBlock:completion:
修复已知问题。

功能	Android	iOS
下载消息体附件	downloadFile	downloadFile:remoteURL:progressBlock:completion:

1.14

2024-06-06

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	1.14.0	1.14.0	1.14.0	1.14.0
UIKit 版本	1.14.0	1.14.0	/	/

版本更新如下：

支持按消息类型获取本地消息。

功能	Android	iOS
按消息类型拉取本地消息	getLocalMessageListByType	getLocalMessageListByType:option:completion:
按消息类型查找本地消息	searchLocalMessageWithMsgType	searchLocalMessage:key:option:completion:

修复已知问题。

1.13

2024-5-20

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	1.13.3	/	/	/

该版本修复了一些已知问题。

2024-5-14

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	1.13.0	1.13.0	1.13.0	1.13.0
UIKit 版本	1.13.0	1.13.0	/	/

版本更新如下：

支持发送自定义透传 (P2P) 消息，可实现仅透传、不落库的事件状态通知能力，例如在单聊会话中显示“正在输入”等场景。

功能	Android	iOS	Web	微信小程序
发送自定义透传 (P2P) 消息	sendP2PMessage sendP2PMessage	sendP2PMessage:conversationId:completion: sendP2PMessage:conversationId:userIdList:completion:	sendP2PMessage	sendP2PMessage
接收自定义透传 (P2P) 消息回调	onReceiveP2PMessage	onReceiveP2PMessage:	IMEvent.ReceiveNewP2PMessage	IMEvent.ReceiveNewP2PMessage

新增群聊的已读回执功能。

功能	Android	iOS	Web	微信小程序
获取群聊已读回执	getMessagesReadReceipt	getMessagesReadReceipt:completion:	getMessagesReadReceiptOnline	getMessagesReadReceiptOnline
发送群聊已读回执	sendMessageReadReceipts	sendMessageReadReceipts:completion:	sendMessageReadReceipts	sendMessageReadReceipts
消息已读回执回调	onReceiveReadReceipt	onReceiveReadReceipt:	IMEvent.MessageRead	IMEvent.MessageRead

客户端支持根据 conversationShortId 从服务端获取会话。

功能	Android	iOS	Web	微信小程序
根据 conversationShortId 从服务端获取会话	getConversationByShortID getConversationByShortIDList	getConversationByShortID:isServer:completion: getConversationByShortIDList:isServer:completion:	getConversationOnline	getConversationOnline

修复了一些已知问题。

1.12

2024-3-28

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	1.12.0	1.12.0	1.12.0	1.12.0
UIKit 版本	1.12.0	1.12.0	/	/

版本更新如下：

支持设置会话的额外信息。

功能	Android	iOS	Web	微信小程序
设置会话本地额外信息	setConversationLocalExt	setConversationLocalExt:value:completion:	/	/
设置会话公共额外信息	setConversationCoreExt	setConversationCoreExt:value:completion:	upsertConversationCoreExtInfo	upsertConversationCoreExtInfo
设置会话私有额外信息	setConversationMyExt	setConversationMyExt:value:completion:	upsertConversationSettingExtInfo	upsertConversationSettingExtInfo

Web/小程序 SDK 新增 im_proto.DirectionForContactApi 用于现有 ContactPlugin API，以区别原来使用的 im_proto.MessageDirection 。

1.11

2024-3-15

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	1.11.2	/	1.11.1	1.11.1

该版本修复了一些已知问题。

2024-3-13

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	/	1.11.1	/	/

该版本修复了一些已知问题。

2024-3-11

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	1.11.0	1.11.0	1.11.0	1.11.0
UIKit 版本	1.11.0	1.11.0	/	/

版本更新如下：

新增单聊的已读回执功能。

功能	Android	iOS	Web	微信小程序
获取单聊已读回执	getMessagesReadReceipt	getMessagesReadReceipt:completion:	getMessagesReadReceiptOnline	getMessagesReadReceiptOnline
发送单聊已读回执	sendMessageReadReceipts	sendMessageReadReceipts:completion:	sendMessageReadReceipts	sendMessageReadReceipts
标记会话已读	markConversationMessagesRead	markConversationMessagesRead:completion:	markConversationMessagesRead	markConversationMessagesRead
消息已读回执回调	onReceiveMessagesReadReceipt	onReceiveMessagesReadReceipt:	IMEvent.MessageRead	IMEvent.MessageRead
会话已读回执回调	onConversationRead	onConversationRead:fromUid:	IMEvent.ConversationMessageRead	IMEvent.ConversationMessageRead

Web & 小程序 SDK IMOption 新增 autoRefreshExpiredToken 参数，允许在 token 过期时自动调用 token 获取函数以更新 token 。

1.10

2024-2-28

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	1.10.0	1.10.0	1.10.0	1.10.0
UIKit 版本	1.10.0	1.10.0	/	/

版本更新如下：

新增根据消息 ID 查询消息详情功能。

功能	Android	iOS	Web	微信小程序
根据消息 ID 查询消息详情	getMessage getMessageByServerID	getMessage:inConversationId:completion: getMessageByServerID:inConversationShortID:isServer:completion:	getMessageByServerId	getMessageByServerId

新增修改消息 ext 和 content 字段功能。
功能 Android iOS Web 微信小程序
修改消息 ext 和 content 字段 modifyMessage modifyMessage:completion: modifyMessage modifyMessage

功能	Android	iOS	Web	微信小程序
修改消息 ext 和 content 字段	modifyMessage	modifyMessage:completion:	modifyMessage	modifyMessage

1.9

2024-1-18

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	1.9.0	1.9.0	1.9.0	1.9.0
UIKit 版本	1.9.0	1.9.0	/	/

该版本新增了对海外服务的支持，请参看以下接入指南。
说明
海外版本暂不支持收发语音消息和视频消息，调用发送会返回上传失败错误。
微信小程序暂不支持使用海外环境。
平台集成 SDK 指南
Android
不含 UI 集成方案
含 UI 集成方案
iOS
不含 UI 集成方案
含 UI 集成方案
Web
不含 UI 集成方案
含 UI 集成方案
我们更新了即时通讯 IM（SDK）隐私政策和即时通讯 IM（SDK）开发者使用合规规范，请知悉。

平台	集成 SDK 指南
Android	不含 UI 集成方案含 UI 集成方案
iOS	不含 UI 集成方案含 UI 集成方案
Web	不含 UI 集成方案含 UI 集成方案

1.8

2024-1-4

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	1.8.0	1.8.0	1.8.0	1.8.0
UIKit 版本	1.8.0	1.8.0	/	/

版本更新如下：

新增修改消息属性功能，可用于实现消息点赞、加急等。
功能 Android iOS Web 微信小程序
修改消息属性 modifyMessageProperty modifyMessageProperty:propertyItems:completion: modifyMessageProperty modifyMessageProperty
修复了一些已知问题。

功能	Android	iOS	Web	微信小程序
修改消息属性	modifyMessageProperty	modifyMessageProperty:propertyItems:completion:	modifyMessageProperty	modifyMessageProperty

1.7

2023-12-28

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	1.7.1	1.7.0	1.7.0	1.7.0
UIKit 版本	1.7.1	1.7.0	/	/

版本更新如下：

新增用户资料管理功能。

功能	Android	iOS	Web	微信小程序
获取用户全量信息	getUserFullInfo getUserFullInfo getUserFullInfoList getUserFullInfoList	getUserFullInfo:completion: getUserFullInfo:syncServer:completion: getUserFullInfoList:completion: getUserFullInfoList:syncServer:completion:	getUserProfilesOnline	getUserProfilesOnline
更新用户头像信息	setUserSelfPortrait	setUserSelfPortrait:completion:	setUserProfile	setUserProfile
更新用户昵称	setUserSelfNickName	setUserSelfNickName:completion:
更新用户额外信息	setUserSelfExt	setUserSelfExt:completion:
更新用户信息详情	updateUserSelfProfile	updateUserSelfProfile:completion:
用户信息更新回调	onUserProfileUpdate	onUserProfileUpdate:	IMEvent.ProfileUpdate	IMEvent.ProfileUpdate

直播群新增标记成员功能。

功能	Android	iOS	Web	微信小程序
标记群成员	markLiveGroupMemberList	markLiveGroupMemberList:uidList:action:markTypeList:completion:	updateLiveParticipantsMarks	updateLiveParticipantsMarks
获取群聊标记类型列表	getLiveGroupMarkTypeList	getLiveGroupMarkTypeList:completion:	getLiveConversationMarksOnline	getLiveConversationMarksOnline
根据标记获取直播群在线用户列表	getLiveGroupMemberOnlineList	getLiveGroupMemberOnlineList:cursor:count:markType:completion:	getLiveParticipantsOnline	getLiveParticipantsOnline
管理群成员标记类型	manageLiveGroupMarkTypes	manageLiveGroupMarkTypes:action:markTypeList:completion:	updateLiveConversationMarks	updateLiveConversationMarks
成员加入群聊回调	onMemberJoined	onMemberJoined:memberList:	IMEvent.ParticipantJoin	IMEvent.ParticipantJoin
成员退出群聊回调	onMemberLeave	onMemberLeave:memberList:	IMEvent.ParticipantLeave	IMEvent.ParticipantLeave
批量成员信息变更回调	onBatchMemberInfoChanged	onBatchMemberInfoChanged:members:	IMEvent.ParticipantUpsert	IMEvent.ParticipantUpsert
新增直播群标记事件监听	addLiveGroupMarkTypeListener	addLiveGroupMarkTypeListener:	instance.event.subscribe(IMEvent.LiveGroupMarkTypeUpdate)	instance.event.subscribe(IMEvent.LiveGroupMarkTypeUpdate
移除直播群标记事件监听	removeLiveGroupMarkTypeListener	removeLiveGroupMarkTypeListener:	instance.event.subscribe(IMEvent.LiveGroupMarkTypeUpdate)	instance.event.subscribe(IMEvent.LiveGroupMarkTypeUpdate
直播群新增标记类型回调	onMarkTypesAdd	onMarkTypesAdded:changeInfo:	IMEvent.LiveGroupMarkTypeUpdate	IMEvent.LiveGroupMarkTypeUpdate
直播群删除标记类型回调	onMarkTypesDeleted	onMarkTypesDeleted:changeInfo:	IMEvent.LiveGroupMarkTypeUpdate	IMEvent.LiveGroupMarkTypeUpdate

支持获取好友会话列表。

说明

Web SDK 和微信小程序 SDK 没有获取好友会话列表的接口，你可以通过获取全量会话列表后判断好友关系实现相同功能。

功能	Android	iOS	Web	微信小程序
添加好友会话监听	addFriendConversationListener	addFriendConversationListener:	IMEvent.FriendAdd	IMEvent.FriendAdd
移除好友会话监听	removeFriendConversationListener	removeFriendConversationListener:	IMEvent.FriendDelete	IMEvent.FriendDelete
获取好友会话列表	getFriendConversationList	getFriendConversationList:count:completion:	/	/
获取所有好友会话的未读消息总数	getFriendConversationListTotalUnreadCount	getFriendConversationListTotalUnreadCount:	/	/

1.6

2023-12-27

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	/	/	1.6.2	1.6.2

该版本优化了普通群收消息的稳定性。

2023-12-11

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	/	/	1.6.1	1.6.1

该版本修复了一些已知问题。

2023-11-27

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	1.6.0	1.6.0	1.6.0	1.6.0
UIKit 版本	1.6.0	1.6.0	/	/

版本更新如下：

直播群支持的消息类型新增图片、语音、视频、文件。
直播群支持刷新媒体信息，在媒体 URL 过期时调用该方法。
功能 Android iOS
刷新直播群媒体消息 refreshLiveGroupMediaMessage refreshLiveGroupMediaMessage:completion:

功能	Android	iOS
刷新直播群媒体消息	refreshLiveGroupMediaMessage	refreshLiveGroupMediaMessage:completion:

1.5

2023-10-30

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	1.5.0	1.5.0	1.5.0	1.5.0
UIKit 版本	1.5.0	1.5.0	/	/

版本更新如下：

直播群新增成员信息功能。用户在不同直播群可以拥有不同的成员信息，退群后信息自动销毁。

功能	Android	iOS	Web	微信小程序
加入直播群并设置当前用户成员信息	joinLiveGroup	joinLiveGroup:memberInfo:completion:	joinLiveGroup	joinLiveGroup
设置直播群成员信息	setLiveGroupMemberInfo	setLiveGroupMemberInfo:memberInfo:completion:	updateParticipant	updateParticipant
设置直播群成员昵称	setLiveGroupMemberAlias	setLiveGroupMemberAlias:alias:completion:
设置直播群成员头像	setLiveGroupMemberAvatar	setLiveGroupMemberAvatar:avatarUrl:completion:
设置直播群成员自定义信息	addLiveGroupMemberExt	addLiveGroupMemberExt:ext:completion:
获取直播群成员信息	getLiveGroupMemberInfo	getLiveGroupMemberInfo:uid:completion:	getLiveParticipantDetailOnline	getLiveParticipantDetailOnline
成员信息变更回调	onMemberInfoChanged	onMemberInfoChanged:member:	IMEvent.ParticipantUpsert	IMEvent.ParticipantUpsert

新增好友备注功能。

功能	Android	iOS	Web	微信小程序
修改好友备注名	updateFriendAlias	updateFriend:alias:completion:	updateFriend	updateFriend
好友信息变更回调	onFriendUpdate	onFriendUpdate:	IMEvent.FriendUpdate	IMEvent.FriendUpdate

1.4

2023-09-25

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	1.4.0	1.4.0	1.4.0	1.4.0
UIKit 版本	1.4.0	1.4.0	/	/

版本更新如下：

新增黑名单功能。

功能	Android	iOS	Web	微信小程序
添加用户到黑名单	addToBlackList	addToBlackList:completion:	addUserToBlack	addUserToBlack
将用户从黑名单中移除	deleteFromBlackList	deleteFromBlackList:completion:	removeUserFromBlack	removeUserFromBlack
校验用户是否在黑名单中	checkUserInBlackList	checkUserInBlackList:completion:	userIsInMyBlack	userIsInMyBlack
获取黑名单信息（全量）	getBlackList	getBlackListCompletion:	/	/
分页获取黑名单信息，按照拉黑时间从新到旧	getBlackList	getBlackList:limit:completion:	getBlacklistOnline	getBlacklistOnline

修复了一些已知问题。

1.3

2023-09-13

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	1.3.2	1.3.0	1.3.0	1.3.0
UIKit 版本	1.3.2	1.3.0	/	/

版本更新如下：

移动端提供会话内消息搜索能力，并优化消息获取能力。

功能	Android	iOS
搜索本地消息	searchLocalMessage	searchLocalMessage:key:completion:
获取历史消息（锚点之后的消息），返回消息顺序从旧到新	getNewerMessageList	getNewerMessageList:option:completion:

日志默认打印到日志文件，方便问题排查与定位。我们更新了即时通讯 IM（SDK）隐私政策和即时通讯 IM（SDK）开发者使用合规规范，请知悉。

1.2

2023-08-25

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	1.2.1	1.2.1	1.2.0	1.2.0
UIKit 版本	1.2.1	1.2.0	1.2.0	/

版本更新如下：

新增好友关系管理功能。你可以通过好友关系功能模块实现用户之间的联系关系建立，无需自行建设好友业务逻辑。参看好友关系高级功能文档了解如何使用 IM SDK 实现好友关系管理功能。

支持获取直播群历史消息。

功能	Android	iOS	Web	微信小程序
获取直播群历史消息	getLiveGroupHistoryMessageList	getLiveGroupHistoryMessageList:cursor:limit:completion:	getLiveGroupHistoryMessageListOnline	getLiveGroupHistoryMessageListOnline

优化了 UIKit 中的表情资源。
修复了一些已知问题。

1.1

2023-07-05

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	1.1.6	1.1.5	/	/

该版本修复了一些已知问题。

2023-06-21

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	1.1.5	1.1.4	1.1.2	1.1.2

直播群功能有以下升级，详情参看直播群高级功能文档。

最大成员上限由 10000 人扩充至无上限。默认最大值为 10000 人，如需提高上限，请联系技术支持。
支持直播群成员在线状态和人数查询。
支持设置消息优先级。
支持设置直播群管理员、全员禁言状态下可发言的成员。

该版本新增服务端接口参看服务端发版说明。

2023-05-25

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	1.1.1	1.1.0	1.1.0	1.1.0

版本新增了直播群功能。直播群是一种功能强大的群聊工具。相比于普通群聊，其最大成员上限可达 10,000 人。直播群成员之间没有固定的强关系，成员可以随时加入或离开。此外，直播群供了更加丰富的功能和工具，帮助用户更好地管理和互动。参看直播群高级功能文档了解如何使用 IM SDK 实现直播群功能。

该版本新增服务端接口参看服务端发版说明。

1.0

2023-04-24

该版本为即时通讯 IM 的首个正式版本。

本次发版对应的版本信息如下：

	Android	iOS	Web	微信小程序
SDK 版本	1.0.1	1.0.0	1.0.0	1.0.0