Update a Tenant Phone

Updates a phone of the current tenant.

Request URL

PUT {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.
Body parameters
Parameter Required Type Description
templateId No String The ID of the configuration template to switch to.
emergencyCallerId No String The emergency caller ID. The value must be within the range configured in the tenant emergency number settings.
userId No Integer The ID of the user whose extension is bound to the phone. This parameter is mutually exclusive with accounts.
configJson No String The custom configuration values to update.
accounts No Array<Account_Item> The list of accounts to bind to the phone lines. This parameter is mutually exclusive with userId.
Account_Item
Parameter Required Type Description
lineIndex No Integer The line index or handset number of the phone. For DECT phones, this parameter specifies the handset; for regular phones, the default value is 1.
userId No Integer The ID of the user whose extension is bound to this line. You can obtain the ID using the Get Bindable Extensions 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<Phone> The phone after the update.
Phone
Parameter Type Description
id String The ID of the phone.