Skip to content

Commit

Permalink
Merge pull request #497 from haoxiuwen/doc-v2
Browse files Browse the repository at this point in the history
Modify Group Creation Parameter  Description for REST and Web API
  • Loading branch information
haoxiuwen authored Nov 15, 2023
2 parents 2e3da89 + 5c52cfd commit eaaa4f8
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/document/server-side/group.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ POST https://{host}/{org_name}/{app_name}/chatgroups
| `membersonly` | Bool || 用户申请入群是否需要群主或者群管理员审批。 <br/> - `true`:需要; <br/> - (默认)`false`:不需要,用户直接进群。 |
| `invite_need_confirm` | Bool || 邀请用户入群时是否需要被邀用户同意。<br/> - (默认)`true`:是;<br/> - `false`:否。 |
| `owner` | String || 群主的用户 ID。 |
| `members` | Array || 群组普通成员和管理员的用户 ID 数组,不包含群主的用户 ID。该数组可包含的元素数量不超过 `maxusers` 的值。 |
| `members` | Array || 群成员的用户 ID 数组,不包含群主的用户 ID。该数组可包含的元素数量不超过 `maxusers` 的值。 |
| `custom` | String || 群组扩展信息,例如可以给群组添加业务相关的标记,不要超过 1,024 字符。 |

#### HTTP 响应
Expand Down
18 changes: 9 additions & 9 deletions docs/document/web/group_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,15 @@

| 参数 | 类型 | 描述 |
| :------------- | :----- | :--------------------------------------------- |
| `groupname` | String | 群组名称。 |
| `desc` | String | 群组描述。 |
| `members` | Array | 群成员的用户 ID 组成的数组|
| `public` | Bool | 是否为公开群:<br/> - `true`:是;<br/> - `false`:否。该群组为私有群。 |
| `approval` | Bool | 入群申请是否需群主或管理员审批:<br/> - `true`:需要;<br/> - `false`:不需要。<br/>由于私有群不支持用户申请入群,只能通过邀请方式进群,因此该参数仅对公开群有效,即 `public` 设置为 `true` 时,对私有群无效。 |
| `allowinvites` | Bool | 是否允许普通群成员邀请人入群:<br/> - `true`:允许;<br/> - `false`:不允许。只有群主和管理员才可以向群组添加用户。<br/>该参数仅对私有群有效,即 `public` 设置为 `false` 时, 因为公开群(public:`true`) 仅支持群主和群管理员邀请人入群,不支持普通群成员邀请人入群。 |
| `inviteNeedConfirm` | Bool | 邀请加群时是否需要受邀用户确认:<br/> - `true`:受邀用户需同意才会加入群组;<br/> - `false`:受邀用户直接加入群组,无需确认。 |
| `maxusers` | Int | 群组最大成员数。 |
| `ext` | String | 群组详情扩展信息。 |
| `groupname` | String | 群组名称。|
| `desc` | String | 群组描述。|
| `members` | Array | 群成员的用户 ID 组成的数组,不包含群主的用户 ID。|
| `public` | Bool | 是否为公开群:<br/> - `true`:是;<br/> - `false`:否。该群组为私有群。 |
| `approval` | Bool | 入群申请是否需群主或管理员审批:<br/> - `true`:需要;<br/> - `false`:不需要。<br/>由于私有群不支持用户申请入群,只能通过邀请方式进群,因此该参数仅对公开群有效,即 `public` 设置为 `true` 时,对私有群无效。 |
| `allowinvites` | Bool | 是否允许普通群成员邀请人入群:<br/> - `true`:允许;<br/> - `false`:不允许。只有群主和管理员才可以向群组添加用户。<br/>该参数仅对私有群有效,即 `public` 设置为 `false` 时, 因为公开群(public:`true`仅支持群主和群管理员邀请人入群,不支持普通群成员邀请人入群。 |
| `inviteNeedConfirm` | Bool | 邀请加群时是否需要受邀用户确认:<br/> - `true`:受邀用户需同意才会加入群组;<br/> - `false`:受邀用户直接加入群组,无需确认。 |
| `maxusers` | Int | 群组最大成员数,默认为 `200`。不同套餐支持的人数上限不同,详见 [产品价格](https://www.easemob.com/pricing/im)|
| `ext` | String | 群组扩展信息,例如可以给群组添加业务相关的标记,不要超过 1,024 字符。 |

创建群组的示例代码如下:

Expand Down

0 comments on commit eaaa4f8

Please sign in to comment.