Search Users

Searches users with pagination.

Request URL

POST {base_url}/uc-cconfig/api/v1/users/search-page

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
keyword No String The keyword used to search for users.
extension No String The extension number to filter by.
name No String The name to filter by.
email No String The email address to filter by.
presences No Array<String> The list of presence statuses to filter by.
userRoles No Array<String>

The list of user roles to filter by.

Valid value:

  • ROLE_USER
  • ROLE_ADMIN
callRecordingEnabled No Array<Boolean>

The call recording filter.

Valid value:

  • true: Return only users with call recording enabled.
  • false: Return only users with call recording disabled.
pageNumber No Integer The page number to retrieve.
pageSize No Integer The number of records to retrieve per page.
sorts No Array<Sort_Condition> The sort conditions.
Sort_Condition
Parameter Required Type Description
property No String The name of the field to sort by.
direction No String The sort order.

Valid value:

  • asc: Sort in ascending order.
  • desc: Sort in descending order.

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<Search_Result> The search result of users.
Search_Result
Parameter Type Description
pageSize Integer The number of records per page.
pageNumber Integer The current page number.
count String The total number of matching records.
results Array<User_List_Item> The list of users on the current page.
User_List_Item
Parameter Type Description
id String The ID of the user.
extension String The extension number of the user.
firstName String The first name of the user.
lastName String The last name of the user.
name String The display name of the user.
email String The email address of the user.
mobile String The mobile number of the user.
userRole String

The role of the user:

  • ROLE_USER
  • ROLE_ADMIN
currentPresence String The current presence status of the user.
onlineStatus Object<Online_Status> The online status of the user.
disabled Boolean

Whether the user is disabled.

  • true: Disabled.
  • false: Enabled.
avatarUrl String The avatar URL of the user.
callRecordingEnabled Boolean

Whether call recording is enabled for the user.

  • true: Enabled.
  • false: Disabled.
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/search-page 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
{
  "pageNumber": 1,
  "pageSize": 3
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "2b00be388155591f3373c53cd8162c27",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "pageSize": 3,
    "pageNumber": 1,
    "count": 6,
    "results": [
      {
        "id": "338136731335409664",
        "extension": "1000",
        "firstName": "Leo",
        "lastName": "Ball",
        "name": "Leo Ball",
        "email": "leo@sample.com",
        "mobile": "+8615880123456",
        "userRole": "ROLE_ADMIN",
        "currentPresence": "AVAILABLE",
        "onlineStatus": {
          "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"
        },
        "disabled": false,
        "avatarUrl": "https://novo-one-tst-self-operated-business.s3.ap-east-1.amazonaws.com/public/platform/jint/user_avatar/1786586611608/1.png",
        "callRecordingEnabled": false
      },
      {
        "id": "342552093490561024",
        "extension": "1001",
        "firstName": "Terrell Smith",
        "lastName": "",
        "name": "Terrell Smith",
        "email": "terrell@sample.com",
        "mobile": "",
        "userRole": "ROLE_USER",
        "currentPresence": "AVAILABLE",
        "onlineStatus": {
          "sip": {
            "status": "SIP_UNAVAILABLE",
            "source": [],
            "isRegistered": false
          },
          "mobile": {
            "status": "MOBILE_OFFLINE",
            "source": [],
            "isRegistered": false
          },
          "desktop": {
            "status": "DESKTOP_OFFLINE",
            "source": [],
            "isRegistered": false
          },
          "web": {
            "status": "WEB_OFFLINE",
            "source": [],
            "isRegistered": false
          },
          "userOnlineStatus": "USER_OFFLINE"
        },
        "disabled": false,
        "avatarUrl": "https://novo-one-tst-self-operated-business.s3.ap-east-1.amazonaws.com/public/platform/jint/user_avatar/1786586587824/2.png",
        "callRecordingEnabled": false
      },
      {
        "id": "338855950145581056",
        "extension": "1002",
        "firstName": "Philip Huff",
        "lastName": "",
        "name": "Philip Huff",
        "email": "becky@yeastar.com",
        "mobile": "",
        "userRole": "ROLE_ADMIN",
        "currentPresence": "AVAILABLE",
        "onlineStatus": {
          "sip": {
            "status": "SIP_UNAVAILABLE",
            "source": [],
            "isRegistered": false
          },
          "mobile": {
            "status": "MOBILE_OFFLINE",
            "source": [],
            "isRegistered": false
          },
          "desktop": {
            "status": "DESKTOP_OFFLINE",
            "source": [],
            "isRegistered": false
          },
          "web": {
            "status": "WEB_OFFLINE",
            "source": [],
            "isRegistered": false
          },
          "userOnlineStatus": "USER_OFFLINE"
        },
        "disabled": false,
        "avatarUrl": "https://novo-one-tst-self-operated-business.s3.ap-east-1.amazonaws.com/public/platform/jint/user_avatar/1786586602441/10.png",
        "callRecordingEnabled": false
      }
    ],
    "limit": 10
  }
}
Note:

The response is condensed. The array contains 3 items.