Skip to content

批量删除群成员

适用版本>=v7.0.2505a.20250515

接口说明:批量删除群成员"

使用说明

  • 应用需在群内
  • 可移除用户或应用出群。特别地,当appid为本应用时,即等同于 应用主动退群

请求说明

请求地址配置域名+/openapi+v7/chats/{chat_id}/members/batch_delete
请求方法POST
签名方式KSO-1(配置域名+/openapi不参与签名)
权限要求查询和管理会话(应用授权)kso.chat.readwrite

请求头(Header)

Header参数类型是否必填说明
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}
X-Kso-Id-TypestringID 类型,可选值为 internalexternal,不传默认为internal。当值为 external 时,开启三方 ID 模式,此时接口请求和响应中的 user_id 和 dept_id 应为三方ID,即 ex_user_id 和 ex_dept_id

路径参数(Path)

名称类型是否必填说明
chat_idstring会话id

请求体(Body)

名称类型是否必填说明
account_id_listobject[]加入会话的机器人或用户列表
app_idstring应用id,type为sp时传入
company_idstring公司id
typestringsp:机器人,user:用户
idstringtype为user传入用户id,type为sp传入spid
ignore_invalid_userbool是否自动过滤非法用户id和app_id,默认为“否”,即不过滤。当不过滤的情况下,有任一非法id,则本次调用将失败

请求体示例

json
{
  "account_id_list": [
    {
      "app_id": "string",
      "company_id": "string",
      "type": "user",
      "id": "string"
    }
  ],
  "ignore_invalid_user": false
}

响应体(Response)

名称类型说明
codeintegercode
msgstringmsg
dataobjectdata
failed_account_id_listobject[]失败的成员信息
account_id_listobject机器人或用户列表
app_idstring应用id
company_Idstring公司id
typestringsp:机器人,user:用户
idstringtype为user代表用户id,type为sp代表spid
descriptionstring失败的原因

响应体示例

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "failed_account_id_list  ": [
      {
        "account_id_list": [
          {
            "app_id": "string",
            "CompanyId": "string",
            "type": "user",
            "id": "string"
          }
        ],
        "description": "失败的原因"
      }
    ]
  }
}