Function Description

• API Name

  RestartCloudPhone

• Function

  Restart cloud phones in batches or start cloud phones. This API is an asynchronous API. You can call APIs in Querying the Task Execution Status and Querying the Task Execution Status List to query the task execution result.

URI

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

Request

• Request parameters

  Parameter	Mandatory	Type	Description
  phones	Yes	Array of objects	Specifies the information about the cloud phone to be restarted. For details, see Table 2.
  image_id	No	String	Specifies the ID of the image to be updated.

  Table 2 phones field description

  Parameter	Mandatory	Type	Description
  phone_id	Yes	String array	Specifies the cloud phone ID.
  property	No	jsonString	Specifies the cloud phone attribute list. For details, see Cloud Phone Attribute List.

• Example request

  POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones/batch-restart 
  {
      "phones": [
          {
              "phone_id": "a7f3a1c5258347d6b6f1def79e11f2bc",
              "property": "{\"phone_num\":\"13666666666\",\"imsi\":\"460021624617113\",\"iccid\":\"42947a38410b137c\",\"wifi_name\":\"test_wifi\"}"
          },
          {
              "phone_id": "1678567b8bab40f93711234cb80d0764",
              "property": "{\"phone_num\":\"13666666666\",\"imsi\":\"460021624617113\",\"iccid\":\"42947a38410b137c\",\"wifi_name\":\"test_wifi\"}"
          }
      ],
      "image_id": "1564567b8bab40f34711234cb80d8574"
  }

Response

• Response parameters

  Parameter	Type	Description
  request_id	String	Specifies the request ID, which is unique.
  jobs	Array of objects	Specifies the task information. For details, see Table 3.

  Table 3 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",
              "error_code": "CPS.0004",
              "error_msg": "Parameter: phone_id is invalid."
          }
      ]
  }

Returned Values

See Returned Values.

Error Codes

See Error Codes.