Local API

The PhoneGrid API offers a comprehensive and developer-friendly RESTful interface that empowers you to programmatically manage browser profiles, cloud phones, and related resources—enabling seamless automation, scalability, and control.The PhoneGrid local API runs on your machine and is accessible at:127.0.0.1:30000

Base URL

http://127.0.0.1:30000PhoneGrid Local endponint

Browser Profile

Start browser profile

POST/api/env/start

Used to start the profile; you must specify the profile ID. After successful startup, you can obtain the profile debug interface for executing Selenium and Puppeteer automation. For Selenium, use the WebDriver matching the corresponding kernel version. The WebDriver path can be retrieved from the response after profile startup.

Stop browser profile

POST/api/env/close

Closes the specified environment. Requires specifying the environment ID.

Quick create browser profile

POST/api/env/create/quick

Advanced create browser profile

POST/api/env/create/advanced

Modify browser profile

POST/api/env/update

Delete browser profile

POST/api/env/removeToRecycleBin/batch

Get a list of browser profiles

POST/api/env/page

Get browser profile details

POST/api/env/detail

Get a list of browser kernel versions

GET/api/env/advanced/ua/versions

Get browser profile UA

POST/api/env/advanced/ua/get

Get resolution

POST/api/env/base/resolution/list

Get configurable platforms

GET/api/system/platform/list

Get browser security lock status

POST/api/env/lock/query

Get a list of timezone and language

POST/api/env/base/list

Clear local profile cache

POST/api/env/removeLocalCache

Clean Environment Cloud Cache

POST/api/env/cache/cleanCloud

Cleans environment cloud cookies and other data (LocalStorage, IndexedDB, extensions and their data)

Refresh fingerprint

POST/api/env/fingerprint/refresh

Get the browser profile running status

POST/api/env/status

Get screen list

POST/api/env/getAllScreen

Used to retrieve information of all monitors. No request parameters required.

One-click adaptive window arrangement

POST/api/env/arrangeWindows

Used to arrange opened profiles with one click. Requires at least one profile to be open.

Batch modify profiles group

POST/api/env/setGroup/batch

Used to batch modify the group information of profiles. Creates a new group if the group name does not exist.

Batch modify profiles proxy

POST/api/env/setProxy/batch

Batch modify profile remark

POST/api/env/setRemark/batch

Close all opened prifile

POST/api/env/closeAll

Closes all opened prifile windows. No request parameters required.

Get process IDs of all opened profiles

POST/api/env/getAllProcessIds

Gets the process IDs of all opened profiles. No request parameters required. Requires PhoneGrid application version 2.49.0 or higher.

Get remote debugging info for all opened profiles

POST/api/env/getAllDebugInfo

Gets remote debugging port and other information for all opened profiles. No request parameters required.

Get phone model list

POST/api/env/base/mobile/devices

Cloud Phone

Getting a list of cloud phone profiles

POST/api/cloudphone/page

Creating a Cloud Phone Profile

POST/api/cloudphone/create

Startup cloud phone

POST/api/cloudphone/powerOn

Shut down the cloud phone

POST/api/cloudphone/powerOff

Modify the cloud phone profile

POST/api/cloudphone/edit/batch

Delete cloud phone profile

POST/api/cloudphone/delete/batch

One-click new cloud phone

POST/api/cloudphone/newMachine

Cloud phone details

POST/api/cloudphone/info

Query brand & model list

POST/api/cloudphone/brand/models

Query available brand & model list for given Android version

Update cloud phone ADB status

POST/api/cloudphone/updateAdb

Execute shell command

POST/api/cloudphone/exeCommand

Cloud Phone/File Management

Uploading files

POST/api/cloudphone/uploadFile

Get temporary upload file URL

POST/api/cloudphone/upload/file/signedUrl

Upload temporary files through this interface, and the system will automatically delete them after 7 days

Upload file for url

POST/api/cloudphone/upload/file

Upload file result

POST/api/cloudphone/upload/file/result

File download

POST/api/cloudphone/download

File download result

POST/api/cloudphone/download/result

Set Keybox

POST/api/cloudphone/setKeyBox

Cloud Phone/App Management

Install app on cloud phone

POST/api/cloudphone/app/install

Get APP application list

POST/api/cloudphone/app/page

Fetch APP application list

Query installed apps list

POST/api/cloudphone/app/installedList

Query list of installed apps on a cloud phone

Launch APP

POST/api/cloudphone/app/start

Launch an installed app on the cloud phone

Restart APP

POST/api/cloudphone/app/restart

Stop APP

POST/api/cloudphone/app/stop

Uninstall APP

POST/api/cloudphone/app/uninstall

Set Hide Accessibility App

POST/api/cloudphone/app/setHideAccessibilityApp

Supports only Android 13,Android 14, Android15A, Android16

Cloud Phone/Schedules management

Get market template pages

POST/api/cloudphone/rpa/template/market/page

Query Schedules market template, template name supports fuzzy query

Get Personal template pages

POST/api/cloudphone/rpa/template/personal/page

Query Schedules market template, template name supports fuzzy query

Get a schedules list

POST/api/cloudphone/rpa/task/page

Creating a schedule

POST/api/cloudphone/rpa/task/save

Save cloud phone scheduled task. templateParameter Parameter Specification 1. __Parameter Source__ Parameter keys must be extracted from the `parameter` field returned by the following APIs: - Get market template pages - Get Personal template pages 2. __Data Structure__ - Submit parameters in JSON object format: `{"key1": "value1", "key2": "value2"}` - Final parameter values must be deserialized according to business logic before use 3. __Common Type Parameters__ For the following parameter types, pass values directly in the corresponding format: - string: `{"name": "John"}` - decimal / number: `{"amount": 100.50}` - boolean: `{"enabled": true}` 4. __Media Type Parameters__ For media parameters such as image (pic) or video (video), in addition to basic information, a fixed key `"__Extra__"` must be included. Example format: ```json { "__Extra__": { "pic": { "name": "pic_name", "size": 204800 }, "video": { "name": "video_name", "size": 204800000 } }, "pic": "https://get.phonegrid.com/prod/cloudPhoneTaskVideo/1556061681934880/1c62314c7e2b4d298abe8d5452d7c050/test.png", "video": "https://get.phonegrid.com/pre/cloudPhoneTaskVideo/1542431036481556/4c4fed83685345ae8f1505fbe0c2f123/baby.mp4" } ``` 5. __Parameter Configuration Example__ The following example demonstrates how to configure the `templateParameter` parameter when saving a plan using a market template: - __Step 1: Retrieve Template Parameters__ Call the Market Template API: `GET /api/cloudphone/rpa/template/market/page` Extract the `parameter` field from the response, for example: ```json "parameter": "{\"videoDownloadUrl\":{\"type\":\"video\",\"extra\":{\"name\":\"Select Video\",\"type\":\"video\",\"required\":true,\"defaultValue\":{\"enabled\":false},\"index\":1,\"sizeLimit\":{\"value\":200,\"unit\":\"MB\"},\"formatType\":[\"mp4\",\"mov\"]}},\"videoDescription\":{\"type\":\"string\",\"extra\":{\"name\":\"Video Caption\",\"type\":\"string\",\"required\":false,\"charValid\":{\"enabled\":true,\"value\":1000},\"multiline\":{\"enabled\":true,\"value\":3},\"defaultValue\":{\"enabled\":false},\"index\":2}},\"coverUrl\":{\"type\":\"image\",\"extra\":{\"name\":\"Cover Image\",\"type\":\"image\",\"required\":false,\"defaultValue\":{\"enabled\":false},\"index\":3,\"sizeLimit\":{\"value\":5,\"unit\":\"MB\"},\"formatType\":[\"jpg\",\"png\",\"jpeg\"]}},\"enableAIGC\":{\"type\":\"boolean\",\"extra\":{\"name\":\"AI Label\",\"type\":\"boolean\",\"required\":false,\"defaultValue\":{\"enabled\":false},\"index\":4}},\"productId\":{\"type\":\"string\",\"extra\":{\"name\":\"Product ID\",\"type\":\"string\",\"required\":false,\"charValid\":{\"enabled\":true,\"value\":50},\"placeholder\":\"Product ID only supports digits, with a maximum of 50 characters.\",\"defaultValue\":{\"enabled\":false},\"index\":5}},\"productTitle\":{\"type\":\"string\",\"extra\":{\"name\":\"Product Title\",\"type\":\"string\",\"required\":false,\"charValid\":{\"enabled\":true,\"value\":30},\"defaultValue\":{\"enabled\":false},\"index\":6}},\"getLeads\":{\"type\":\"boolean\",\"extra\":{\"name\":\"Get Leads\",\"type\":\"boolean\",\"required\":false,\"defaultValue\":{\"enabled\":false},\"index\":7}},\"comment\":{\"type\":\"string\",\"extra\":{\"name\":\"Comment\",\"type\":\"string\",\"required\":false,\"charValid\":{\"enabled\":true,\"value\":200},\"multiline\":{\"enabled\":true,\"value\":3},\"defaultValue\":{\"enabled\":false},\"index\":8}}}" ``` - __Step 2: Build the Parameter JSON__ Construct the JSON object according to the parameter requirements: ```json { "__Extra__": { "videoDownloadUrl": { "name": "video_name.mp4", "size": 204800000 } }, "videoDownloadUrl": "https://get.phonegrid.com/pre/cloudPhoneTaskVideo/1542431036481556/4c4fed83685345ae8f1505fbe0c2f123/baby.mp4" } ``` - __Step 3: Escape the JSON String__ Convert the JSON object into an escaped string format: ```json "{\"__Extra__\": {\"videoDownloadUrl\": {\"name\": \"video_name.mp4\",\"size\": 204800000}},\"videoDownloadUrl\": \"https://get.phonegrid.com/pre/cloudPhoneTaskVideo/1542431036481556/4c4fed83685345ae8f1505fbe0c2f123/baby.mp4\"}" ``` - __Step 4: API Call__ Pass the escaped string as the value of the `templateParameter` parameter to the target API.

Creating a once schedule

POST/api/cloudphone/rpa/onceTask/save

Save cloud phone once scheduled task. templateParameter Parameter Specification 1. __Parameter Source__ Parameter keys must be extracted from the `parameter` field returned by the following APIs: - Get market template pages - Get Personal template pages 2. __Data Structure__ - Submit parameters in JSON object format: `{"key1": "value1", "key2": "value2"}` - Final parameter values must be deserialized according to business logic before use 3. __Common Type Parameters__ For the following parameter types, pass values directly in the corresponding format: - string: `{"name": "John"}` - decimal / number: `{"amount": 100.50}` - boolean: `{"enabled": true}` 4. __Media Type Parameters__ For media parameters such as image (pic) or video (video), in addition to basic information, a fixed key `"__Extra__"` must be included. Example format: ```json { "__Extra__": { "pic": { "name": "pic_name", "size": 204800 }, "video": { "name": "video_name", "size": 204800000 } }, "pic": "https://get.phonegrid.com/prod/cloudPhoneTaskVideo/1556061681934880/1c62314c7e2b4d298abe8d5452d7c050/test.png", "video": "https://get.phonegrid.com/pre/cloudPhoneTaskVideo/1542431036481556/4c4fed83685345ae8f1505fbe0c2f123/baby.mp4" } ``` 5. __Parameter Configuration Example__ The following example demonstrates how to configure the `templateParameter` parameter when saving a plan using a market template: - __Step 1: Retrieve Template Parameters__ Call the Market Template API: `GET /api/cloudphone/rpa/template/market/page` Extract the `parameter` field from the response, for example: ```json "parameter": "{\"videoDownloadUrl\":{\"type\":\"video\",\"extra\":{\"name\":\"Select Video\",\"type\":\"video\",\"required\":true,\"defaultValue\":{\"enabled\":false},\"index\":1,\"sizeLimit\":{\"value\":200,\"unit\":\"MB\"},\"formatType\":[\"mp4\",\"mov\"]}},\"videoDescription\":{\"type\":\"string\",\"extra\":{\"name\":\"Video Caption\",\"type\":\"string\",\"required\":false,\"charValid\":{\"enabled\":true,\"value\":1000},\"multiline\":{\"enabled\":true,\"value\":3},\"defaultValue\":{\"enabled\":false},\"index\":2}},\"coverUrl\":{\"type\":\"image\",\"extra\":{\"name\":\"Cover Image\",\"type\":\"image\",\"required\":false,\"defaultValue\":{\"enabled\":false},\"index\":3,\"sizeLimit\":{\"value\":5,\"unit\":\"MB\"},\"formatType\":[\"jpg\",\"png\",\"jpeg\"]}},\"enableAIGC\":{\"type\":\"boolean\",\"extra\":{\"name\":\"AI Label\",\"type\":\"boolean\",\"required\":false,\"defaultValue\":{\"enabled\":false},\"index\":4}},\"productId\":{\"type\":\"string\",\"extra\":{\"name\":\"Product ID\",\"type\":\"string\",\"required\":false,\"charValid\":{\"enabled\":true,\"value\":50},\"placeholder\":\"Product ID only supports digits, with a maximum of 50 characters.\",\"defaultValue\":{\"enabled\":false},\"index\":5}},\"productTitle\":{\"type\":\"string\",\"extra\":{\"name\":\"Product Title\",\"type\":\"string\",\"required\":false,\"charValid\":{\"enabled\":true,\"value\":30},\"defaultValue\":{\"enabled\":false},\"index\":6}},\"getLeads\":{\"type\":\"boolean\",\"extra\":{\"name\":\"Get Leads\",\"type\":\"boolean\",\"required\":false,\"defaultValue\":{\"enabled\":false},\"index\":7}},\"comment\":{\"type\":\"string\",\"extra\":{\"name\":\"Comment\",\"type\":\"string\",\"required\":false,\"charValid\":{\"enabled\":true,\"value\":200},\"multiline\":{\"enabled\":true,\"value\":3},\"defaultValue\":{\"enabled\":false},\"index\":8}}}" ``` - __Step 2: Build the Parameter JSON__ Construct the JSON object according to the parameter requirements: ```json { "__Extra__": { "videoDownloadUrl": { "name": "video_name.mp4", "size": 204800000 } }, "videoDownloadUrl": "https://get.phonegrid.com/pre/cloudPhoneTaskVideo/1542431036481556/4c4fed83685345ae8f1505fbe0c2f123/baby.mp4" } ``` - __Step 3: Escape the JSON String__ Convert the JSON object into an escaped string format: ```json "{\"__Extra__\": {\"videoDownloadUrl\": {\"name\": \"video_name.mp4\",\"size\": 204800000}},\"videoDownloadUrl\": \"https://get.phonegrid.com/pre/cloudPhoneTaskVideo/1542431036481556/4c4fed83685345ae8f1505fbe0c2f123/baby.mp4\"}" ``` - __Step 4: API Call__ Pass the escaped string as the value of the `templateParameter` parameter to the target API.

Cancel schedule

POST/api/cloudphone/rpa/task/cancel

Page query task executions record

POST/api/cloudphone/rpa/subTask/page

Query Schedules market template, template name supports fuzzy query

Get a task execution

POST/api/cloudphone/rpa/subTask/detail/{id}

Query Schedules market template, template name supports fuzzy query

Cancel execution

POST/api/cloudphone/rpa/subTask/cancel/{id}

Proxy Management

Getting a list of proxies

POST/api/proxyInfo/page

Adding proxy

POST/api/proxyInfo/add

Modifying proxy information

POST/api/proxyInfo/update

Delete proxy

POST/api/proxyInfo/delete

Group Management

Get a list of groups

POST/api/envgroup/page

Modify grouping information

POST/api/envgroup/edit

Add group

POST/api/envgroup/create

Delete group

POST/api/envgroup/delete

Tag Management

Getting a list of tags

GET/api/envtag/all

Create tags

POST/api/envtag/create

Modify information of tags

POST/api/envtag/edit

Delete tags

POST/api/envtag/delete

Schemas

start browser profileobject

envIdstringrequired

profile

debugPortstringrequired

typestringrequired

versionintegerrequired

webdriverstringrequired

UaGetobject

resolutionobjectrequired

idstringrequired

valuestringrequired

uastringrequired

EnvironmentRequestobject

accountInfoany

advancedSettingany

afterStartupConfigany

browserCoreinteger

Kernel version; default:0 (auto-match). Fetch available versions via /api/env/advanced/ua/versions.

cookiesstring

Cookie string to preload (optional)

envNamestring

Environment name

envRemarkstring

Environment remark; max length:1500 chars

groupIdinteger

Environment group ID; default:ungrouped (0)

envIdstring

Environment ID

proxyIdinteger

Proxy ID; default:0

tagIdsarray<integer>

Tag IDs; default:none

itemsinteger

uaVersioninteger

UA preset version; default:0 (all)

disableAudiointeger

Disable audio:0 = off, 1 = on

disableImginteger

Disable image loading:0 = off, 1 = on

disableVideointeger

Disable video loading:0 = off, 1 = on

imgLimitSizeinteger

Max image size (KB)

AccountInfoobject

customerUrlstring

Custom platform URL — required if platformId=9999, must be a valid URL

passwordstring

Password; max length:50 characters

platformIdinteger

Platform ID; use 9999 for custom URL. Refer to /api/system/platform/list.

siteIdinteger

Site ID; obtain via ""Get Configurable Platforms"" API (/api/system/platform/list)

usernamestring

Username; max length:64 characters

AdvancedSettingobject

Advanced browser fingerprint and behavior configuration.

uastring

Customize the profile User-Agent (UA). Must follow standard UA format. Available via the “Get Browser UA” API.

time_zoneany

web_rtcany

geo_locationany

languageany

resolutionany

fontany

canvasany

webgl_imageany

webgl_metadataany

audio_contextany

media_deviceany

client_rectsany

speech_voiseany

hardware_concurrencyinteger

Simulated number of logical CPU cores. Default:4. Options: 0 (real), 2, 3, 4, 6, 8, 10, 12.

memery_deviceinteger

Simulated device memory (GB). Default:8. Options: 0 (real), 2, 4, 6, 8.

do_not_trackinteger

Do Not Track setting. Default:2. 1 = on, 2 = off.

bluetoothany

batteryany

port_scan_protectionany

os_versionstring

macOS system version (e.g., macOS 12, macOS 13, macOS 14).

web_gpuany

ciphersany

mobile_devicestring

Phone model ID (as string). Obtain via "Get Phone Model List" API. Example: "1826502391344832512"

TimeZoneConfigobject

switcherinteger

Timezone option. Default:1. 1 = Match IP, 2 = Custom.

valuestring

Required when switcher=2. Timezone ID from “Get Timezone & Language List” API.

WebRTCConfigobject

switcherinteger

WebRTC policy. Default:2. 1 = Privacy, 2 = Replacement, 3 = Real, 4 = Disabled, 5 = Forwarding.

GeoLocationConfigobject

switcherinteger

Geolocation policy. Default:1. 1 = Prompt, 2 = Disabled.

base_on_ipboolean

Generate location based on IP? Default:true. true = prompt, false = manual.

latitudenumber (float)

Latitude. Required if base_on_ip=false.

longitudenumber (float)

Longitude. Required if base_on_ip=false.

accuracynumber (float)

Accuracy in meters. Required if base_on_ip=false.

LanguageConfigobject

switcherinteger

Language policy. Default:1. 1 = Match IP, 2 = Custom.

valuestring

Required when switcher=2. Comma-separated language IDs from “Get Timezone & Language List” API.

ResolutionConfigobject

switcherinteger

Resolution policy. Default:1. 1 = Real, 2 = Custom.

idstring

Required when switcher=2. Resolution ID from “Get Resolution List” API.

FontConfigobject

switcherinteger

Font policy. Default:1. 1 = Real, 2 = Custom.

valuestring

Comma-separated custom font names (required if switcher=2).

CanvasConfigobject

switcherinteger

Canvas policy. Default:1. 1 = Noise, 2 = Real.

WebGLImageConfigobject

switcherinteger

WebGL image policy. Default:1. 1 = Noise, 2 = Real.

WebGLMetadataConfigobject

switcherinteger

WebGL metadata policy. Default:3. 1 = Real, 2 = Disable HW acceleration, 3 = Custom.

providerstring

WebGL vendor string (e.g., "Google Inc.")

renderstring

WebGL renderer string (e.g., "ANGLE (...)")

AudioContextConfigobject

switcherinteger

AudioContext policy. Default:1. 1 = Noise, 2 = Realistic.

MediaDeviceConfigobject

switcherinteger

Media device policy. Default:1. 1 = Noise, 2 = Real.

ClientRectsConfigobject

switcherinteger

ClientRects policy. Default:1. 1 = Noise, 2 = Real.

SpeechVoiseConfigobject

switcherinteger

SpeechVoices policy. Default:1. 1 = Privacy, 2 = Real

BluetoothConfigobject

switcherinteger

Bluetooth policy. Default:1. 1 = Privacy, 2 = Authenticity.

BatteryConfigobject

switcherinteger

Battery policy. Default:1. 1 = Privacy, 2 = Authenticity.

PortScanProtectionConfigobject

switcherinteger

Port scan protection. Default:1. 1 = On, 2 = Off.

valuestring

Allowed local network ports to connect (comma-separated).

WebGPUConfigobject

switcherinteger

WebGPU policy. Default:1. 1 = WebGL-based matching, 2 = true, 3 = disabled.

AfterStartupConfigobject

afterStartupinteger (int32)

Action after startup. Default:1. 1 = Continue last page, 2 = Open specified URLs, 3 = Open URLs + platform, 4 = Continue last page + platform.

autoOpenUrlsarray<string>

List of valid URLs to open automatically (required for options 2–3).

itemsstring

CiphersConfigobject

switcherinteger

TLS cipher policy. Default:1. 1 = Default, 2 = Custom.

valuestring

Required when switcher=2. Comma-separated list of TLS protocols to disable (e.g., "TLSv1,TLSv1.1").

platformListobject

idstringrequired

Platform ID

categoryIdstringrequired

Category ID

groupNamestringrequired

Group name

groupsstringrequired

Group，0：Amazon

isCustomerbooleanrequired

Whether to customize the platform

logostringrequired

Platform logo

namestringrequired

Platform name

orderNostringrequired

Sort Number

sitesarray<string>required

Sites information

idstringrequired

Site ID

hoststringrequired

Site Domain Name

namestringrequired

Size name

nameBakstringrequired

Size name backup

logostringrequired

Logo

urlstringrequired

Size URL

isDefaultbooleanrequired

countrystringrequired

Country

browser phone listobject

codeintegerrequired

Return result code 0:Normal Other codes are exceptions.

msgstringrequired

Error message

dataarray<string>required

idstring

namestring

resolutionstring

osinteger

platformstring

requestIdstringrequired

Operation request ID

CloudPhoneProfileobject

abnormalStatusinteger

Abnormal status 0-No abnormality 1-Unactivated 2-Out-of-contract 3-Oversold 4-Deactivated

adbInfoany

billingTypeinteger

Billing:0-Free 1-Flexible subscription 2-Monthly

createDatestring (date-time)

createMemberinteger

createMemberNamestring

enableAdbboolean

envNamestring

Cloud Phone Name

envRemarkstring

Profile Remarks

envStatusinteger

Profile Status:0-New 1-Creation Failed 2-Stop 3-Starting up 4-Start 5-Reset In Progress

expireTimeinteger

expiration time

groupIdinteger

groupInfoarray<any>

itemsany

idinteger (int64)

lastConnectDatestring (date-time)

lastConnectMemberIdinteger

lastConnectMemberNamestring

lastStartDatestring (date-time)

lastStartMemberIdinteger

lastStartMemberNamestring

proxyany

proxyStatusinteger

Proxy Status:0-Not Detected 1-Detecting 2-Detecting Failed 3-Detecting Successful

supportAdbboolean

tagIdsarray<string>

itemsstring

tagInfoarray<any>

itemsany

updateDatestring (date-time)

updateMemberinteger

AdbInfoobject

adbIpstringrequired

adb ip

adbPasswordstringrequired

adb connection password

adbPortstringrequired

adb port

remarkstringrequired

Failure Remarks Information

successintegerrequired

Successful acquisition 1=Yes 0=No

ProxyInfoobject

countrystringrequired

countryCodestringrequired

createDatestring (date-time)required

delFlagintegerrequired

1 - deleted 2 - not deleted

expiryTimeintegerrequired

exportIpstringrequired

groupIdintegerrequired

idinteger (int64)required

providerCodestringrequired

proxyAreaCodestringrequired

proxyCatagoryTypeintegerrequired

Proxy type:0:site group 1:cloud platform 2:own IP 3:vps 4:virtual machine

proxyCheckStatusintegerrequired

Detection status:0:pending detection 1:successful detection 2:detection failure 3:unknown error

proxyInfostringrequired

proxyIpstringrequired

proxyNamestringrequired

proxyPortintegerrequired

proxyRegionCodestringrequired

proxyStatusintegerrequired

0-Normal 1-Pending allocation 2-Upgrading 3-Expired

proxySubanyrequired

proxyTypeintegerrequired

Proxy type：0-http 1-https 2-socks5 4-Oxylabs 5-Proxys.io 6-GeoSurf 9-Oxylabsauto 10-Trogan 11-Shadowsocks 12-vmess

proxyTypeCodestringrequired

regionKeystringrequired

releaseTimestring (date-time)required

Release time:deletion time if deleted, expiration time if expired

uniqueIdintegerrequired

ProxySubscriptionobject

activeRecordIdintegerrequired

businessIdstringrequired

createMemberintegerrequired

endTimeintegerrequired

idintegerrequired

nextBillingTimeintegerrequired

startTimeintegerrequired

subPayMethodstringrequired

subStatusintegerrequired

Subscription Status:0-Pending 1-Subscribed 2-Cancelled

subTypeintegerrequired

Subscription Type:1-Agent 2-Package

teamIdintegerrequired

TagInfoobject

idinteger

tagIconstring

tagNamestring

tagSourcestring

Tag Source: ENV profile, PROXY proxy

tagTypestring

Tag type: TAG tag, GROUP group

CloudPhoneDetailobject

idstringrequired

envNamestringrequired

groupIdstringrequired

skuIdstringrequired

tagIdsarray<string>required

itemsstring

billingTypeintegerrequired

proxyStatusintegerrequired

settingsobjectrequired

automaticGeobooleanrequired

automaticLocationbooleanrequired

automaticLanguagebooleanrequired

longitudenumberrequired

latitudenumberrequired

deviceobjectrequired

serverstringrequired

countryNamestringrequired

romintegerrequired

wifiBssidstringrequired

bluetoothMacstringrequired

proxyobjectrequired

idstringrequired

proxyNamestringrequired

proxyIpstringrequired

lastStartMemberIdstringrequired

lastStartMemberNamestringrequired

lastStartDatestring (date-time)required

lastConnectMemberIdstringrequired

lastConnectMemberNamestringrequired

lastConnectDatestring (date-time)required

envStatusintegerrequired

abnormalStatusintegerrequired

expireTimestringrequired

envRemarkstringrequired

createMemberstringrequired

updateMemberstringrequired

updateDatestring (date-time)required

createDatestring (date-time)required

createMemberNamestringrequired

Execution DTOobject

idinteger

Execution record id

taskNamestring

Schedule Task name

taskStateinteger

Schedule status; 0:awaiting execution; 1:Executing; 2:Execution completed 3:Cancel

cloudPhoneIdinteger

Cloud phone ID

cloudPhoneNamestring

Cloud phone name

templateNamestring

Template title

handleFailCodestring

Task failure code

handleFailReasonstring

Task failure reason

handleResultinteger

Task result. 0:failed; 1:succeeded

handleResultAttachmentstring

Task execution result attachment

handleTimestring

Execution time

endTimestring

Task end time

powerOnTimestring

Cloud phone power-on time

triggerNextTimestring

Next scheduled trigger time

triggerTimestring

Scheduled trigger time

createDatestring

Creation time

createMemberstring

Creator

updateDatestring

Last update time

updateMemberstring

Last updater