添加分组成员
团队使用该接口前,需要提前获得用户的 user_id,有两种方法:
方法1: 从通讯录页面邀请成员加入团队后,通过获取成员列表 获得 user_id
方法2: 使用注册用户创建一个第三方账号,获得 user_id
接口概述#
- 功能:添加成员
- 请求方式:POST
- 请求地址:/api/contacts/teams/{team_id}/groups/{group_id}/users/{user_id}
请求参数#
| 参数名 | 类型 | 必须 | 参数位置 | 描述 | 示例值 |
|---|---|---|---|---|---|
| team_id | integer | 是 | uri | 团队ID | 43 |
| group_id | integer | 是 | uri | 分组ID | 1923 参数为0时默认添加到“根目录” |
| user_id | integer | 是 | uri | 用户ID | 60000208205 |
| open_id | string | 否 | body | 用户在第三方平台的唯一标识仅合作平台可用 | abcdefg |
响应参数#
无
响应示例#
- 请求成功
{ "code": "OK", "error": { "type": "" }, "data": {}, "request_id": "10595b0f-9333-4ad7-8bda-ce2c00119758"}- 请求失败
{ "code": "InvalidArgument", "error": { "type": "invalid_param" }, "data": {}, "request_id": "793fb149-4f12-4439-aa83-01d0e211b15c"}错误码#
| error.type 错误代码 | 错误描述 |
|---|---|
| contacts_user_existed | 用户已存在于通讯录 |
| contacts_team_not_found | 团队不存在 |
| contacts_group_not_found | 分组不存在 |
| contacts_user_not_found | 用户不存在 |
| contacts_add_user_error | 添加用户失败 |
| invalid_argument | 参数错误 |
| claim_error | 无权限 |