Help Center> Cloud Phone Host> API Reference> Cloud Phone APIs> Cloud Phone Management> Stopping Cloud Phones
View PDF

Stopping Cloud Phones

Function Description

  • API Name

    PowerOffCloudPhone

  • Function

    Stop cloud phones in batches.

URI

POST /v1/{project_id}/cloud-phone/phones/batch-stop

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.

Request

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    phone_ids

    Yes

    Array of strings

    Specifies the unique identifier of the cloud phone. Obtain it by referring to Querying the Cloud Phones.
  • Example request 
    POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones/batch-stop
{
    "phone_ids": [
        "1234567b8bab40ffb711234cb80d0234",
        "1678567b8bab40f93711234cb80d0764"
    ]
}

Response

  • Response parameters

    Parameter

    Type

    Description

    request_id

    String

    Specifies the request ID, which is unique.

    jobs

    Job structure array

    Specifies the task information. For details, see Table 2.
    Table 2 job field description

    Parameter

    Type

    Description

    phone_id

    String

    Specifies the unique ID of a cloud phone. This parameter is contained in tasks related to cloud phones.

    job_id

    String

    Specifies the unique ID of a task.

    error_code

    String

    Specifies the error code. For details, see Error Codes.

    error_msg

    String

    Specifies the error description.
  • Example response 
    {
    "request_id": "6837531fd3f54550927b930180a706bf",
    "jobs": [{
        "phone_id": "1234567b8bab40ffb711234cb80d0234",
        "job_id": "1564567b8bab40f34711234cb80d0123"
    },
    {
        "phone_id":  "1678567b8bab40f93711234cb80d0764",
        "job_id":  "1564567b8bab40f34711234cb80d5678"
    }]
}

Returned Values

See Returned Values.

Error Codes

See Error Codes.

Parent topic: Cloud Phone Management