文档帮助平台
首页服务端API参考 企业成员管理 添加用户
添加用户
更新时间：2024-11-03 14:16:26

添加用户

请求方法

POST

请求地址

/users

请求参数

参数 参数类型 数据类型 是否必需 描述
name Body String 是 名称，长度小于128
extension Body String 是 分机号，必须符合企业号码段规则，默认4位数字
identityType Body Integer 否 账号标识类型，可选值：0：注册账号，1：外部账号，默认0
externalId Body String 否 外部账号标识，identityType=1时，必填，长度小于32
mobile Body String 否 手机号，identityType=0时，必填
email Body String 否 邮箱
groupId Body String 否 分组id，长度32，默认添加至根分组下
mobileCode Body String 否 手机区号，默认为86
title Body String 否 职位，长度小于128
gender Body Integer 否 性别，0：保密；1：男；2：女。默认为保密
enableMeetNow Body Boolean 否 是否启用即时会议功能，默认为true
enableScheduled Body Boolean 否 是否启用会议预约功能，默认为true
~~visiblePermission~~ Body VisiblePermission 否 可见权限请求参数，默认可见企业内全部联系人(A)，字段废弃

HTTP状态码

返回值 描述
200 操作成功，详见响应参数
400 客户端传参异常
401 鉴权失败
500 服务端异常

响应参数

参数 数据类型 描述
id String 主键id
number String 号码

VisiblePermission

参数 数据类型 是否必须 描述
code String 是 可见权限类型，详见可见权限类型
nodes VisiblePermissionNode[] 否 节点数据，code为E时必填

VisiblePermissionNode

参数 数据类型 是否必须 描述
dataId String 是 节点数据id，E权限时有效，其值为节点数据类型对应的实体id
dataType Integer 否 节点数据类型，E权限时有效，详见节点数据类型

可见权限类型

可见权限类型 值
可见企业内全部联系人 A
可见所在部门及同级部门的所有联系人 B
仅可见所在部门的所有联系人 C
仅可见自己 D
自定义 E

节点数据类型

节点数据类型 值
用户分组 1
用户 2
设备分组 3
设备 4
VMR分组 5
VMR 6
外部联系人分组 9
外部联系人 10

请求消息示例

注册账号类型

POST /v2/users HTTP/1.1
Host: api.yealink.com
Content-Type: application/json

{
	"name":"zd3",
	"identityType" : 0,
	"extension":"2222",
	"email":"test@yealink.com",
	"mobile":"13500000000",
	"enableMeetNow": true,
	"enableScheduled": true
}

外部账号类型

POST /v2/users HTTP/1.1
Host: api.yealink.com
Content-Type: application/json

{
    "name": "张三",
    "identityType" : 1,
    "externalId": "3551551874",
    "extension": "8888",
    "mobile": "13500000000",
    "gender": 1,
    "groupId": "624d930c3xxxx5c08dd4986e",
    "enableMeetNow": true,
    "enableScheduled": true
}

响应消息示例

HTTP/1.1 200 
Content-Type: application/json;charset=UTF-8

{
	"id": "9ecc83e4c7d44728bbb1e2ec226dffe7",
	"number": "81455162222
}

CURL命令示例

curl -XPOST -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'timestamp: 1583742732181' -H 'nonce: 53f0765fadb54fb6b002f3baac2d5ec8' -H "Content-type: application/json" -d '{"name":"zd3","extension":"2222","email":"test@yealink.com","mobile":"13500000000","enableMeetNow":true,"enableScheduled": true, "category": 4}]}' 'https://api.yealink.com/v2/users'
本页目录