# 获取当前企业所有群组基本信息
GET /v1/groups
# 请求参数
| 参数名 | 数据类型 | 必填 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| lastUpdatedDate | string | N | query | 最后更新时间 |
# 返回结果
| 状态码 | 说明 | 返回值 | 响应头 |
|---|---|---|---|
| 200 | OK | ApiResultOfListOfGroupInfoResult | 无 |
| 401 | Unauthorized | 无 | 无 |
| 403 | Forbidden | 无 | 无 |
| 404 | Not Found | 无 | 无 |
# 请求示例
GET /v1/groups?lastUpdatedDate={lastUpdatedDate}
# 返回示例
Content-Type: */*
{
"data" : [ { //请求返回的数据
"groupId" : "string", //群组ID
"memberCount" : "string", //成员总数
"name" : "string", //群组名称
"icon" : "string", //群组图标
"eCode" : "string", //企业编码
"memberRole" : "integer" //当前用户在群里的角色(2：群主，1：管理员，0：普通成员，-1：不在此群)
} ],
"code" : "integer", //结果码 200:成功
"message" : "string" //当状态码不是200时，错误信息
}
# 创建群组
POST /v1/groups
# 请求类型（Content-Type）
application/json
# 请求参数
| 参数名 | 数据类型 | 必填 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| param | CreateGroupParam | Y | body | param |
# 返回结果
| 状态码 | 说明 | 返回值 | 响应头 |
|---|---|---|---|
| 200 | OK | ApiResultOfstring | 无 |
| 201 | Created | 无 | 无 |
| 401 | Unauthorized | 无 | 无 |
| 403 | Forbidden | 无 | 无 |
| 404 | Not Found | 无 | 无 |
# 请求示例
POST /v1/groups
Content-Type: application/json
{
"isThirdGroup" : "boolean", //是否第三方群组，默认：否
"name" : "string", //群组名称
"isPublic" : "boolean", //是否开放，开放的群组，用户可以申请加入，不开放的群组，只有管理员可以邀请参加，默认：否
"type" : "integer", //群组类型，1：内部群组，2：外部群组，3：项目群组
"users" : [ "string" ] //群组成员账号列表
}
# 返回示例
Content-Type: */*
{
"code" : "integer", //结果码 200:成功
"data" : "string", //请求返回的数据
"message" : "string" //当状态码不是200时，错误信息
}
# 创建入群码
POST /v1/groups/joincode
# 请求类型（Content-Type）
application/json
# 请求参数
| 参数名 | 数据类型 | 必填 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| groupId | string | Y | query | 群组ID |
| isOverride | boolean | Y | query | 是否覆盖已经生成的code |
# 返回结果
| 状态码 | 说明 | 返回值 | 响应头 |
|---|---|---|---|
| 200 | OK | ApiResultOfGroupJoinCodeResult | 无 |
| 201 | Created | 无 | 无 |
| 401 | Unauthorized | 无 | 无 |
| 403 | Forbidden | 无 | 无 |
| 404 | Not Found | 无 | 无 |
# 请求示例
POST /v1/groups/joincode?groupId={groupId}&isOverride={isOverride}
Content-Type: application/json
# 返回示例
Content-Type: */*
{
"data" : { //请求返回的数据
"code" : "string", //入群码
"expireDate" : "string" //入群码过期时间
},
"code" : "integer", //结果码 200:成功
"message" : "string" //当状态码不是200时，错误信息
}
# 通过入群码获取群组
GET /v1/groups/joincode/{joincode}
# 请求参数
| 参数名 | 数据类型 | 必填 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| joincode | string | Y | path | 入群码 |
# 返回结果
| 状态码 | 说明 | 返回值 | 响应头 |
|---|---|---|---|
| 200 | OK | ApiResultOfGroupInfoResult | 无 |
| 401 | Unauthorized | 无 | 无 |
| 403 | Forbidden | 无 | 无 |
| 404 | Not Found | 无 | 无 |
# 请求示例
GET /v1/groups/joincode/{joincode}
# 返回示例
Content-Type: */*
{
"data" : { //请求返回的数据
"groupId" : "string", //群组ID
"memberCount" : "string", //成员总数
"name" : "string", //群组名称
"icon" : "string", //群组图标
"eCode" : "string", //企业编码
"memberRole" : "integer" //当前用户在群里的角色(2：群主，1：管理员，0：普通成员，-1：不在此群)
},
"code" : "integer", //结果码 200:成功
"message" : "string" //当状态码不是200时，错误信息
}
# 删除群组
DELETE /v1/groups/{groupId}
# 请求参数
| 参数名 | 数据类型 | 必填 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| groupId | string | Y | path | 群组ID |
# 返回结果
| 状态码 | 说明 | 返回值 | 响应头 |
|---|---|---|---|
| 200 | OK | ApiResultOfobject | 无 |
| 204 | No Content | 无 | 无 |
| 401 | Unauthorized | 无 | 无 |
| 403 | Forbidden | 无 | 无 |
# 请求示例
DELETE /v1/groups/{groupId}
# 返回示例
Content-Type: */*
{
"code" : "integer", //结果码 200:成功
"data" : "object", //请求返回的数据
"message" : "string" //当状态码不是200时，错误信息
}
# 获取群组信息
GET /v1/groups/{groupId}/info
# 请求参数
| 参数名 | 数据类型 | 必填 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| groupId | string | Y | path | 群组ID |
# 返回结果
| 状态码 | 说明 | 返回值 | 响应头 |
|---|---|---|---|
| 200 | OK | ApiResultOfGroupInfoResult | 无 |
| 401 | Unauthorized | 无 | 无 |
| 403 | Forbidden | 无 | 无 |
| 404 | Not Found | 无 | 无 |
# 请求示例
GET /v1/groups/{groupId}/info
# 返回示例
Content-Type: */*
{
"data" : { //请求返回的数据
"groupId" : "string", //群组ID
"memberCount" : "string", //成员总数
"name" : "string", //群组名称
"icon" : "string", //群组图标
"eCode" : "string", //企业编码
"memberRole" : "integer" //当前用户在群里的角色(2：群主，1：管理员，0：普通成员，-1：不在此群)
},
"code" : "integer", //结果码 200:成功
"message" : "string" //当状态码不是200时，错误信息
}
# 获取群组成员
GET /v1/groups/{groupId}/members
# 请求参数
| 参数名 | 数据类型 | 必填 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| groupId | string | Y | path | groupId |
# 返回结果
| 状态码 | 说明 | 返回值 | 响应头 |
|---|---|---|---|
| 200 | OK | ApiResultOfListOfUserInfoResult | 无 |
| 401 | Unauthorized | 无 | 无 |
| 403 | Forbidden | 无 | 无 |
| 404 | Not Found | 无 | 无 |
# 请求示例
GET /v1/groups/{groupId}/members
# 返回示例
Content-Type: */*
{
"data" : [ { //请求返回的数据
"orgName" : "string", //用户所属部门名称
"enterprise" : "string", //企业名称
"name" : "string", //用户名称
"type" : "integer", //用户类型
"userId" : "string", //用户ID
"eCode" : "string", //企业编码
"orgId" : "string", //用户所属部门
"picture" : "string" //用户头像
} ],
"code" : "integer", //结果码 200:成功
"message" : "string" //当状态码不是200时，错误信息
}
# 增加群组成员
POST /v1/groups/{groupId}/members
# 请求类型（Content-Type）
application/json
# 请求参数
| 参数名 | 数据类型 | 必填 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| groupId | string | Y | path | groupId |
| userIds | string | Y | query | userIds |
# 返回结果
| 状态码 | 说明 | 返回值 | 响应头 |
|---|---|---|---|
| 200 | OK | ApiResultOfobject | 无 |
| 201 | Created | 无 | 无 |
| 401 | Unauthorized | 无 | 无 |
| 403 | Forbidden | 无 | 无 |
| 404 | Not Found | 无 | 无 |
# 请求示例
POST /v1/groups/{groupId}/members?userIds={userIds}
Content-Type: application/json
# 返回示例
Content-Type: */*
{
"code" : "integer", //结果码 200:成功
"data" : "object", //请求返回的数据
"message" : "string" //当状态码不是200时，错误信息
}
# 删除群组成员
DELETE /v1/groups/{groupId}/members
# 请求参数
| 参数名 | 数据类型 | 必填 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| groupId | string | Y | path | groupId |
| userIds | string | Y | query | userIds |
# 返回结果
| 状态码 | 说明 | 返回值 | 响应头 |
|---|---|---|---|
| 200 | OK | ApiResultOfListOfobject | 无 |
| 204 | No Content | 无 | 无 |
| 401 | Unauthorized | 无 | 无 |
| 403 | Forbidden | 无 | 无 |
# 请求示例
DELETE /v1/groups/{groupId}/members?userIds={userIds}
# 返回示例
Content-Type: */*
{
"data" : [ "object" ], //请求返回的数据
"code" : "integer", //结果码 200:成功
"message" : "string" //当状态码不是200时，错误信息
}
# 增加群组成员（外部接口）
POST /v1/groups/{groupId}/members/outer
# 请求类型（Content-Type）
application/json
# 请求参数
| 参数名 | 数据类型 | 必填 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| groupId | string | Y | path | groupId |
| loginIds | string | Y | query | loginIds |
# 返回结果
| 状态码 | 说明 | 返回值 | 响应头 |
|---|---|---|---|
| 200 | OK | ApiResultOfobject | 无 |
| 201 | Created | 无 | 无 |
| 401 | Unauthorized | 无 | 无 |
| 403 | Forbidden | 无 | 无 |
| 404 | Not Found | 无 | 无 |
# 请求示例
POST /v1/groups/{groupId}/members/outer?loginIds={loginIds}
Content-Type: application/json
# 返回示例
Content-Type: */*
{
"code" : "integer", //结果码 200:成功
"data" : "object", //请求返回的数据
"message" : "string" //当状态码不是200时，错误信息
}
# 删除群组成员（外部接口）
DELETE /v1/groups/{groupId}/members/outer
# 请求参数
| 参数名 | 数据类型 | 必填 | 参数位置 | 参数说明 |
|---|---|---|---|---|
| groupId | string | Y | path | groupId |
| loginIds | string | Y | query | loginIds |
# 返回结果
| 状态码 | 说明 | 返回值 | 响应头 |
|---|---|---|---|
| 200 | OK | ApiResultOfListOfobject | 无 |
| 204 | No Content | 无 | 无 |
| 401 | Unauthorized | 无 | 无 |
| 403 | Forbidden | 无 | 无 |
# 请求示例
DELETE /v1/groups/{groupId}/members/outer?loginIds={loginIds}
# 返回示例
Content-Type: */*
{
"data" : [ "object" ], //请求返回的数据
"code" : "integer", //结果码 200:成功
"message" : "string" //当状态码不是200时，错误信息
}