diff --git a/docs/document/server-side/group.md b/docs/document/server-side/group.md index 60bdb4617..36afca261 100644 --- a/docs/document/server-side/group.md +++ b/docs/document/server-side/group.md @@ -96,7 +96,7 @@ POST https://{host}/{org_name}/{app_name}/chatgroups | `membersonly` | Bool | 否 | 用户申请入群是否需要群主或者群管理员审批。
- `true`:需要;
- (默认)`false`:不需要,用户直接进群。 | | `invite_need_confirm` | Bool | 否 | 邀请用户入群时是否需要被邀用户同意。
- (默认)`true`:是;
- `false`:否。 | | `owner` | String | 是 | 群主的用户 ID。 | -| `members` | Array | 否 | 群组普通成员和管理员的用户 ID 数组,不包含群主的用户 ID。该数组可包含的元素数量不超过 `maxusers` 的值。 | +| `members` | Array | 否 | 群成员的用户 ID 数组,不包含群主的用户 ID。该数组可包含的元素数量不超过 `maxusers` 的值。 | | `custom` | String | 否 | 群组扩展信息,例如可以给群组添加业务相关的标记,不要超过 1,024 字符。 | #### HTTP 响应 diff --git a/docs/document/web/group_manage.md b/docs/document/web/group_manage.md index a402d071d..c05afa34a 100644 --- a/docs/document/web/group_manage.md +++ b/docs/document/web/group_manage.md @@ -37,15 +37,15 @@ | 参数 | 类型 | 描述 | | :------------- | :----- | :--------------------------------------------- | -| `groupname` | String | 群组名称。 | -| `desc` | String | 群组描述。 | -| `members` | Array | 群成员的用户 ID 组成的数组。 | -| `public` | Bool | 是否为公开群:
- `true`:是;
- `false`:否。该群组为私有群。 | -| `approval` | Bool | 入群申请是否需群主或管理员审批:
- `true`:需要;
- `false`:不需要。
由于私有群不支持用户申请入群,只能通过邀请方式进群,因此该参数仅对公开群有效,即 `public` 设置为 `true` 时,对私有群无效。 | -| `allowinvites` | Bool | 是否允许普通群成员邀请人入群:
- `true`:允许;
- `false`:不允许。只有群主和管理员才可以向群组添加用户。
该参数仅对私有群有效,即 `public` 设置为 `false` 时, 因为公开群(public:`true`) 仅支持群主和群管理员邀请人入群,不支持普通群成员邀请人入群。 | -| `inviteNeedConfirm` | Bool | 邀请加群时是否需要受邀用户确认:
- `true`:受邀用户需同意才会加入群组;
- `false`:受邀用户直接加入群组,无需确认。 | -| `maxusers` | Int | 群组最大成员数。 | -| `ext` | String | 群组详情扩展信息。 | +| `groupname` | String | 群组名称。| +| `desc` | String | 群组描述。| +| `members` | Array | 群成员的用户 ID 组成的数组,不包含群主的用户 ID。| +| `public` | Bool | 是否为公开群:
- `true`:是;
- `false`:否。该群组为私有群。 | +| `approval` | Bool | 入群申请是否需群主或管理员审批:
- `true`:需要;
- `false`:不需要。
由于私有群不支持用户申请入群,只能通过邀请方式进群,因此该参数仅对公开群有效,即 `public` 设置为 `true` 时,对私有群无效。 | +| `allowinvites` | Bool | 是否允许普通群成员邀请人入群:
- `true`:允许;
- `false`:不允许。只有群主和管理员才可以向群组添加用户。
该参数仅对私有群有效,即 `public` 设置为 `false` 时, 因为公开群(public:`true`)仅支持群主和群管理员邀请人入群,不支持普通群成员邀请人入群。 | +| `inviteNeedConfirm` | Bool | 邀请加群时是否需要受邀用户确认:
- `true`:受邀用户需同意才会加入群组;
- `false`:受邀用户直接加入群组,无需确认。 | +| `maxusers` | Int | 群组最大成员数,默认为 `200`。不同套餐支持的人数上限不同,详见 [产品价格](https://www.easemob.com/pricing/im)。 | +| `ext` | String | 群组扩展信息,例如可以给群组添加业务相关的标记,不要超过 1,024 字符。 | 创建群组的示例代码如下: