API 列表--实时音视频-火山引擎

文档中心

立即注册

实时音视频

请输入

服务端 OpenAPI

API 列表

OpenAPI 列表

OpenAPI 分为直播群接口、普通群聊接口和用户级别接口。普通群内只能调用普通群接口，若调用不支持接口，会返回 LiveConversationNotSupport 错误；直播群内只能调用直播群接口，若调用不支持接口，会返回 OnlyLiveConversationSupport 错误；单聊只能调用单聊接口，若调用普通群特有接口，会返回 SingleConversationNotSupport 错误，若调用直播群特有接口，会返回 OnlyLiveConversationSupport 错误。用户级别接口与群聊种类无关，为应用用户级别接口。

接口类别	接口
直播群接口	批量禁言/拉黑会话成员 BatchAddBlockParticipants 批量取消禁言/取消拉黑会话成员 BatchDeleteBlockParticipants 批量添加直播群管理员 BatchAddManager 批量移除直播群管理员 BatchRemoveManager 批量添加全员禁言下白名单成员 BatchAddWhitelistParticipant 批量移除全员禁言下白名单成员 BatchRemoveWhitelistParticipant 更新直播群成员资料 BatchUpdateLiveParticipants 分批获得禁言/拉黑成员列表 BatchGetBlockParticipants BatchGetBlockParticipants 批量查询全员禁言下白名单成员 BatchGetWhitelistParticipant 查询直播群成员状态 QueryLiveParticipantStatus 创建会话 CreateConversation 修改会话信息 ModifyConversation 解散群聊 DestroyConversation 标记会话 MarkConversation 批量查询会话 BatchGetConversations 会话标记查询 GetConversationMarks 分批扫描群聊中的成员详细信息 ScanConversationParticipantList 查询用户拥有会话 GetUserConversations 删除会话消息 DeleteConversationMessage 发送消息 SendMessage 批量查询消息 GetMessages 分批查询会话中的消息 GetConversationMessages 标记会话 MarkConversation 会话标记查询 GetConversationMarks
普通群聊接口	批量添加群聊成员 BatchAddConversationParticipant 批量删除群聊成员 BatchDeleteConversationParticipant 批量修改群聊成员详情 BatchModifyConversationParticipant 查询会话成员数量 GetConversationUserCount 批量查询会话成员详细信息 BatchGetConversationParticipant 判断用户是否在会话中 IsUserInConversation 修改用户对会话的设置 ModifyConversationSetting 解散群聊 DestroyConversation 查询成员对会话的设置 GetConversationSetting 删除用户消息 DeleteMessage 撤回用户消息 RecallMessage 修改消息扩展字段 ModifyMessage 批量查询消息 GetMessages 创建会话 CreateConversation 批量查询会话 BatchGetConversations 分批扫描群聊中的成员详细信息 ScanConversationParticipantList 查询用户拥有会话 GetUserConversations 删除会话消息 DeleteConversationMessage 发送消息 SendMessage 分批查询会话中的消息 GetConversationMessages 获取消息的已读回执详情 GetMessagesReadReceipt
单聊接口	查询会话成员数量 GetConversationUserCount 分批扫描群聊中的成员详细信息 ScanConversationParticipantList 批量查询会话成员详细信息 BatchGetConversationParticipant 判断用户是否在会话中 IsUserInConversation 创建会话 CreateConversation 修改会话信息 ModifyConversation 修改用户对会话的设置 ModifyConversationSetting 查询成员对会话的设置 GetConversationSetting 查询用户拥有会话 GetUserConversations 批量查询会话 BatchGetConversations 发送消息 SendMessage 删除用户消息 DeleteMessage 删除会话消息 DeleteConversationMessage 撤回用户消息 RecallMessage 修改消息扩展字段 ModifyMessage 批量查询消息 GetMessages 分批查询会话中的消息 GetConversationMessages 获取消息的已读回执详情 GetMessagesReadReceipt 批量发单聊消息 BatchSendMessage
用户级别接口	好友关系	添加好友 AddFriend
		删除好友 DeleteFriend
		查询好友列表 ListFriend
		校验好友关系 IsFriend
	黑名单管理	添加黑名单 AddBlackList
		移出黑名单 RemoveBlackList
		更新黑名单 UpdateBlackList
		查询黑名单 GetBlackList
		校验用户是否在黑名单 IsInBlackList
	全员广播	全员广播 UserBroadcast
	全员广播	更新用户标签 BatchUpdateUserTags
	用户注册	注册用户 RegisterUsers
	用户注册	注销用户 UnRegisterUsers
	用户资料	更新用户资料 BatchUpdateUser
	用户资料	查询注册用户 BatchGetUser

最近更新时间：2024.05.17 10:13:43

这个页面对您有帮助吗？

有用

无用