添加用户
请求方法
POST
请求地址
/open/api/v1/users
请求参数
参数 |
参数类型 |
数据类型 |
是否必需 |
描述 |
name |
Body |
String |
是 |
名称,长度小于128 |
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:女。默认为保密 |
password |
Body |
String |
否 |
密码,符合系统 设置的密码安全策略 |
extension |
Body |
String |
否 |
账号短号,长度小于64 |
HTTP状态码
返回值 |
描述 |
200 |
操作成功,详见响应参数 |
400 |
客户端传参异常 |
401 |
鉴权失败 |
500 |
服务端异常 |
响应参数
参数 |
数据类型 |
描述 |
id |
String |
主键id |
number |
String |
号码 |
请求消息示例
POST /open/api/v1/users HTTP/1.1
Host: smart.yealink.com
Content-Type: application/json
{
"name": "zd3",
"email": "test@yealink.com",
"mobile": "13500000000",
"mobileCode": "86",
"groupId": "1f210c8505504258bbbdc8c6a0574d50",
"title": "经理",
"gender": 0,
"password": "v123456789!",
"extension": "9999"
}
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"id": "9ecc83e4c7d44728bbb1e2ec226dffe7",
"number": "1455162222
}
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://smart.yealink.com/open/api/v1/users'