即时通信
  1. 群组管理
即时通信
  • API在线调试指南
  • IM账号管理
    • 注册云信IM账号
      POST
    • 更新账号属性
      PATCH
    • 刷新 Token
      PATCH
    • 封禁账号
      PATCH
    • 更新移动端推送配置
      PATCH
    • 查询账号属性
      GET
    • 批量查询账号信息
      GET
    • 强制账号退出登录
      POST
  • 用户名片管理
    • 更新用户名片
      PATCH
    • 查询用户名片
      GET
    • 批量查询用户名片
      GET
    • 批量获取账号在线状态
      POST
  • 好友管理
    • 添加好友
      POST
    • 删除好友
      DELETE
    • 更新好友信息
      PATCH
    • 查询好友信息
      GET
    • 分页查询好友列表
      GET
    • 同意/拒绝添加好友
      POST
  • 静音管理
    • 分页查询静音列表
    • 解除静音
    • 设置静音
  • 黑名单管理
    • 列入黑名单
    • 移出黑名单
    • 分页查询黑名单列表
  • 消息管理
    • 发送消息
    • 批量发送单聊消息
    • 撤回/删除消息
    • 删除会话中漫游/历史消息
    • 发送单聊已读回执
    • 发送高级群已读回执
    • 查询群消息已读未读详情
    • 查询单条消息
    • 分页查询历史消息
    • 发送聊天室消息
    • 批量发送聊天室消息
    • 撤回/删除聊天室历史消息
    • 分页查询聊天室历史消息
    • 更新消息
    • 根据消息 ID 查询历史消息
    • 查询 Thread 消息
    • 添加快捷评论
    • 删除快捷评论
    • 查询快捷评论
    • 检索历史消息
    • 发送流式消息
  • 会话功能
    • 会话管理
      • 创建会话
      • 更新会话
      • 删除会话
      • 批量删除会话
      • 查询会话信息
      • 批量查询会话信息
      • 分页查询账号的所有会话列表
    • 会话未读数管理
      • 获取会话总未读数
    • 会话分组
      • 创建会话分组
      • 更新会话分组
      • 删除会话分组
      • 查询会话分组信息
      • 批量查询会话分组信息
      • 查询所有会话分组信息
  • 群组功能
    • 群成员
      • 拉人入群
      • 踢人出群
      • 主动退群
      • 更新群成员信息
      • 批量禁言群成员
      • 分页查询指定账号已加入的群组信息
    • 群组管理
      • 创建群组
        POST
      • 更新群组信息
        PATCH
      • 转让群主
        PATCH
      • 添加管理员
        POST
      • 移除管理员
        DELETE
      • 解散群组
        DELETE
      • 查询群组信息
        GET
      • 批量查询群组信息列表
        GET
      • 查询高级群在线成员列表
        GET
      • 批量查询高级群的在线成员数
        GET
      • 分页查询群成员列表
        GET
  • 聊天室功能
    • 聊天室管理
      • 创建聊天室
      • 获取聊天室地址
      • 查询聊天室信息
      • 更新聊天室信息
      • 开放/关闭聊天室
      • 聊天室禁言
      • 开启/关闭进出聊天室事件通知
      • 查询开放状态的聊天室
      • 分页查询聊天室在线成员列表
      • 查询聊天室固定成员列表
    • 聊天室成员
      • 设置聊天室成员角色
      • 更新聊天室在线成员信息
      • 禁言聊天室成员
      • 临时禁言聊天室成员
      • 查询聊天室的禁言列表
      • 拉黑聊天室成员
      • 聊天室标签禁言
      • 查询聊天室黑名单列表
      • 聊天室标签禁言
      • 修改聊天室在线成员标签
      • 查询标签下的在线成员数
      • 分页查询标签下的在线成员列表
      • 批量查询聊天室固定成员信息
      • 添加聊天室虚构用户
      • 删除聊天室虚构用户
      • 清空聊天室虚构用户
      • 查询聊天室虚构用户
    • 聊天室队列
      • 初始化聊天室队列
      • 删除聊天室队列
      • 更新聊天室队列
      • 查询聊天室队列元素
      • 从聊天室队列中取出元素
  • 广播消息管理
    • 发送广播消息
    • 删除广播消息
    • 查询广播消息
    • 分页查询广播消息
    • 发送聊天室全服广播消息
  • 系统通知管理
    • 发送自定义系统通知
    • 批量发送自定义系统通知
  • 发布订阅
    • 订阅在线状态事件
    • 查询在线状态事件订阅关系
    • 取消在线状态事件订阅
  • 翻译
    • 文本翻译
  1. 群组管理

创建群组

POST
/im/v2/teams

请求参数

Header 参数
AppKey
string 
必需
默认值:
{{AppKey}}
X-custom-traceid
string 
可选
默认值:
{% mock 'uuid' %}
Nonce
string 
必需
默认值:
{{Nonce}}
CurTime
string 
必需
默认值:
{{CurTime}}
CheckSum
string 
必需
默认值:
{{CheckSum}}
Body 参数application/json
owner_account_id
string 
必需
群主(创建者)云信账号 ID。
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 位字符
invite_account_ids
array[string]
必需
创建群组时邀请入群的成员列表。 单个元素为成员的云信账号 ID。 无需添加群主(owner_account_id),群主(创建者)默认入群。 群成员(包括群主)总数不超过 members_limit。
invite_msg
string 
必需
邀请入群的附言,长度上限 150 位字符。
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,表示当前群组信息过安全通的指定检测策略。
示例
{
    "owner_account_id": "accid1",
    "team_type": 1,
    "name": "车快他队果争",
    "icon": "http://dummyimage.com/100x100",
    "announcement": "occaecat Ut",
    "intro": "cupidatat sed enim velit",
    "members_limit": 1,
    "server_extension": "in consequat sunt irure",
    "extension": "amet dolore magna",
    "invite_account_ids": [
        "81"
    ],
    "invite_msg": "magna dolore dolor Excepteur do",
    "configuration": {
        "join_mode": 1,
        "agree_mode": 0,
        "invite_mode": 0,
        "update_team_info_mode": 1,
        "update_extension_mode": 1,
        "antispam_business_id": " "
    }
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '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 '{
    "owner_account_id": "accid1",
    "team_type": 1,
    "name": "车快他队果争",
    "icon": "http://dummyimage.com/100x100",
    "announcement": "occaecat Ut",
    "intro": "cupidatat sed enim velit",
    "members_limit": 1,
    "server_extension": "in consequat sunt irure",
    "extension": "amet dolore magna",
    "invite_account_ids": [
        "81"
    ],
    "invite_msg": "magna dolore dolor Excepteur do",
    "configuration": {
        "join_mode": 1,
        "agree_mode": 0,
        "invite_mode": 0,
        "update_team_info_mode": 1,
        "update_extension_mode": 1,
        "antispam_business_id": " "
    }
}'

返回响应

🟢200成功
application/json
Body
code
integer 
必需
msg
string 
必需
data
object 
必需
failed_list
object 
必需
拉入群组失败的云信账号信息列表。
team_info
object 
可选
创建成功的群组信息。
示例
{
    "code": 0,
    "msg": "string",
    "data": {
        "failed_list": {
            "account_id": "string",
            "error_code": 0,
            "error_msg": "string"
        },
        "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服务器错误
上一页
分页查询指定账号已加入的群组信息
下一页
更新群组信息
Built with