通过API开发者可通过不同软终端的在线状态获取本企业下的用户信息
默认接口请求频率限制:20次/秒。
REST URL
GET https://sdk.xylink.com/api/rest/external/{version}/enterprise/data/user/page?enterpriseId=xxx&callState=xxx&pageIndex=xxx&pageSize=xxx
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 | 初始平台 |
version | String | Path | 是 | 无 | v1 | 3.9无此接口 5.2 (2024-1018版本) |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 | 5.2 (2024-1018版本) |
signature | String | Query | 签名鉴权2.0:否 | 无 | API签名,参见签名规则 | 5.2 (2024-1018版本) |
callState | String | Query | 是 | 无 | 用户呼叫状态(必须为【idle,offline,incall】之一) | 6.0 5.2 (2024-1018版本) |
pageIndex | int | Query | 否 | 0 | 页码: 从0开始 | 6.0 5.2 (2024-1018版本) |
pageSize | int | Query | 否 | 20 | 每页查询数量: 最大100 | 6.0 5.2 (2024-1018版本) |
返回结果示例:
{
page:xxx
pageTotal:xxx,
rowsTotal: xxx,
rows:xxx,
list:[
{
name: "zs",
phone: "123456",
email: "xxx@ylink.com",
dept:["小鱼易连"],
deptCode: [xxx],
meetingRoomNumber: "xxxx"
}
]
}
返回参数说明
参数 | 说明 |
page | 当前页码 |
pageTotal | 总页码 |
rowstotal | 总条数 |
rows | 每页显示条数 |
list | 返回的结果集合 |
name | 用户名 |
phone | 用户手机号 |
用户邮箱 | |
meetingRoomNumber | 用户个人云会议室号 |
dept | 用户所属部门 |
deptCode | 用户所属部门编号 |