Help Center> Cloud Phone Host> API Reference> Cloud Phone APIs> Cloud Phone Management> Changing the Cloud Phone Name
View PDF

Changing the Cloud Phone Name

Function Description

  • API Name

    UpdatePhoneName

  • Function

    Change the cloud phone name based on the cloud phone ID.

URI

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

For details, see Table 1.
Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

For details about how to obtain the project ID, see Obtaining a Project ID.

phone_id

Yes

String

Specifies the unique identifier of the cloud phone. Obtain it by referring to Querying the Cloud Phones.

Request

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    phone_name

    Yes

    String

    Specifies the cloud phone name.

    The value can contain a maximum of 60 characters, including lowercase letters, uppercase letters, digits, hyphens (-), and underscores (_).
  • Example request 
    PUT https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones/1564567b8bab40f34711234cb80d8574 
{ 
    "phone_name": "newName" 
}

Response

  • Parameter description

    Parameter

    Type

    Description

    request_id

    String

    Specifies the request ID, which is unique.
  • Example response 
    {
    "request_id": "135d898e69344a13925a0899e1a4ac53"  
}

Returned Values

See Returned Values.

Error Codes

See Error Codes.

Parent topic: Cloud Phone Management