根据用户账号批量查询用户信息
更新时间:2025-01-26 14:28:10

根据用户账号批量查询用户信息

请求方法

POST

请求地址

/accounts/users/batch

请求参数

参数 参数类型 数据类型 是否必需 描述
accounts Body AccountReq[] 账号

AccountReq对象定义

参数 数据类型 描述
account String 账号
accountType Integer 账号类型,非必填, 默认为企业成员信息的 number 类型。可填:0 邮箱账号,1 手机号,3 个人云账号,13 第三方账号类型,20 用户名账号

HTTP状态码

返回值 描述
200 操作成功,详见AccountResp[]
400 客户端传参异常
401 鉴权失败
500 服务端异常

AccountResp对象定义

参数 数据类型 描述
id String 主键id
partyId String 所属企业id
groupId String 分组id
name String 名称
alias String 用户别名
gender Integer 性别,0:保密;1:男;2:女
account String 账号
accountType Integer 账号类型,0 邮箱账号,1 手机号,3 个人云账号,13 第三方账号类型,20 用户名账号

请求消息示例

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

{
  "accounts": [
    {
      "account": "7777771111",
      "accountType": 3
    }
  ]
}

响应消息示例

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

[{
    "id": "70af3721acb34aef8ffc7bf9fa26d5d8",
    "partyId": "2cc042de92bb4033aa6a5fc42ddc88fb",
    "groupId": "358fb5cfcf9b4939ad0df6baefa1f5a3",
    "name": "test",
    "alias": null,
    "gender": 0,
    "account": "7777771111",
    "accountType": 3
}]

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 '{"accounts":[{"account":"openapi@yealink.com","accountType":null}]}' 'https://api.yealink.com/open/api/v2/accounts/users/batch'
本页目录