Stopping Cloud Phones

Function

Stopping cloud phones

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project 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_ids	Yes	Array of strings	Specifies the cloud phone ID list.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the unique request ID.
jobs	Array of PhoneJob objects	Indicates the task information.

**Table 5** PhoneJob
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.
error_msg	String	Specifies the error message.

Example Requests

Stopping cloud phones

POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones/batch-stop

{
  "phone_ids" : [ "1234567b8bab40ffb711234cb80d0234", "1678567b8bab40f93711234cb80d0764" ]
}

Example Responses

Status code: 200

{
  "request_id" : "6837531fd3f54550927b930180a706bf",
  "jobs" : [ {
    "phone_id" : "1234567b8bab40ffb711234cb80d0234",
    "job_id" : "1564567b8bab40f34711234cb80d0123"
  }, {
    "phone_id" : "1678567b8bab40f93711234cb80d0764",
    "job_id" : "1564567b8bab40f34711234cb80d5678"
  } ]
}