Local Area Network Cloud Phone Device API Documentation - Documentation

Original Source: Yuque Help Documentation

Overview

The NestBox Cloud Box provides a local network HTTP API, allowing for the management and control of devices and cloud phone instances through code. It is suitable for:

Automation operation and maintenance scripts
Integration with third-party systems
Batch task scheduling

API Version: V1_0
Base URL: http://<device IP>:3001/api/1_0

Constructing Requests

const HTTP = require('http');

const base_url = 'http://x.x.x.x:3001/api/1_0';

// Example: Get device information
const api = base_url + '/systeminfo';
HTTP.get(api, function(err, res) {
  // Handle response
});

Replace x.x.x.x with the actual IP address of the Cloud Box device on the local network.

API List

GET /systeminfo

Function: Obtain basic device information
Authorization Required: No

Response Example:

{
  "code": 0,
  "data": {
    "device_id": "nestbox-001",
    "model": "NestBox Pro",
    "android_version": "12",
    "cpu_usage": 23.5,
    "memory_total": 8192,
    "memory_used": 3421,
    "storage_total": 128000,
    "storage_used": 45320
  }
}

GET /get_container_list

Function: Obtain a list of all current cloud phone instances
Authorization Required: No

Response Example:

{
  "code": 0,
  "data": [
    {
      "id": "container-001",
      "name": "Cloud Phone 01",
      "status": "running",
      "ip": "172.16.0.101",
      "port": 5555,
      "created_at": "2025-04-01T10:00:00Z"
    }
  ]
}

POST /start_container

Function: Start a specified cloud phone instance
Authorization Required: Yes (token required)

Request Parameters:

Parameter	Type	Required	Description
`container_id`	string	Yes	Instance ID
`token`	string	Yes	Administrator auth token

Request Example:

const options = {
  hostname: 'x.x.x.x',
  port: 3001,
  path: '/api/1_0/start_container',
  method: 'POST',
  headers: { 'Content-Type': 'application/json' }
};

const body = JSON.stringify({
  container_id: 'container-001',
  token: 'your-admin-token'
});

POST /stop_container

Function: Stop a specified cloud phone instance
Parameters: Same as /start_container

GET /container_info

Function: Obtain detailed information about a single instance
Parameters:

Parameter	Type	Required	Description
`container_id`	string	Yes	Instance ID

Error Code Descriptions

code	Meaning
`0`	Success
`401`	Unauthorized (missing token)
`404`	Instance does not exist
`500`	Internal server error