Preview a Custom Template Zip File
Previews a custom vendor template zip file. The API downloads the zip file by resource ID, parses it, and returns the schema, template content, and linekey configurations.
Request URL
GET {base_url}/uc-cautop/api/v1/phone-templates/custom/zip-previewRequest parameters
- Headers
-
Parameter Required Type Description Authorization Yes String The access token used for authentication. Format: Bearer
{access_token}.x-tenant-code No String The tenant name. Note: You can obtain tenant name using the Query Tenants interface.
- Query parameters
-
Parameter Required Type Description resourceId No String The resource ID of the zip file, which must be in the CONFIRMED status.
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.
|
| 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<Zip_Preview_Result> | The parsed content of the zip file. |
- Zip_Preview_Result
-
Parameter Type Description schemaJson String The content of schema.json (a JSON string). templateContent String The main template content. linekeys Object The linekey configurations, keyed by phone model. phoneType String The type of the device:
deskphoneconferencephonedect
supportedModels Array<String> The list of phone models supported by the template.