Get a Tenant Phone

Gets the details of a phone of the current tenant.

Request URL

GET {base_url}/uc-cautop/api/v1/tenant/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 ID of the phone. You can obtain the ID using the Search Tenant Phones interface.

Query parameters


Parameter	Required	Type	Description
detail	No	Boolean	Whether to return the detail data. true returns the account list and the schema, and false returns only the basic data.

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_Detail>	The details of the phone.

Phone_Detail


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.
configJson	String	The custom configuration values in JSON format.
schemaJson	String	The configuration schema in JSON format, which is returned when detail is true.
firstAuth	Boolean	Whether first-time authentication is enabled.
hotDesking	Boolean	Whether Hot Desking is enabled.
emergencyCallerId	String	The emergency caller ID.
status	String	The registration status of the phone.
adminPassword	String	The administrator password of the phone.
accounts	Array<Object>	The list of bound accounts, which is returned when detail is true.
version	String	The firmware version of the phone.
createdAt	String	The creation time of the phone.
updatedAt	String	The last update time of the phone.

Example

Request example

GET /uc-cautop/api/v1/tenant/phones/371093126764687360?detail=true 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

Response example

HTTP/1.1 200 OK
{
  "requestId": "2ac3df24c45d1c8e14a7750535c3929e",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "id": "371093126764687360",
    "mac": "AA:6A:D8:07:E7:BB",
    "vendor": "Fanvil",
    "model": "H6W",
    "phoneType": "deskphone",
    "templateId": "363237944809508864",
    "configJson": "(schema JSON omitted)",
    "firstAuth": false,
    "hotDesking": false,
    "status": "unregistered",
    "version": 1,
    "createdAt": "1792542695",
    "updatedAt": "1792542696",
    "adminPassword": "f4B1DPxeQi",
    "accounts": [],
    "schemaJson": "(schema JSON omitted)",
    "templateName": "ee"
  }
}