批量添加用户
请求方法
POST
请求地址
/users/batchAdd
请求参数
| 参数 |
参数类型 |
数据类型 |
是否必需 |
描述 |
| data |
Body |
User[] |
是 |
要添加的用户信息数组,一次最多200个,User见6. 添加用户.md |
HTTP状态码
| 返回值 |
描述 |
| 200 |
操作成功,详见响应参数 |
| 400 |
客户端传参异常 |
| 401 |
鉴权失败 |
| 500 |
服务端异常 |
响应参数
UserAddResp对象定义
| 参数 |
数据类型 |
描述 |
| id |
String |
主键id |
| number |
String |
号码 |
请求消息示例
POST /open/api/v2/users/batchAdd HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"data": [
{
"name": "Open用户1001",
"extension": "1001",
"groupId": "6929d7ad48fc4d2ca408ff267fd76da5"
},
{
"name": "Open用户1002",
"extension": "1002",
"extAccount": "hk0002",
"extAccountType": 1,
"groupId": "6929d7ad48fc4d2ca408ff267fd76da5"
}
]
}
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
[
{
"id": "7ec4838534744e76b8a0f99d8433d9c4",
"number": "1001"
},
{
"id": "ce2efe0a324046f5b96a33ebb9255e3c",
"number": "1002"
}
]
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 '{"data":[{"name":"Open用户1001","extension":"1001","groupId":"6929d7ad48fc4d2ca408ff267fd76da5"},{"name":"Open用户1002","extension":"1002","extAccount":"hk0002","extAccountType":1,"groupId":"6929d7ad48fc4d2ca408ff267fd76da5"}]}' 'https://api.yealink.com/open/api/v2/users/batchAdd'