Geelark OpenAPI

https://telegra.ph/Geelark-OpenAPI--Cloud-Phone-Creation-12-17
Admin
Geelark OpenAPI is a cloud phone creation service that enables batch provisioning of Android virtual...
Tokens:2,573
Snippets:30
Trust Score:5.9
Update:21 hours ago
Show doc for...
Tokens:
Raw
### Request Example for Creating a Cloud Phone

Source: https://telegra.ph/Geelark-OpenAPI--Cloud-Phone-Creation-12-17

JSON payload for the POST /open/v1/phone/addNew endpoint. Shows a single cloud phone with proxy, language, group, tags, and note. Uses Android 12 and on-demand billing.

```json
{
  "mobileType": "Android 12",
  "chargeMode": 0,
  "data": [
    {
      "profileName": "myPhone",
      "proxyInformation": "socks5://AD00xx004:3000xxx0002@100.200.200.100:30000",
      "mobileLanguage": "default",
      "profileGroup": "myGroup",
      "profileTags": ["myTag"],
      "profileNote": "remark"
    }
  ]
}
```

--------------------------------

### POST /open/v1/phone/addNew

Source: https://telegra.ph/Geelark-OpenAPI--Cloud-Phone-Creation-12-17

Creates one or more cloud phones (Android virtual devices) with isolated profiles. Supports single creation on Basic plan and batch creation up to 100 per request on Pro plan.

```APIDOC
## POST /open/v1/phone/addNew

### Description
Creates one or more cloud phones (Android virtual devices) with isolated profiles. Supports single creation on Basic plan and batch creation up to 100 per request on Pro plan.

### Method
POST

### Endpoint
https://openapi.geelark.com/open/v1/phone/addNew

### Parameters
#### Request Body
- **mobileType** (string) - Required - Android OS version of the cloud phone. Supported values: Android 9, Android 10, Android 11, Android 12, Android 13, Android 14, Android 15.
- **chargeMode** (integer) - Optional - Billing mode. 0 = on-demand (default), 1 = monthly.
- **region** (string) - Optional - Datacenter region. Values: cn, sgp. Default: cn.
- **data** (array[EnvRowApi]) - Required - Array of cloud phone environment definitions. Maximum 100 items per request.

#### EnvRowApi Object
- **profileName** (string) - Required - Human-readable cloud phone name.
- **proxyInformation** (string) - Optional - Proxy connection string. Supported types: http, https, socks5.
- **refreshUrl** (string) - Optional - URL used to refresh proxy IP.
- **proxyNumber** (integer) - Optional - Serial number of a previously added proxy.
- **dynamicProxy** (string) - Optional - Reference to a saved dynamic proxy provider. Supported values: IPIDEA, IPHTML, kookeey, Luminati (BrightData), rolaip, Proxyma, DECODO, NodeMaven, IPIDEAMobile, kookeeyMobile.
- **dynamicProxyLocation** (string) - Optional - Country code for dynamic proxy location. Required if dynamicProxy is set.
- **mobileLanguage** (string) - Optional - Language setting. Values: baseOnIP (derived from proxy), default (English, default).
- **profileGroup** (string) - Optional - Profile group name. Created automatically if it does not exist.
- **profileTags** (array[string]) - Optional - Profile tags. Created automatically if they do not exist.
- **profileNote** (string) - Optional - Free-form remark.
- **surfaceBrandName** (string) - Optional - Device brand. Must match the selected Android version. Must be used together with surfaceModelName.
- **surfaceModelName** (string) - Optional - Device model. Must match the selected Android version.
- **netType** (integer) - Optional - Network type. 0 = Wi-Fi, 1 = Mobile network. Only supported on Android 12/13/15. Default: Mobile network.
- **phoneNumber** (string) - Optional - Phone number assigned to the cloud phone. Automatically generated if omitted.

### Request Example
{
  "mobileType": "Android 12",
  "chargeMode": 0,
  "data": [
    {
      "profileName": "myPhone",
      "proxyInformation": "socks5://AD00xx004:3000xxx0002@100.200.200.100:30000",
      "mobileLanguage": "default",
      "profileGroup": "myGroup",
      "profileTags": ["myTag"],
      "profileNote": "remark"
    }
  ]
}

### Response
#### Success Response (200)
- **traceId** (string) - Trace identifier.
- **code** (integer) - Result code. 0 indicates success.
- **msg** (string) - Result message.
- **data** (object) - Response data.

#### Response Data
- **totalAmount** (integer) - Total requested cloud phones.
- **successAmount** (integer) - Successfully created.
- **failAmount** (integer) - Failed creations.
- **details** (array) - Per-phone creation results.

#### details[] Object
- **index** (integer) - Creation index.
- **code** (integer) - Result code (0 = success).
- **msg** (string) - Result message.
- **id** (string) - Cloud phone ID.
- **profileName** (string) - Cloud phone name.
- **envSerialNo** (string) - Cloud phone serial number.
- **equipmentInfo** (object) - Device hardware metadata.

#### Response Example
{
  "traceId": "string",
  "code": 0,
  "msg": "success",
  "data": {
    "totalAmount": 0,
    "successAmount": 0,
    "failAmount": 0,
    "details": [
      {
        "index": 0,
        "code": 0,
        "msg": "string",
        "id": "string",
        "profileName": "string",
        "envSerialNo": "string",
        "equipmentInfo": {}
      }
    ]
  }
}
```

--------------------------------

### Top-Level Response Structure

Source: https://telegra.ph/Geelark-OpenAPI--Cloud-Phone-Creation-12-17

JSON structure of the API response. The 'code' field equals 0 to indicate success.

```json
{
  "traceId": "string",
  "code": 0,
  "msg": "success",
  "data": { ... }
}
```
Tokens:
Raw