# 创建用户组
使用该接口创建用户组,请注意创建用户组时应用的通讯录权限范围需为“全部员工”,否则会创建失败。
# 请求
基本 | |
---|---|
HTTP URL | https://hi-gw.weizhipin.com/open-apis/contact/group |
HTTP Method | POST |
支持的应用类型 | 仅自建应用 |
权限要求 | 更新用户组 |
# 请求头
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token "示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" |
Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
# 查询参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
client_token | string | 否 | 用于幂等判断是否为同一请求,避免重复创建。字符串类型,自行生成。 |
# 请求体
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
group_id | string | 否 | 自定义用户组ID,可在创建时自定义,不自定义则由系统自动生成,已创建用户组不允许修改 group_id 。 |
name | string | 是 | 用户组的名字,企业内唯一,最大长度:100 字符 示例值:"IT 外包组" |
# 请求体示例
{
"groupId":"zloKKu33NBzg1NjW5",
"name":"开放平台测试118"
}
1
2
3
4
2
3
4
# 响应
# 响应体
名称 | 类型 | 描述 |
---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | string | 用户组ID |
# 响应体示例
{
"code": 0,
"traceId": "_Ao59UOIBLPCeAAu",
"data": "zloKKu33NBzg1NjW6",
"msg": "操作成功"
}
1
2
3
4
5
6
2
3
4
5
6