文档帮助平台
首页服务端API参考 企业成员管理 添加用户
添加用户
更新时间：2025-04-14 05:56:23

添加用户

请求方法

POST

请求地址

/users

请求参数

参数 参数类型 数据类型 是否必需 描述
name Body String 是 名称，长度小于128
extension Body String 是 分机号，必须符合企业号码号段规则，默认4位数字
mobile Body String 否 手机号
email Body String 否 邮箱，长度小于128
groupId Body String 否 分组id，长度32，默认添加至根分组下
mobileCode Body String 否 手机区号，默认为86
title Body String 否 职位，长度小于128
gender Body Integer 否 性别，0：保密；1：男；2：女。默认为保密
enableMeetingNow Body Boolean 否 默认true，是否启用即时会议功能
enableMeetingAppoinitment Body Boolean 否 默认true，是否启用会议预约功能
userName Body String 否 用户名，长度小于128，默认为空，只允许输入字母，符号，数字且不能为纯数字以及邮箱
enableAudioPermission Body Boolean 否 是否开启语音权限， 默认true
callPermissions Body String[] 否 默认局内呼叫["intra_office"]；取值范围为intra_office:局内呼叫，local：本地呼叫，national_toll：国内长途, international_toll：国际长途
customFields Body Map<String, CustomsFieldValue> 否 自定义字段，需要先查询自定义字段列表,map的key为自定义字段变量名，CustomFieldValue为自定义字段的值。默认为空
extAccount Body String 否 第三方账号，如LDAP账号，extAccountType有值时必填
extAccountType Body Integer 否 第三方账号类型，1：LDAP账号。默认为不填，普通账号；extAccount有值时必填。
alias Body String 否 别名，长度不超过128。默认为空
enableMobileHide Body Boolean 否 手机号隐藏，默认false
enableAutomaticRecording Body Boolean 否 是否开启自动录音权限， 默认false
recordingRange Body Integer 否 自动录音范围，0：外线通话，1：全部通话 ；默认外线通话
enableManualRecording Body Boolean 否 是否开启手动录音权限， 默认关闭
enableIm Body Boolean 否 是否开启IM权限， 默认false
enableIpLimit Body Boolean 否 是否开启Ip限制， 默认false
networkSegmentRang Body String 否 网段范围， ip/掩码位: 比如"1.1.1.1/2"。 默认空
enableVideoPermission Body Boolean 否 是否开启视频权限， 默认true
enableAudioConferencePermission Body Boolean 否 是否开启语音会议权限， 默认true

CustomFieldValue

自定义字段类型 CustomFieldValue数据类型 是否必需 备注
文本 String 否 -
号码 String 否 -
URL URL 否 -
选项 String - 选项的可选值

HTTP状态码

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

响应参数

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

请求消息示例

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

{
    "name":"zd3",
    "extension":"2222",
    "email":"test@yealink.com",
    "mobile":"13500000000",
    "customFields": {
            "customField5": {
                "name": "URL名称5",
                "url": "http://5.5.5.5"
            },
            "customField7": "3",
            "customField8": {
                "name": "URL名称8",
                "url": "http://8.8.8.8"
            },
            "customField1": "自定义字段1",
            "customField2": "自定义字段2",
            "customField10": "自定义字段10",
            "customField3": "自定义字段3",
            "customField4": "123456789",
            "customField9": "自定义字段9"
    }
}

响应消息示例

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

{
    "id": "9ecc83e4c7d44728bbb1e2ec226dffe7",
    "number": "145516*2222
}

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"}' 'https://api.yealink.com/open/api/v2/users'
本页目录