拉人入群 - 即时通信

请求参数

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

Body 参数application/json

operator_id

string

操作者（邀请人）账号 ID

必需

请根据群组的 invite_mode 属性传入：若 invite_mode = 0，即只有群主和管理员可以邀请，那么该字段必须传入群主或管理员的云信账号 ID。若 invite_mode = 1，即所有成员都可以邀请，那么该字段传入任意群成员的云信账号 ID。

team_id

number

群组 ID

必需

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

team_type

integer

群组类型

必需

1：高级群；2：超大群。

invite_account_ids

array[string]

邀请入群的成员列表

必需

一次最多可以邀请 200 个用户。

msg

string

邀请入群的附言

必需

长度上限 150 位字符。

extension

string

自定义扩展字段

可选

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

示例

{
  "operator_id": "accid1",
  "team_id": 18573968767,
  "team_type": 1,
  "invite_account_ids": [
    "accid2"
  ],
  "msg": "in",
  "extension": "fugiat in"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://open.yunxinapi.com/im/v2/team_members' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "operator_id": "accid1",
    "team_id": 18573968767,
    "team_type": 1,
    "invite_account_ids": [
        "accid2"
    ],
    "msg": "in",
    "extension": "fugiat in"
}'

返回响应

🟢200成功

application/json

Body

code

integer

状态码

必需

200 表示请求成功。

msg

string

提示信息

必需

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

data

object

返回数据

必需

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

success_list

array[string]

成功的列表

可选

成功的账号列表

failed_list

array [object {3}]

失败的列表

可选

失败的账号列表

示例

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

🟢200成功

🟢200请求参数错误

🟢200服务器错误