Get a Phone Account Config

Gets the extension-level configuration view of a phone line, including the template schema and the bound configuration.

Request URL

GET {base_url}/uc-cautop/api/v1/tenant/phones/{phoneId}/config

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
phoneId Yes String The ID of the phone. You can obtain the ID using the Search Tenant Phones interface.
Query parameters
Parameter Required Type Description
lineIndex No Integer The line index or handset number. For DECT phones, this parameter specifies the handset; for regular phones, the default value is 1.

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<Account_Config> The configuration view of the phone line.
Account_Config
Parameter Type Description
accountId String The ID of the phone account. The value 0 indicates that no account is bound.
phoneId String The ID of the phone.
lineIndex Integer The line index or handset number.
extension String The extension number bound to the line.
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.
templateName String The name of the configuration template.
schemaJson String The configuration schema in JSON format.
configJson String The bound configuration values in JSON format.

Example

Request example

GET /uc-cautop/api/v1/tenant/phones/371093126764687360/config 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": "d5aed275e10ade28d8501c9f8f6aa87b",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "accountId": "0",
    "phoneId": "371093126764687360",
    "lineIndex": 1,
    "mac": "AA:6A:D8:07:E7:BB",
    "vendor": "Fanvil",
    "model": "H6W",
    "templateName": "ee",
    "schemaJson": "(schema JSON omitted)",
    "configJson": "(schema JSON omitted)",
    "phoneType": "deskphone"
  }
}