# 批量添加用户组成员

向普通用户组中批量添加成员,如果应用的通讯录权限范围是“全部员工”,则可将任何成员添加到任何用户组。

# 请求

基本
HTTP URL https://hi-gw.weizhipin.com/open-apis/contact/group/:group_id/member/batch_add
HTTP Method POST
支持的应用类型 仅自建应用
权限要求 更新用户组信息

# 请求头

名称 类型 必填 描述
Authorization string tenant_access_token
值格式:"Bearer access_token"
示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560"
Content-Type string 固定值:"application/json; charset=utf-8"

# 路径参数(url中冒号标识的参数,如":xxxx"请连同:整体替换成对应值)

名称 类型 描述
group_id string 用户组ID示例值:"test_group"

# 查询参数

名称 类型 必填 描述
member_id_type string 成员ID类型
示例值:"open_id"
可选值有
* open_id:member_id_type为user时,表示用户的open_id
* union_id:member_id_type为user时,表示用户的union_id
* user_id:member_id_type为user时,表示用户的user_id
默认值open_id

# 请求体

名称 类型 必填 描述
user_ids string[] 待添加成员
department_ids string[] 待添加部门

# 请求体示例

{
    "user_ids":["31480","3106", "3132","11111111392","11111111392","0326"],
    "department_ids":["0102","010404"]
}
1
2
3
4

# 响应

# 响应体

名称 类型 描述
code int 错误码,非 0 表示失败
msg string 错误描述
data batch_member -
 ∟success_user_ids string[] -
 ∟success_department_ids string[] -
 ∟fail_user_ids string[] -
 ∟fail_department_ids string[] -

# 响应体示例

{
    "code": 0,
    "traceId": "_Ao59UOIBLPCeAAu",
    "success": true,
    "data": {
        "success_user_ids": [
            "11111111392"
        ],
        "success_department_ids": [
            "0102"
        ],
        "fail_user_ids": ["10001"],
        "fail_department_ids": ["0001"]
    },
    "msg": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
最后更新于 : 3/4/2024, 3:29:16 PM