概述
资源:群组
方法列表
方法 (API) | 权限要求(满足任一) | 访问凭证(选择其一) | 商店 | 自建 | ||
---|---|---|---|---|---|---|
创建群POST /open-apis/im/v1/chats创建群并设置群头像、群名、群描述等。 | 获取与更新群组信息 | tenant_access_token | ✓ | ✓ | ||
获取群信息GET /open-apis/im/v1/chats/:chat_id获取群名称、群描述、群头像、群主 ID 等群基本信息。 | 获取与更新群组信息获取群组信息 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
更新群信息PUT /open-apis/im/v1/chats/:chat_id更新群头像、群名称、群描述、群配置、转让群主等。 | 获取与更新群组信息 | tenant_access_token | ✓ | ✓ | ||
解散群DELETE /open-apis/im/v1/chats/:chat_id解散群聊。 | 获取与更新群组信息 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
获取用户或机器人所在的群列表GET /open-apis/im/v1/chats用户获取用户或者机器人所在的群列表。 | 获取群组信息获取与更新群组信息 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
搜索对用户或机器人可见的群列表GET /open-apis/im/v1/chats/search用于搜索对用户、机器人可见的群列表 | 获取与更新群组信息获取群组信息 | tenant_access_tokenuser _access_token | ✓ | ✓ |
事件列表
事件 (Event) | 触发时机 | 权限要求(满足任一) | 事件类型 | 商店 | 自建 | |
---|---|---|---|---|---|---|
群解散 | 群组被解散后触发此事件。 | 获取与更新群组信息获取群组信息 | im.chat.disbanded_v1 | ✓ | ✓ | |
群配置修改 | 群组配置被修改后触发此事件,包含:群主转移、群基本信息修改、群权限修改 | 获取群组信息获取与更新群组信息 | im.chat.updated_v1 | ✓ | ✓ |
资源:群组 - 群成员
方法列表
方法 (API) | 权限要求(满足任一) | 访问凭证(选择其一) | 商店 | 自建 | ||
---|---|---|---|---|---|---|
将用户或机器人拉入群聊POST open-apis/im/v1/chats/:chat_id/members将用户或机器人 拉入群聊。 | 获取与更新群组信息 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
将用户或机器人移出群聊DELETE /open-apis/im/v1/chats/:chat_id/members将用户或机器人移出群聊。 | 获取与更新群组信息 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
用户或机器人主动加入群聊PATCH /open-apis/im/v1/chats/:chat_id/members/me_join用户或者机器人可以通过接口入群。 | 获取与更新群组信息 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
获取群成员列表GET /open-apis/im/v1/chats/:chat_id/members获取群里成员列表。 | 获取群组信息获取与更新群组信息 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
判断用户或机器人是否在群里GET /open-apis/im/v1/chats/:chat_id/members/is_in_chat判断用户或机器人是否在群里。 | 获取与更新群组信息获取群组信息 | tenant_access_tokenusert_access_token | ✓ | ✓ |
事件列表
事件 (Event) | 触发时机 | 权限要求(满足任一) | 事件类型 | 商店 | 自建 | |
---|---|---|---|---|---|---|
机器人进群 | 机器人被添加至群聊时触发此事件。 | 获取群组信息获取与更新群组信息 | im.chat.member.bot.added_v1 | ✓ | ✓ | |
机器人被移出群 | 机器人被移出群聊后触发此事件。 | 获取群组信息获取与更新群组信息 | im.chat.member.bot.deleted_v1 | ✓ | ✓ | |
用户进群 | 新用户进群触发此事件。 | 获取群组信息获取与更新群组信息 | im.chat.member.user.added_v1 | ✓ | ✓ | |
撤销拉用户进群 | 撤销拉用户进群后触发此事件。 | 获取群组信息获取与更新群组信息 | im.chat.member.user.withdrawn_v1 | ✓ | ✓ |
资源:群组 - 群公告
方法列表
方法 (API) | 权限要求(满足任一) | 访问凭证(选择其一) | 商店 | 自建 | ||
---|---|---|---|---|---|---|
获取群公告信息GET /open-apis/im/v1/chats/:chat_id/announcement获取会话中的群公告信息,公告信息格式与云文档格式相同。 | 获取与上传图片或文件资源 | tenant_access_tokenuser_access_token | ✓ | ✓ | ||
更新群公告信息PATCH /open-apis/im/v1/chats/:chat_id/announcement更新会话中的群公告信息,更新公告信息的格式和更新云文档格式相同。 | 获取与更新群组信息 | tenant_access_tokenuser_access_token | ✓ | ✓ |
修改于 2023-01-13 01:59:34