Query RPS Servers

Retrieves the RPS (Redirection and Provisioning Service) servers grouped by phone vendor, including the currently selected server of each vendor.

Request URL

GET {base_url}/uc-cautop/api/v1/rps-servers

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.

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_List> The list of RPS servers grouped by vendor.
RPS_Server_List
Parameter Type Description
vendors Array<Vendor_Group> The vendor groups. The list always contains a fixed set of vendors, including the vendors that have no custom RPS server configured.
Vendor_Group
Parameter Type Description
vendor String The identifier of the vendor.
displayName String The display name of the vendor.
selectedServerId String The ID of the custom RPS server that is currently selected for the vendor. If the value is empty or omitted, the default account is used.
servers Array<RPS_Server> The custom RPS servers created under the vendor, sorted by name in ascending order.
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).