Update an RPS Server

Updates a custom RPS (Redirection and Provisioning Service) server. The update is partial: parameters that are not specified keep their current values. To clear the description, pass an empty string. The vendor cannot be changed; delete the server and create a new one instead.

Request URL

PUT {base_url}/uc-cautop/api/v1/rps-servers/{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 RPS server. You can obtain the ID using the Query RPS Servers interface.
Body parameters
Parameter Required Type Description
name No String The new name of the RPS server. The value must be non-empty and unique within the management domain, and can contain up to 127 characters.
description No String The new description, up to 1024 characters. An empty string clears the description.
username No String The new username of the vendor RPS platform account.
password No String The new password. An empty value or an omitted parameter keeps the current password. The value can be plaintext or an RSA-JWE ciphertext; after decryption, the length must be between 1 and 127 characters.

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<RPS_Server> The updated RPS server.
RPS_Server
Parameter Type Description
id String The unique ID of the RPS server.
name String The name of the RPS server, which is unique within the management domain.
vendor String

The phone vendor:

  • Yealink
  • Fanvil
  • Snom
  • Htek
  • Gigaset
  • Flyingvoice
  • Polycom
description String The description of the RPS server.
username String The username of the vendor RPS platform account.
selected Boolean

Whether the RPS server is the one currently selected for the vendor.

  • true: The server is selected.
  • false: The server is not selected.
createdAt String The time when the RPS server was created, in Unix timestamp format (milliseconds).