创建群组
URL
https://sdk.cloudroom.com/im/v1/group/create
请求方式:POST
请求参数
接口参数
| 名称 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| OwnerUserID | String | 是 | 群主(IM 用户 ID) |
| GroupName | String | 是 | 群名称,长度上限 64 位字符 |
| MemberUserIDs | String[] | 否 | 群成员列表(IM 用户 ID) 不需包含群主( OwnerUserID)和群管理员(AdminUserIDs),默认自动入群 |
| AdminUserIDs | String[] | 否 | 群管理员列表(IM 用户 ID) |
| Notification | String | 否 | 群公告,长度上限 1024 位字符 |
| Introduction | String | 否 | 群介绍,长度上限 512 位字符 |
| FaceURL | String | 否 | 群头像地址,长度上限 1024 位字符 |
| Ex | String | 否 | 群扩展字段,SDK 仅负责透传,不解析内容 |
| NeedVerification | Int | 否 | 进群是否需要验证。 0:群成员邀请无需验证 1:需要发送验证消息 2(默认):允许所有人加群 |
返回参数
| 名称 | 类型 | 说明 |
|---|---|---|
| RspCode | Int | 响应码 |
| RspDesc | String | 响应描述 |
| Data | Object | 数据对象 |
Data 数据详情
| 名称 | 类型 | 说明 |
|---|---|---|
| GroupID | String | 群ID |
示例
请求示例
curl -X POST https://sdk.cloudroom.com/im/v1/group/create \
-H "Content-Type: application/json" \
-d '{
"RequestId": "2d95a5fe-a384-5dea-0d84-db153b10ee0f",
"CompID": "1111111",
"SecretKey": "b7febff6a21c36fb50150f88c95ef641",
"OwnerUserID": "user_admin_001",
"GroupName": "产品需求讨论群",
"MemberUserIDs": ["user_dev_001", "user_pm_002", "user_test_003"],
"AdminUserIDs": ["user_pm_002"],
"Notification": "",
"Introduction": "",
"FaceURL": "https://test.com/avatars/group_default.png",
"Ex": "{\"department\":\"product\",\"project_id\":\"PRJ-2026\"}",
"NeedVerification": 1
}'
返回示例
{
"RspCode": 0,
"RspDesc": "请求成功",
"Data": {
"GroupID": "2355472856"
}
}
状态码
上述接口在 HTTPS Body 中返回请求的状态码,状态码详情请参见 状态码