批量添加用户
请求方法
POST
请求地址
/third-party/cnne/apply
请求参数
| 参数 |
参数类型 |
数据类型 |
是否必需 |
描述 |
| data |
Body |
User[] |
是 |
要添加的用户信息数组,一次最多200个 |
User
| 参数 |
参数类型 |
数据类型 |
是否必需 |
描述 |
| extId |
Body |
String |
是 |
员工主数据编码,8位 |
| name |
Body |
String |
是 |
员工姓名,长度小于128 |
| recordFileStorageSize |
Body |
Integer |
是 |
录制存储空间,单位:G,-1表示不限制,可选 1-10,10-100的整十数值,100-1000的整百数值,1000-10000整千数值 |
| enableAutoRecord |
Body |
Boolean |
是 |
是否开启自动录制,true: 开启,false: 关闭。开启自动录制,会同步开启手动录制 |
| maxParticipantConcurrentAmount |
Body |
Integer |
是 |
入会方数限制,可选2~99999整数 |
HTTP状态码
| 返回值 |
描述 |
| 200 |
操作成功,详见响应参数 |
| 400 |
客户端传参异常 |
| 401 |
鉴权失败 |
| 500 |
服务端异常 |
响应参数
| 参数 |
参数类型 |
描述 |
| Resp[] |
Resp[] |
用户创建结果响应对象 |
Resp对象定义
| 参数 |
数据类型 |
描述 |
| id |
String |
主键id |
| number |
String |
号码 |
请求消息示例
POST /open/api/v2/third-party/cnne/apply HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"data": [
{
"extId": "12345678", // 员工主数据编码,8位
"name": "张三", // 员工姓名
"recordFileStorageSize": 5000, // 录制存储空间,单位:G,-1表示不限制,可选 1-10,10-100的整十数量,100-1000的整百数量,1000-10000整千数量
"enableAutoRecord": true, // 是否开启自动录制,true: 开启,false: 关闭。开启自动录制,会同步开启手动录制
"maxParticipantConcurrentAmount": 211 // 入会方数限制,可选2~99999整数
}
]
}
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
[
{
"extId": "12345678", // 员工主数据编码
"status": "syncing" // 用户未创建,则返回同步中
},
{
"extId": "22345678", // 员工主数据编码
"status": "synced" // 用户同步过,则返回已同步
}
]
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":[{"extId":"12345678","name":"张三","recordFileStorageSize":5000,"enableAutoRecord":true,"maxParticipantConcurrentAmount":200}]}' 'https://api.yealink.com/open/api/v2/third-party/cnne/apply'