Open API
The PhoneGrid open 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 open API runs on your machine and is accessible at:https://api.phonegrid.com
Base URL
https://api.phonegrid.comPhoneGrid open api endponintAuthorization
Access Token
POST
/oauth2/tokenUser Info
GET
/oauth2/userinfoCloud Phone
Getting a list of cloud phone profiles
POST
/cloudphone/pageCreating a cloud phone
POST
/cloudphone/createStartup cloud phone
POST
/cloudphone/powerOnShut down the cloud phone
POST
/cloudphone/powerOffModify the cloud phone profile
POST
/cloudphone/edit/batchDelete cloud phone
POST
/cloudphone/delete/batchOne-click new cloud phone
POST
/cloudphone/newMachineCloud phone details
POST
/cloudphone/infoQuery brand & model list
POST
/cloudphone/brand/modelsQuery available brand & model list for given Android version
Update cloud phone ADB status
POST
/cloudphone/updateAdbExecute shell command
POST
/cloudphone/exeCommandCloud Phone/File Management
Get file upload URL
POST
/cloudphone/uploadUrlUpload temporary files through this interface, and the system will automatically delete them after 7 days
Uploading files
POST
/cloudphone/uploadFileuploadFile result
POST
/cloudphone/uploadFileResultFile download
POST
/cloudphone/downloadFile download result
POST
/cloudphone/download/resultSet Keybox
POST
/cloudphone/setKeyBoxCloud Phone/App Management
Install app on cloud phone
POST
/cloudphone/app/installGet APP application list
POST
/cloudphone/app/pageFetch APP application list
Query installed apps list
POST
/cloudphone/app/installedListQuery list of installed apps on a cloud phone
Launch APP
POST
/cloudphone/app/startLaunch an installed app on the cloud phone
Restart APP
POST
/cloudphone/app/restartStop APP
POST
/cloudphone/app/stopUninstall APP
POST
/cloudphone/app/uninstallSet Hide Accessibility App
POST
/cloudphone/app/setHideAccessibilityAppSupports only Android 13,Android 14, Android15A, Android16
Cloud Phone/Schedules management
Get market template pages
POST
/cloudphone/rpa/template/market/pageQuery Schedules market template, template name supports fuzzy query
Get Personal template pages
POST
/cloudphone/rpa/template/personal/pageQuery Schedules market template, template name supports fuzzy query
Get a schedules list
POST
/cloudphone/rpa/task/pageCreating a schedule
POST
/cloudphone/rpa/task/saveSave 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
/cloudphone/rpa/onceTask/saveSave 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
/cloudphone/rpa/task/cancelPage query task executions record
POST
/cloudphone/rpa/subTask/pageQuery Schedules market template, template name supports fuzzy query
Get a task execution
POST
/cloudphone/rpa/subTask/detail/{id}Query Schedules market template, template name supports fuzzy query
Cancel execution
POST
/cloudphone/rpa/subTask/cancel/{id}Proxy Management
Getting a list of proxies
POST
/proxyInfo/pageAdding proxy
POST
/proxyInfo/addModifying proxy information
POST
/proxyInfo/updateDelete proxy
POST
/proxyInfo/deleteGroup Management
Get a list of groups
POST
/envgroup/pageModify grouping information
POST
/envgroup/editAdd group
POST
/envgroup/createDelete group
POST
/envgroup/deleteTag Management
Getting a list of tags
GET
/envtag/allCreate tags
POST
/envtag/createModify information of tags
POST
/envtag/editDelete tags
POST
/envtag/deleteSchemas
CloudPhoneProfileobjectabnormalStatusintegerAbnormal status 0-No abnormality 1-Unactivated 2-Out-of-contract 3-Oversold 4-Deactivated
adbInfoanybillingTypeintegerBilling:0-Free 1-Flexible subscription 2-Monthly
createDatestring (date-time)createMemberintegercreateMemberNamestringenableAdbbooleanenvNamestringCloud Phone Name
envRemarkstringProfile Remarks
envStatusintegerProfile Status:0-New 1-Creation Failed 2-Stop 3-Starting up 4-Start 5-Reset In Progress
expireTimeintegerexpiration time
groupIdintegergroupInfoarray<any>itemsanyidinteger (int64)lastConnectDatestring (date-time)lastConnectMemberIdintegerlastConnectMemberNamestringlastStartDatestring (date-time)lastStartMemberIdintegerlastStartMemberNamestringproxyanyproxyStatusintegerProxy Status:0-Not Detected 1-Detecting 2-Detecting Failed 3-Detecting Successful
supportAdbbooleantagIdsarray<string>itemsstringtagInfoarray<any>itemsanyupdateDatestring (date-time)updateMemberintegerAdbInfoobjectadbIpstringrequiredadb ip
adbPasswordstringrequiredadb connection password
adbPortstringrequiredadb port
remarkstringrequiredFailure Remarks Information
successintegerrequiredSuccessful acquisition 1=Yes 0=No
ProxyInfoobjectcountrystringrequiredcountryCodestringrequiredcreateDatestring (date-time)requireddelFlagintegerrequired1 - deleted 2 - not deleted
expiryTimeintegerrequiredexportIpstringrequiredgroupIdintegerrequiredidinteger (int64)requiredproviderCodestringrequiredproxyAreaCodestringrequiredproxyCatagoryTypeintegerrequiredProxy type:0:site group 1:cloud platform 2:own IP 3:vps 4:virtual machine
proxyCheckStatusintegerrequiredDetection status:0:pending detection 1:successful detection 2:detection failure 3:unknown error
proxyInfostringrequiredproxyIpstringrequiredproxyNamestringrequiredproxyPortintegerrequiredproxyRegionCodestringrequiredproxyStatusintegerrequired0-Normal 1-Pending allocation 2-Upgrading 3-Expired
proxySubanyrequiredproxyTypeintegerrequiredProxy type:0-http 1-https 2-socks5 4-Oxylabs 5-Proxys.io 6-GeoSurf 9-Oxylabsauto 10-Trogan 11-Shadowsocks 12-vmess
proxyTypeCodestringrequiredregionKeystringrequiredreleaseTimestring (date-time)requiredRelease time:deletion time if deleted, expiration time if expired
uniqueIdintegerrequiredProxySubscriptionobjectactiveRecordIdintegerrequiredbusinessIdstringrequiredcreateMemberintegerrequiredendTimeintegerrequiredidintegerrequirednextBillingTimeintegerrequiredstartTimeintegerrequiredsubPayMethodstringrequiredsubStatusintegerrequiredSubscription Status:0-Pending 1-Subscribed 2-Cancelled
subTypeintegerrequiredSubscription Type:1-Agent 2-Package
teamIdintegerrequiredTagInfoobjectidintegertagIconstringtagNamestringtagSourcestringTag Source: ENV profile, PROXY proxy
tagTypestringTag type: TAG tag, GROUP group
CloudPhoneDetailobjectidstringrequiredenvNamestringrequiredgroupIdstringrequiredskuIdstringrequiredtagIdsarray<string>requireditemsstringbillingTypeintegerrequiredproxyStatusintegerrequiredsettingsobjectrequiredautomaticGeobooleanrequiredautomaticLocationbooleanrequiredautomaticLanguagebooleanrequiredlongitudenumberrequiredlatitudenumberrequireddeviceobjectrequiredserverstringrequiredcountryNamestringrequiredromintegerrequiredwifiBssidstringrequiredbluetoothMacstringrequiredproxyobjectrequiredidstringrequiredproxyNamestringrequiredproxyIpstringrequiredlastStartMemberIdstringrequiredlastStartMemberNamestringrequiredlastStartDatestring (date-time)requiredlastConnectMemberIdstringrequiredlastConnectMemberNamestringrequiredlastConnectDatestring (date-time)requiredenvStatusintegerrequiredabnormalStatusintegerrequiredexpireTimestringrequiredenvRemarkstringrequiredcreateMemberstringrequiredupdateMemberstringrequiredupdateDatestring (date-time)requiredcreateDatestring (date-time)requiredcreateMemberNamestringrequiredExecution DTOobjectidintegerExecution record id
taskNamestringSchedule Task name
taskStateintegerSchedule status; 0:awaiting execution; 1:Executing; 2:Execution completed 3:Cancel
cloudPhoneIdintegerCloud phone ID
cloudPhoneNamestringCloud phone name
templateNamestringTemplate title
handleFailCodestringTask failure code
handleFailReasonstringTask failure reason
handleResultintegerTask result. 0:failed; 1:succeeded
handleResultAttachmentstringTask execution result attachment
handleTimestringExecution time
endTimestringTask end time
powerOnTimestringCloud phone power-on time
triggerNextTimestringNext scheduled trigger time
triggerTimestringScheduled trigger time
createDatestringCreation time
createMemberstringCreator
updateDatestringLast update time
updateMemberstringLast updater