Get a Phone RPS PIN
Gets the RPS PIN of a phone of the current tenant. The API calls the vendor RPS API synchronously to fetch the latest value and writes it back to the database.
Request URL
GET {base_url}/uc-cautop/api/v1/tenant/phones/{id}/rps-pinRequest 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.
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.
|
| 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_Pin_Result> | The RPS PIN of the phone. |
- Rps_Pin_Result
-
Parameter Type Description id String The ID of the phone. rpsPin String The RPS PIN of the phone.