分页查询用户的在线状态

功能说明

获取用户的在线状态。目前包括如下三个呼叫状态：OFFLINE（离线）/IDLE（空闲）/INCALL（呼叫中），不同软终端同时登陆时，优先级OFFLINE < IDLE < INCALL

默认接口请求频率限制：20 次/秒

实现方法

REST URL

GET /api/rest/external/v1/userInfo/onlineState/page?enterpriseId=xxx&signature=xxx

请求参数说明:

参数	参数类型	参数位置	必须	默认值	说明	初始平台
enterpriseId	String	Query	是	无	企业ID	分区云 5.2-20250926 公有云
pageIndex	int	Query	否	0	页码，默认为0	分区云 5.2-20250926 公有云
pageSize	int	Query	否	20	每页大小，默认为20，最大不能超过100	分区云 5.2-20250926 公有云

示例代码

返回结果示例：

成功时返回结果数据，失败时返回小鱼RESTAPI错误

{
  "page": 0,
  "pageTotal": 17,
  "rowsTotal": 34,
  "rows": 2,
  "list": [
      {
       "name": "xxxx",
        "number": "xxxx",
       "callState": "OFFLINE"
     },
   ]
}

返回参数说明:

参数	说明
name	姓名
callState	在线状态
number	用户账号

请求失败结果示例

{
    "developerMessage": "ErrorStatus: SDK_INVALID_APPKEY No app found for extId: ",
    "userMessage": "sdk.invalid.key",
    "errorCode": 60001,
    "moreInfo": "http://www.com.ainemo.com/errors/60001"
}

2025-08-20 17:47:26

导出PDF文档