本文为您介绍直播互动AIMPaaS的所有API列表，建议您使用服务端SDK来调用API。
用户登录
| API | 描述 |
|---|---|
| GetLoginToken | 调用GetLoginToken获取登录AIMPaaS的token，客户端使用该token可以与AIMPaaS建立聊天通道。 |
| KickOff | 调用KickOff从AIMPaaS移除指定用户的登录态，并发一条通知给这些登录的设备，可指定将某个端踢下线。 |
消息
| API | 描述 |
|---|---|
| SendMessage | 调用SendMessage发送一条单聊或者群聊消息。 |
| RecallMessage | 调用RecallMessage撤回一条消息。 |
| GetMessageById | 调用GetMessageById，指定消息ID获取整个消息对象。 |
| SetMessageExtensionByKeys | 调用SetMessageExtensionByKeys，设置消息扩展信息。 |
| RemoveMessageExtensionByKeys | 调用RemoveMessageExtensionByKeys，删除消息扩展信息Extension指定的key。 |
群聊
| API | 描述 |
|---|---|
| CreateGroup | 调用CreateGroup创建群聊会话，若会话已存在，返回会话创建成功。 |
| DismissGroup | 调用DismissGroup解散群聊。 |
| UpdateGroupTitle | 调用UpdateGroupTitle更新群名称。更新成功后，会同步至群所有成员。 |
| UpdateGroupIcon | 调用UpdateGroupIcon更新群头像。 |
| SetGroupExtensionByKeys | 调用SetGroupExtensionByKeys设置群聊扩展信息。该信息会同步给群的所有人，仅覆盖Extensions参数里的Key对应的Value。 |
| RemoveGroupExtensionByKeys | 调用RemoveGroupExtensionByKeys删除群聊会话Extension指定的key。 |
| AddGroupMembers | 调用AddGroupMembers将指定用户列表加入到群里。 |
| RemoveGroupMembers | 调用RemoveGroupMembers将指定的群成员从群聊中移除。 |
| UpdateGroupMembersRole | 调用UpdateGroupMembersRole更新群成员角色。 |
群禁言
| API | 描述 |
|---|---|
| SilenceAllGroupMembers | 调用SilenceAllGroupMembers，将群聊全员禁言。 |
| CancelSilenceAllGroupMembers | 调用CancelSilenceAllGroupMembers取消全员禁言。 |
| AddGroupSilenceWhitelist | 调用AddGroupSilenceWhitelist添加群禁言白名单。 |
| RemoveGroupSilenceWhitelist | 调用RemoveGroupSilenceWhitelist删除群禁言白名单列表。 |
| AddGroupSilenceBlacklist | 调用AddGroupSilenceBlacklist添加群禁言黑名单。 |
| RemoveGroupSilenceBlacklist | 调用RemoveGroupSilenceBlacklist删除群禁言用户。删除后该用户即解除群禁言。 |
| ListGroupSilenceMembers | 调用ListGroupSilenceMembers获取群禁言成员黑名单和白名单列表。 |
单聊
| API | 描述 |
|---|---|
| SetSingleChatExtensionByKeys | 调用SetSingleChatExtensionByKeys设置单聊扩展信息。 |
| RemoveSingleChatExtensionByKeys | 调用RemoveSingleChatExtensionByKeys删除单聊扩展信息。 |
会话视图
| API | 描述 |
|---|---|
| SetUserConversationExtensionByKeys | 调用SetUserConversationExtensionByKeys设置会话视图扩展信息。 |
| RemoveUserConversationExtensionByKeys | 调用RemoveUserConversationExtensionByKeys删除会话视图扩展信息。 |
多媒体
| API | 描述 |
|---|---|
| GetMediaUploadUrl | 调用GetMediaUploadUrl获取多媒体文件上传的URL。 |
| GetMediaUrl | 调用GetMediaUrl将AIMPaaS平台多媒体文件的MediaId转为外网可访问的URL链接。 |
数据导入
| API | 描述 |
|---|---|
| ImportGroupChatConversation | 调用ImportGroupChatConversation导入群信息。 |
| ImportGroupChatMember | 调用ImportGroupChatMember导入群成员。 |
| ImportMessage | 调用ImportMessage导入聊天消息。 |
| ImportSingleConversation | 调用ImportSingleConversation导入单聊会话。 |