踢人出群 - 即时通信

请求参数

Query 参数

operator_id

string

必需

操作者（群主或和管理员）账号 ID。

示例值:

accid1

team_id

number

必需

群组 ID，创建群组成功时，云信服务器会自动生成并返回。

示例值:

18573968767

team_type

integer

必需

群组类型。1：高级群；2：超大群。

示例值:

1

kick_account_ids

string

必需

踢出群的成员列表。
一次最多可以踢 10 个群成员。

示例值:

accid2

extension

string

可选

自定义扩展字段，即自定义的通知字段，JSON 格式，不会持久化。长度上限 512 位字符。
该字段仅针对高级群，对超大群无效。

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request DELETE 'https://open.yunxinapi.com/im/v2/team_members/actions/kick_member?operator_id=accid1&team_id=18573968767&team_type=1&kick_account_ids=accid2&extension	=' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;'

返回响应

🟢200成功

application/json

Body

code

integer

状态码

必需

200 表示请求成功。

msg

string

提示信息

必需

请求失败时返回错误信息，请求成功时返回 "success"。

data

object

返回数据

必需

返回的 JSON 数据对象，请求失败则返回空对象。

success_list

array[string]

踢除成功的用户账号 ID 列表。

可选

failed_list

array [object {3}]

踢除失败的用户信息列表。

必需

示例

{
  "code": 200,
  "msg": "success",
  "data": {
    "success_list": [
      "account_id1",
      "account_id2"
    ],
    "failed_list": [
      {
        "account_id": "account_id1",
        "error_code": 102404,
        "error_msg": "%s not valid"
      }
    ]
  }
}

🟢200成功

🟢200请求参数错误

🟢200服务器错误