更新群组信息 - 即时通信

请求参数

Path 参数

team_id

string

必需

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

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

Body 参数application/json

team_type

integer

必需

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

>= 1<= 2

name

string

必需

群组名称，长度上限 64 位字符。

icon

string

可选

群组头像的 URL 地址，例如 "https://netease/xxx.png" ，长度上限 1024 位字符。

announcement

string

可选

群组公告，长度上限 1024 位字符。

intro

string

可选

群组简介，长度上限 512 位字符。

members_limit

integer

可选

群组成员数上限（包含群主），默认为 200。可设置范围的为：[2 ~ 200]。若需要扩展群容量，请前往云信控制台配置。配置好后，该参数颗设置的范围为：[2 ~ 控制台设置的群人数上限]。

server_extension

string

可选

自定义群组扩展字段，第三方可以跟据此属性自定义扩展自己的群属性，建议封装成 JSONObject 格式，{key:value}。长度上限 1024 位字符

extension

string

可选

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

configuration

object

群组配置项。

可选

join_mode

integer

可选

通过 SDK 侧操作申请入群的验证方式。 0（默认）：无需验证，直接入群。 1：需要群主或管理员验证通过才能入群。 2：不允许任何人申请入群。

>= 0<= 2

agree_mode

integer

可选

邀请入群时是否需要被邀请人的同意。 0（默认）：需要被邀请人同意才能入群。 1：不需要被邀请人同意，直接入群。

>= 0<= 1

invite_mode

integer

可选

邀请权限，即谁可以邀请他人入群。 0（默认）：群主和管理员。 1：所有人。

>= 0<= 1

update_team_info_mode

integer

可选

客户端修改群组信息的权限，即谁可以修改群组信息。 0（默认）：群主和管理员。 1：所有人。

>= 0<= 1

update_extension_mode

integer

可选

客户端修改群自定义扩展信息（server_extension&extension）权限，即谁可以修改群自定义扩展信息。 0（默认）：群主和管理员。 1：所有人。

>= 0<= 1

antispam_business_id

string

可选

安全通业务 ID，可以指定当前群组信息过安全通某个检测策略。JSON 字符串，例如 {"textbid":"","picbid":""}。默认情况下云信控制后台会生成默认业务，开通安全通后，客户端不需要配置业务 ID 就能默认走该策略，若需要自定义检测策略，请联系技术支持进行配置，配置好后传入对应的安全通业务 ID，表示当前群组信息过安全通的指定检测策略。

operator_id

string

必需

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

示例

{
  "operator_id": "accid1",
  "team_type": 2,
  "name": "统发领理先",
  "icon": "http://dummyimage.com/100x100",
  "announcement": "magna",
  "intro": "sunt commodo incididunt",
  "members_limit": 71,
  "server_extension": "qui est culpa",
  "extension": "ut sunt",
  "configuration": {
    "join_mode": 1,
    "agree_mode": null,
    "invite_mode": null,
    "update_team_info_mode": null,
    "update_extension_mode": null,
    "antispam_business_id": " ",
    "chat_banned_mode": null
  }
}

示例代码

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/teams/' \
--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_type": 2,
    "name": "统发领理先",
    "icon": "http://dummyimage.com/100x100",
    "announcement": "magna",
    "intro": "sunt commodo incididunt",
    "members_limit": 71,
    "server_extension": "qui est culpa",
    "extension": "ut sunt",
    "configuration": {
        "join_mode": 1,
        "agree_mode": null,
        "invite_mode": null,
        "update_team_info_mode": null,
        "update_extension_mode": null,
        "antispam_business_id": " ",
        "chat_banned_mode": null
    }
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

team_info

object

可选

创建成功的群组信息。

示例

{
  "code": 0,
  "msg": "string",
  "data": {
    "team_info": {
      "team_id": "string",
      "owner_account_id": "string",
      "name": "string",
      "icon": "string",
      "announcement": "string",
      "intro": "string",
      "server_extention": "string",
      "customer_extension": "string",
      "create_time": 0,
      "update_time": 0,
      "configuration": {
        "join_mode": 0,
        "agree_mode": 0,
        "invite_mode": 0,
        "update_team_info_mode": 0,
        "update_extension_mode": 0,
        "chat_banned_mode": 0
      }
    }
  }
}

🟢200成功

🟢200请求参数错误

🟢200服务器错误