Download a Tenant Phone Configuration

Downloads the configuration file of a phone of the current tenant.

Request URL

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

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<Config_Download_Result> The configuration download result.
Config_Download_Result
Parameter Type Description
filename String The name of the configuration file.
downloadResourceUrl String The download URL of the configuration file.