创建用户

最近更新时间:2024-07-08 11:48:52

我的收藏

接口描述

描述:创建企业用户。
该接口仅适用于手动管理企业通讯录的方式。
不支持 SSO 登录。
创建用户后,用户状态初始为未激活。
暂不支持 OAuth2.0 鉴权访问。
请求方式:POST
自建应用权限点:管理企业用户。
接口请求域名
https://api.meeting.qq.com/v1/users


输入参数

以下请求参数列表仅列出了接口请求参数,HTTP 请求头公共参数请参见签名验证章节的 公共参数说明
参数名称
必选
参数类型
参数描述
email
String
邮箱地址,同企业内须保证唯一。与手机号二选一,若同时传入手机号和邮箱,则邮箱字段忽略。
area
String
地区编码(默认值为86)。
phone
String
手机号码。与邮箱二选一若企业未开通邮箱登录方式,手机号必填。
username
String
用户昵称。
userid
String
调用方用于标示用户的唯一 ID,最大支持传入40字节,暂不支持中文。
(例如:企业用户可以为企业账户英文名、员工工号、员工邮箱等,请勿使用手机号等个人敏感信息作为userid)。
staff_id
String
员工工号。
job_title
String
员工职位,长度范围为[0,96]个字符。
entry_time
Integer
入职时间。
department_list
String 数组
员工部门 ID,暂只支持为用户分配1个部门。
auto_invite
Boolean
自动发送邀请,开启之后调用接口后自动发送激活邀请。
true:开启,默认开启
false:关闭
user_account_type
Integer
指定账号类型。
1:高级账号(企业版/教育版)
2:免费账号(企业版,教育版,商业版) 3:免费账号100方 (商业版) 4:高级账号300方(商业版) 5:高级账号500方(商业版) 6:高级账号1000方(商业版) 7:高级账号2000方(商业版) 8:高级账号100方(商业版)
说明:
默认逻辑:
企业/教育版:优先高级账号,高级账号不足则创建免费账号。
商业版:优先高级账号(由低方数到高方数赋值),高级账号不足则免费账号。
注意:
userid 会在通讯录外显给企业内的所有成员,请勿使用个人敏感信息(例如手机号等)。

输出参数

参数名称
参数类型
参数描述
email
String
邮箱地址。
phone
String
手机号码。
username
String
用户昵称。
userid
String
调用方用于标示用户的唯一 ID(例如:企业用户可以为企业账户英文名、个人用户可以为手机号等,暂不支持中文)。
uuid
String
用户身份 ID(腾讯会议颁发的用于开放平台的唯一用户 ID)。

错误码列表

状态码
错误码
错误描述
400
500014
账号无权限。
400
190004
参数非法,请对照接口文档检查您的参数。
400
190301
请求重放错误,请求头里的 X-TC-Timestamp 和 X-TC-Nonce 每次请求时需重新生成,不能使用和过去五分钟内相同的 timestamp 和 nonce。
500
156011
数据处理中。
500
20016
图片尺寸过大。
500
20015
图片格式非法。
500
20014
图片大小非法。
500
20006
手机格式异常。
500
500025
版本不匹配。
500
41
网络错误,请稍后重试。
500
20002
用户已存在。
500
20013
图片 URL 非法。
500
41003
手机号码重复。
500
20029
图片访问失败,请稍后重试。
500
41005
邮箱重复。

示例

输入示例

POST https://api.meeting.qq.com/v1/users
{
"username": "testusername",
"phone": "18888888888",
"userid": "testuserid",
"email": "123456@qq.com",
"staff_id":"6666",
"job_title":"develop",
"entry_time":1628495795,
"department_list":["07f4c****************1966815d251"]
}

输出示例

{
"username": "testusername",
"phone": "18888888888",
"userid": "testuserid",
"email": "123456@qq.com",
"uuid": "WM4Fs4Th56ogU13JiK"
}