Batch Get User Online Status

Retrieves the online status of multiple users in one request.

Request URL

POST {base_url}/uc-cconfig/api/v1/users/batch-online-status

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Body parameters
Parameter Required Type Description
extensions No Array<String> The list of extension numbers to query.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Batch_Status_Result> The online status of the users.
Batch_Status_Result
Parameter Type Description
data Object The online status of the users in a map. The key is the extension number, and the value is the online status object.
Online_Status
Parameter Type Description
sip Object<Client_Status> The registration status of the SIP client.
mobile Object<Client_Status> The registration status of the mobile client.
desktop Object<Client_Status> The registration status of the desktop client.
web Object<Client_Status> The registration status of the web client.
userOnlineStatus String

The overall online status of the user:

  • USER_ONLINE
  • USER_OFFLINE
Client_Status
Parameter Type Description
status String The registration status of the client, such as SIP_ONLINE, SIP_OFFLINE, SIP_UNAVAILABLE, MOBILE_ONLINE, MOBILE_OFFLINE, DESKTOP_ONLINE, DESKTOP_OFFLINE, WEB_ONLINE, and WEB_OFFLINE.
source Array<Register_Source> The list of registration sources of the client.
isRegistered Boolean

Whether the client is registered.

  • true: Registered.
  • false: Not registered.
Register_Source
Parameter Type Description
address String The IP address of the registration source.
platform String The platform of the registration source, such as IOS.
isRegistered Boolean

Whether the registration source is registered.

  • true: Registered.
  • false: Not registered.
regCallId String The registration call ID of the registration source.

Example

Request example

POST /uc-cconfig/api/v1/users/batch-online-status HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiIxMDAwQGNvbG9ydGVzdDIiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX25hbWUiOiIxMDAwQGNvbG9ydGVzdDIiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiY2xpZW50X2V4dCI6eyJkZXNjcmlwdGlvbiI6IueuoeeQhuWQjuWPsFdlYuW6lOeUqCIsInBsYXRmb3JtIjoid2ViIn0sImV4cCI6MTc5MzYyMTI4NiwiaWF0IjoxNzkzNTk5Njg2LCJqdGkiOiI3ZmM2ZmZiMC02NTBlLTQyZjYtOGJmOC0wZmE3ZWFmYjY3YjgiLCJjbGllbnRfaWQiOiJub3ZvLWFkbWluLXdlYiIsInNpZCI6ImE0NDVkYjRhLTNkMjEtNGRlMi1hYmI2LWEwZmY5NjNmZjY3OCIsInVzZXJfZXh0Ijp7InJvbGVJZHMiOlsxMDJdLCJwdWlkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJ0ZW5hbnRJZCI6MjA3OTUwNDIwNTMwOTE5NDI0MSwicGFyZW50VWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5NiwidGVuYW50Q29kZSI6ImNvbG9ydGVzdDIiLCJ0eXBlIjoiVF9VU0VSIiwidXNlcklkIjoyMDc5NzQ2OTE1Mzg4MDc2MDMzLCJlbWFpbCI6Imxlb0BzYW1wbGUuY29tIiwidXNlcm5hbWUiOiIxMDAwQGNvbG9ydGVzdDIiLCJ1Y0lkIjozMDc2OTEzNjQ0ODkwODMyODk2fX0.Fetld7VQ6Vu5239kNE05a_-VVdNIHOHwZ3v-GTUmh47xxyKXPtbihGCEMR8-PDS2w1RzMGQKD-3ehpmojGyyh5GaaWl4yBnWg7zZlxrYciXtqsuCAcKre4fr_UViOQAVNkj3huuKEtUUjQtbbsb8WOv6w2rhfKJthJma4XRwoA3iDR8Snr5wT5cUa3kVEomSf1VQtAIMyEWrPXlt5kSPX11ZK3lB-JZtstKa84MIpgrHMlthJDiyYbOlRKDcq570kDQI4BrYCX1sIjACnUHiyvd_7qxK9rNcihnXgbTOC2sEvEJJDwdudoNBENZgH-tKV7wR_8jpaKxa6Djkf_x1sA
x-tenant-code: jint
Content-Type: application/json
{
  "extensions": [
    "1000"
  ]
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "5769af46cd3702a327c5dc596a7a486e",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "data": {
      "1000": {
        "sip": {
          "status": "SIP_UNAVAILABLE",
          "source": [],
          "isRegistered": false
        },
        "mobile": {
          "status": "MOBILE_ONLINE",
          "source": [
            {
              "address": "112.48.19.183",
              "platform": "IOS",
              "isRegistered": false,
              "regCallId": ""
            }
          ],
          "isRegistered": false
        },
        "desktop": {
          "status": "DESKTOP_OFFLINE",
          "source": [],
          "isRegistered": false
        },
        "web": {
          "status": "WEB_OFFLINE",
          "source": [],
          "isRegistered": false
        },
        "userOnlineStatus": "USER_ONLINE"
      }
    }
  }
}