Get a Phone

Request URL

GET {base_url}/uc-cautop/api/v1/phones/{id}

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.

Path parameters

Parameter	Required	Type	Description
id	Yes	String	The phone ID. You can obtain the ID using the Search Phones interface.

Query parameters

Parameter	Required	Type	Description
detail	No	Boolean	Whether to return detailed data: - true: Return the account list and the configuration schema. - false: Return basic data only.

Response parameters

Phone

Parameter	Type	Description
id	String	The unique identifier of the phone.
ownerType	String	The owner type of the phone: - admin: Administrator. - reseller: Reseller.
ownerId	String	The ID of the owner.
mac	String	The MAC address of the phone, in the format AA:BB:CC:DD:EE:FF or AA-BB-CC-DD-EE-FF.
vendor	String	The vendor identifier of the phone, for example Yealink, Fanvil, Grandstream.
model	String	The model of the phone, for example T54W, X5U.
phoneType	String	The device type of the phone: - deskphone: Desk phone. - conferencephone: Conference phone. - dect: DECT wireless phone.
templateId	String	The ID of the configuration template that the phone uses.
configJson	String	The custom configuration values of the phone in JSON format, which override the template default values.
firstAuth	Boolean	Whether first-time authentication is enabled. If enabled, the phone needs authentication when it connects for the first time.
hotDesking	Boolean	Whether Hot Desking is enabled. If enabled, users can temporarily log in to their extensions on the phone.
emergencyCallerId	String	The emergency caller number of the phone, which identifies the physical location of the phone for emergency calls.
status	String	The registration status of the phone: - registered: The phone is registered and online. - unregistered: The phone is unregistered or offline.
tenantCode	String	The code of the associated tenant. An empty value indicates that the phone is not assigned to a tenant.
version	Integer	The version number for optimistic locking, which increments on each update.
createdAt	String	The time when the phone was created, in Unix timestamp format (seconds).
updatedAt	String	The time when the phone was last updated, in Unix timestamp format (seconds).
adminPassword	String	The administrator password of the phone, which is used to log in to the phone web interface.
hotDeskingStatus	String	The Hot Desking status of the phone: - guest_in: A guest is logged in. - guest_out: The guest is logged out. This parameter is returned only when hotDesking is true.
accounts	Array<Account>	The list of accounts bound to the phone, sorted by line index.
schemaJson	String	The configuration schema from the associated template, which is used to render the configuration form.
ownerEmail	String	The email address of the owner. This parameter is empty if the query fails.
extension	String	The extension number currently bound to the phone. This parameter is returned only when a single line is bound. For multiple line bindings, see accounts.
userId	String	The ID of the currently bound user. This parameter is returned only when a single line is bound. For multiple line bindings, see accounts.
templateName	String	The name of the associated configuration template.

Account

Parameter	Type	Description
id	String	The ID of the account.
phoneId	String	The ID of the phone that the account belongs to.
lineIndex	Integer	The line index, starting from 1, which corresponds to the physical line number of the phone. The host account of a Hot Desking phone has a line index of 0.
accountType	String	The account type: - extension: Extension account. - host: Host account of a Hot Desking phone.
extension	String	The extension number bound to the account. This parameter is empty for a host account.
createdAt	String	The time when the account was created, in Unix timestamp format (seconds).
updatedAt	String	The time when the account was last updated, in Unix timestamp format (seconds).
userId	String	The ID of the user that corresponds to the extension. 0 for a host account.

Example

Request example

GET /uc-cautop/api/v1/phones/363526076436074496?detail=true HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MDc2MTIyMCwiaWF0IjoxNzkwNzM5NjIwLCJqdGkiOiJiOWY2YTllMC1iNzI1LTQ0MWItOWM4MS0xNTViN2I2MzQzZTEiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.pLZvlI7wJOdlIe2rosP2RgmFghax1RIr5Bx8hM8hNHAcodWeuhl0y6mbm2Rx6HzEIaAqBv51HhtRgJCWUTt8H3Gx7gbGQ-oL-ay5QO8xKWyx9l-o2N9xqoxFnHEVJ1eODMtyZJdi0irq36D95TcDMFLgotKo9TeAr4WrZCelgLyawvyPw8aNpJqNvnc0giI43O8Ov_PjV8VZkQ3UPhWmQEoaLEc1QRCyV546snUuRZd2Ue_wJdW4jHQ5kxSLKq9RXIt-Y3RBweWh4ZALMfSEbOAcg9qzZkA-a_k1c4r2qmYeN1-RS10E7sBmx2KbrQ0JmtfRwzjIfowkZyaIv-5abg
x-tenant-code: jint

Response example

HTTP/1.1 200 OK
{
  "requestId": "3089a39fb1984817ee7159f3066e91dc",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "id": "363526076436074496",
    "ownerType": "admin",
    "ownerId": "3076913644915998720",
    "mac": "AA:BB:99:78:79:0D",
    "vendor": "Fanvil",
    "model": "A10",
    "phoneType": "deskphone",
    "templateId": "315428389935468544",
    "configJson": "{\"var_password\": \"A60SzVZgII\", \"user_password\": \"lTfXLIMLI7\", \"phone_password\": \"BFZ2RO0vlm\"}",
    "firstAuth": false,
    "hotDesking": true,
    "emergencyCallerId": "911",
    "status": "unregistered",
    "tenantCode": "jint",
    "version": 1,
    "createdAt": "1790738570",
    "updatedAt": "1790738570",
    "adminPassword": "BFZ2RO0vlm",
    "hotDeskingStatus": "guest_out",
    "accounts": [
      {
        "id": "363526076465434624",
        "phoneId": "363526076436074496",
        "lineIndex": 0,
        "accountType": "host",
        "createdAt": "1790738570",
        "updatedAt": "1790738570",
        "userId": "0"
      }
    ],
    "schemaJson": "{\"type\": \"object\", \"title\": \"YSDP_Fanvili10S\", \"$schema\": \"http://json-schema.org/draft-07/schema#\", \"properties\": {\"codecs\": {\"type\": \"object\"}, \"general\": {\"type\": \"object\"}, \"preference\": {\"type\": \"object\"}, \"distinctive_ringtone\": {\"type\": \"array\"}}}",
    "ownerEmail": "distributorexample@outlook.com",
    "userId": "0",
    "templateName": "YSDP_Fanvili10S"
  }
}