Editing the Name of a Cloud Phone

Function

This API is used to modify the cloud phone name based on the cloud phone ID.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

PUT /v1/{project_id}/cloud-phone/phones/{phone_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.
phone_id	Yes	String	Specifies the cloud phone ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It can be obtained by calling an Identity and Access Management (IAM) API. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
phone_name	Yes	String	Specifies the cloud phone name. The name can contain a maximum of 60 characters, including letters, digits, hyphens (-), and underscores (_).

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID, which is unique.

Example Requests

Editing the name of a cloud phone

PUT https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones/1564567b8bab40f34711234cb80d8574

{
  "phone_name" : "newName"
}

Example Responses

Status code: 200

{
  "request_id" : "135d898e69344a13925a0899e1a4ac53"
}

Status Codes

Status Code	Description
200	OK

Error Codes

See Error Codes.

Parent topic: Cloud Phones

Previous topic: Stopping Cloud Phones

Next topic: Updating Properties of Cloud Phones

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot