Delete an RPS Server

Deletes a custom RPS (Redirection and Provisioning Service) server. The server is soft-deleted. A server that is currently selected can also be deleted; after deletion, the vendor automatically falls back to the default account.

Request URL

DELETE {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.

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 deleted RPS server.
RPS_Server
Parameter Type Description
id String The unique ID of the RPS server.
name String The name of the RPS server.
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 was selected for the vendor before it was deleted.

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