移除群聊成员/机器人
用于将用户或应用机器人移除群聊,需满足两个前提条件:
- 应用机器人需在群聊内
- 应用机器人需为该群的创建者
需注意的是:群主不可以被移除
请求说明
| 请求地址 | 配置域名+ /o/woa/api/v1/developer/app/chats/{chatid}/members |
|---|---|
| 请求方法 | DELETE |
| 签名方式 | wps-4 |
| 支持应用类型 | 企业自建应用、第三方企业应用 |
| 权限要求 | 管理会话及会话成员信息(kso.im.chat.manage) |
请求头
| Header 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 目前固定为:"application/json" |
| Wps-Docs-Date | 是 | 取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考签名说明 |
| Authorization | 是 | 授权token,格式:Bearer ${access_token},${access_token}需替换为从授权接口获取的access_token值 |
路径参数(Path)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| chatid | integer | 是 | 群聊会话 id |
请求地址示例
http
[DELETE] 配置域名+ /o/woa/api/v1/developer/app/chats/{chatid}/members请求体(Body)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| mids | []integer | 否 | 需要移除的成员的 id,上限 100 人(mids 和 app_ids 至少必传一个) |
| app_ids | []string | 否 | 需要移除的应用机器人的 app_id,上限 10 个(mids 和 app_ids 至少必传一个) |
请求体示例
json
{
"mids": [123, 456],
"app_ids": ["string", "string"]
}响应体
| 名称 | 类型 | 说明 |
|---|---|---|
| result | integer | 状态码,非 0 表示失败,参照《状态码说明》 |
| fail_user_ids | []integer | 移除失败的用户 id |
| fail_app_ids | []string | 移除失败的应用机器人 |
响应体示例
json
{
"fail_user_ids": [123, 456],
"fail_app_ids": ["string", "string"],
"result": 0
}