Add an RPS Server

Creates a custom RPS (Redirection and Provisioning Service) server for a phone vendor.

Request URL

POST {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.
Body parameters
Parameter Required Type Description
name Yes String The name of the RPS server, which must be unique within the management domain. Maximum 127 characters.
vendor Yes String The phone vendor. Only the vendors that support a custom RPS server are accepted.
description No String The description of the RPS server. Maximum 1024 characters.
username Yes String The username of the vendor RPS platform account.
password Yes String The password of the vendor RPS platform account. The value can be plaintext or an RSA-JWE ciphertext. After decryption, the length must be between 1 and 127 characters. The password is stored encrypted and is not returned by other interfaces.

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 created 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).