更新群成员信息 - 即时通信

请求参数

Path 参数

account_id

string

必需

需要更新信息的群成员账号 ID。

示例值:

accid1

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

Body 参数application/json

operator_id

string

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

必需

team_type

integer

群组类型

必需

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

team_id

number

群组 ID

必需

云信服务器返回。

team_nick

string

此成员在本群中的昵称

必需

至在本群中生效，不影响其他群组

chat_banned

boolean

在本群中是否禁言此成员

可选

false（默认）：不禁言；true：禁言。

message_notify_state

integer

本群的新消息是否提醒该成员

可选

0（默认）：提醒；1：不提醒。

extension

string

自定义扩展字段

可选

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

special_follow_update_info

object

可选

account_ids

array[string]

添加或移除的特别关注群成员列表

必需

type

integer

修改类型

必需

0：移除；1：添加

示例

{
  "operator_id": "accid1",
  "team_type": 1,
  "team_id": 18573968767,
  "team_nick": "白娟",
  "chat_banned": false,
  "message_notify_state": 1,
  "extension": "deserunt in cillum mollit"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PATCH 'https://open.yunxinapi.com/im/v2/team_members/accid1?members&reference&Type&_postman_listIndexKey=key&_postman_listAllowsMultipleValues' \
--data-raw '{
    "operator_id": "accid1",
    "team_type": 1,
    "team_id": 18573968767,
    "team_nick": "白娟",
    "chat_banned": false,
    "message_notify_state": 1,
    "extension": "deserunt in cillum mollit"
}'

返回响应

🟢200成功

application/json

Body

code

integer

状态码

必需

200 表示请求成功。

msg

string

提示信息

必需

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

data

object

返回数据

必需

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

member_role

integer

需要更新的群成员的角色

必需

0：群主；1：群管理员；2：群普通成员。

account_id

string

该成员的账号 ID。

必需

chat_banned

boolean

该成员是否被禁言

必需

invitor_account_id

string

邀请该成员入群的用户账号 ID。

必需

team_nick

string

该成员在本群中的昵称。

必需

create_time

integer

群成员信息生成的时间戳。

必需

update_time

integer

群成员信息更新的时间戳。

必需

示例

{
  "code": 68,
  "msg": "ullamco dolor nostrud consequat sunt",
  "data": {
    "member_role": 40,
    "account_id": "29",
    "chat_banned": false,
    "invitor_account_id": "6",
    "team_nick": "侯秀英",
    "create_time": 274093745635,
    "update_time": 1600900574016
  }
}

🟢200成功

🟢200请求参数错误

🟢200服务器错误