Search Tenant Phones

Searches the phones of the current tenant with pagination and returns the list of phones that match the search conditions.

Request URL

POST {base_url}/uc-cautop/api/v1/tenant/phones/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
pageSize Yes Integer The number of records per page.
pageNumber Yes Integer The page number to query, starting from 1.
keyword No String The keyword used for fuzzy matching of the MAC address, vendor, model, extension number, IP address, and template name.
sorts No Array<Sort_Condition> The sort conditions.
Sort_Condition
Parameter Required Type Description
direction No String The sort order.

Valid value:

  • asc: Sort in ascending order.
  • desc: Sort in descending order.
property No String The name of the field to sort by.

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<Phone_Page> The search result of phones.
Phone_Page
Parameter Type Description
results Array<Phone> The list of phones that match the search conditions.
totalCount Integer The total number of phones that match the search conditions.
pageSize Integer The number of records per page.
pageNumber Integer The current page number.
Phone
Parameter Type Description
id String The ID of the phone.
mac String The MAC address of the phone.
vendor String The vendor of the phone.
model String The model of the phone.
phoneType String The type of the phone, such as deskphone.
templateId String The ID of the configuration template.
templateName String The name of the configuration template.
status String The registration status of the phone, such as unregistered.
extension String The extension number bound to the phone.
firstAuth Boolean Whether first-time authentication is enabled.
hotDesking Boolean Whether Hot Desking is enabled.
emergencyCallerId String The emergency caller ID.
createdAt String The creation time of the phone.
updatedAt String The last update time of the phone.

Example

Request example

POST /uc-cautop/api/v1/tenant/phones/search-page HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MjU2NDE0MCwiaWF0IjoxNzkyNTQyNTQwLCJqdGkiOiJlYTFhNTY3NS1hNWFhLTQ0ZjYtOWJlYy02YmQzZmY1NmU0YTIiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.roCif8Pv80MWNHH0IQgaDxQS4hx-V-zbU1Zid56qqlAEoSV5Xisv-Rh1tPnWiDqxHUJoMXE8FFDgK_JS2wGBJF6Qz5VD8HMSQFeiHgHlqrKHbOUlf4SiCz8Qww0xX2gsCq0JPS3snT5MrvRIHyyFtMVTNMCe9HgAv_yT1KntyE6GuHA8OTTWTUvfRRkOdX9PgdcRpl3w0sOrPel_HBjUmYAzQm6hYMP-Aj9ygjFCVuqc91Al_6Oc5nuJsue923LbFBzp-2kKKPXGGJIm66xDLBOOgg6NbRcUv30uJuiaYMjJPUX90jNeXLoKuvEVmMdiYKEB02Si3sjtoX6pUHLcLQ
x-tenant-code: jint
Content-Type: application/json
{
  "pageNumber": 1,
  "pageSize": 10
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "ec77c2ac109695d4a0564b3921fa2de1",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "results": [
      {
        "id": "371093131491667968",
        "mac": "AA:6A:D8:07:E9:CC",
        "vendor": "Fanvil",
        "model": "H6W",
        "status": "unregistered",
        "extension": "1000",
        "adminPassword": "01hzudP1Qj",
        "templateName": "ee",
        "firstAuth": false,
        "hotDesking": false,
        "createdAt": "1792542697",
        "phoneType": "deskphone",
        "handsets": [],
        "handsetTotal": 0,
        "templateId": "363237944809508864",
        "userId": "338136731335409664",
        "firstName": "Leo",
        "lastName": "Ball",
        "ownerDisplay": "Service Provider",
        "ownerType": "admin",
        "ownerId": "3076913644915998720"
      },
      {
        "id": "371093126764687360",
        "mac": "AA:6A:D8:07:E7:BB",
        "vendor": "Fanvil",
        "model": "H6W",
        "status": "unregistered",
        "extension": "1000",
        "adminPassword": "admin",
        "templateName": "ee",
        "firstAuth": false,
        "hotDesking": false,
        "createdAt": "1792542695",
        "phoneType": "deskphone",
        "handsets": [],
        "handsetTotal": 0,
        "templateId": "363237944809508864",
        "userId": "338136731335409664",
        "firstName": "Leo",
        "lastName": "Ball",
        "ownerDisplay": "Service Provider",
        "ownerType": "admin",
        "ownerId": "3076913644915998720"
      }
    ],
    "totalCount": 2,
    "pageSize": 10,
    "pageNumber": 1
  }
}