Get a Firmware

Retrieves the details of a firmware.

Request URL

GET {base_url}/uc-cautop/api/v1/firmwares/{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 firmware ID. You can obtain the ID using the Search Firmwares 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<Firmware> The details of the firmware.
Firmware
Parameter Type Description
id String The unique identifier of the firmware.
ucId String The ID of the UC domain that the firmware belongs to.
vendor String The vendor identifier of the phone, for example Yealink, Fanvil, Grandstream.
model String The model of the phone, for example T54W, V65.
firmwareVersion String The firmware version, for example 97.0.0.1.
fileName String The original file name of the firmware file.
fileResourceId String The ID of the file in the resource service.
fileSize String The size of the file, in bytes.
remark String The remark of the firmware.
createdAt String The time when the firmware was created, in Unix timestamp format (seconds).
updatedAt String The time when the firmware was last updated, in Unix timestamp format (seconds).
ownerType String The owner type of the firmware: - admin: Administrator. - reseller: Reseller.
ownerId String The ID of the owner.
ownerEmail String The email address of the owner's primary account.
assignTo Object<Assign_To> The assignment configuration of the firmware.
Assign_To
Parameter Type Description
myTenantAssignment Object<My_Tenant_Assignment> The assignment configuration for the tenants directly under the administrator.
resellerAssignment Object<Reseller_Assignment> The assignment configuration for resellers.
My_Tenant_Assignment
Parameter Type Description
enabled Boolean Whether the firmware is assigned to tenants.
scope String The assignment scope: - all: The firmware is visible to all the tenants directly under the administrator. - specific: The firmware is visible only to the specified tenants.
tenantCodes Array<String> The codes of the tenants. This parameter takes effect only when scope is specific.
Reseller_Assignment
Parameter Type Description
enabled Boolean Whether the firmware is assigned to resellers.
scope String The assignment scope: - all: The firmware is visible to all the resellers. - specific: The firmware is visible only to the specified resellers.
resellers Array<Reseller_Assign_Item> The list of reseller assignments. This parameter takes effect only when scope is specific.
excludedResellerIds Array<String> The IDs of the excluded resellers. This parameter takes effect only when scope is all.
Reseller_Assign_Item
Parameter Type Description
resellerId String The user ID of the reseller.
tenantScope String The tenant scope under the reseller: - all: The firmware is visible to all the tenants of the reseller. - specific: The firmware is visible only to the specified tenants. - none: The firmware is visible only to the reseller itself.
tenantCodes Array<String> The codes of the tenants. This parameter takes effect only when tenantScope is specific.