批量添加分组

请求方法

POST

请求地址

/users/groups/batchAdd

请求参数

参数	参数类型	数据类型	是否必需	描述
groups	Body	Group[]	是	要添加的分组信息列表，一次最多200个
parentId	Body	String	否	父分组id，长度32，默认在根分组下

Group对象定义

参数	参数类型	数据类型	是否必需	描述
name	Body	String	是	分组名称，长度小于128
index	Body	Long	否	排序值，传入为空时，按照默认规则，根据当前分组最后一个分组节点的排序值加上固定步长10000
extId	Body	String	否	第三方id，长度不超过64且唯一

HTTP状态码

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

响应参数

参数	参数类型	描述
GroupAddResp[]	GroupAddResp[]	分组创建结果响应对象

GroupAddResp对象定义

参数	数据类型	描述
id	String	分组id
extId	String	第三方id，长度32

请求消息示例

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

{
    "parentId":"706c463a3f2a487aaeed49579ca9b680",
    "groups": [
        {
           "name":"openApiGroup1",
           "extId": "2049545fc73b4c4899bb4dead34ce2cc"
        },
        {
           "name":"openApiGroup2"
        }
    ]
}

响应消息示例

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

[
    {
        "id": "7ec4838534744e76b8a0f99d8433d9c4",
        "extId": "2049545fc73b4c4899bb4dead34ce2cc"
    },
    {
        "id": "ce2efe0a324046f5b96a33ebb9255e3c"
    }
]

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":"openApiGroup","parentId":"706c463a3f2a487aaeed49579ca9b680","extId": "2049545fc73b4c4899bb4dead34ce2cc"}] }' 'https://api.yealink.com/open/api/v2/users/groups/batchAdd'