Cloud Phone

1 Getting a list of cloud phone profiles

Basic Information

Description: Queries information about existed cloud phone profiles. Users can only query the cloud phone profile that they have permission. The MoreLogin application needs to be updated to version 2.9.0 and above.

Request Parameters

Body parameter, non-mandatory parameters can not be passed, the format of the parameter is JSON.

sort

Example of a request

{
	"bindIp": true,
	"keyword": "",
	"pageNo": 1,
	"pageSize": 10,
	"sort": [
		{
			"sortDirection": "",
			"sortFiled": ""
		}
	]
}

Return data

{
	"code": 0,  // Return result code 0:Normal Other codes are exceptions.
	"msg": "",  // error message
	"data": {
		"current": 0,
		"dataList": [
			{
				"abnormalStatus": 0,   // Abnormal status: 0-No abnormality 1-Unactivated 2-Out-of-contract 3-Oversold 4-Deactivated
				"adbInfo": {           // adb information
					"adbIp": "",       // adb ip
					"adbPassword": "", // adb connection password
					"adbPort": "",     // adb port
					"remark": "",      // Failure Remarks Information
					"success": 0       // Successful acquisition 1=Yes 0=No
				},
				"billingType": 0,      // Billing: 0-Free 1-Flexible subscription 2-Monthly
				"createDate": "",      // Creation time
				"createMember": 0,     // Create User
				"createMemberName": "", // Create User
				"enableAdb": true,     // Whether to enable adb
				"envName": "",         // Cloud Phone Name
				"envRemark": "",       // Profile Remarks
				"envStatus": 0,        // Profile Status: 0-New 1-Creation Failed 2-Stop 3-Starting up 4-Start 5-Reset In Progress
				"expireTime": 0,       // expiration time
				"groupId": 0,          // Group Id
				"groupInfo": [         // Group Information
					{
						"id": 0,       // Tag marking
						"tagIcon": "", // Tag icon
						"tagName": "", // Tag name
						"tagSource": "", // Tag Source: ENV profile, PROXY proxy
						"tagType": ""  // Tag type: TAG tag, GROUP group
					}
				],
				"id": 0,               // Cloud phone Id
				"lastConnectDate": "", // Last connection time
				"lastConnectMemberId": 0, //Last Connector ID
				"lastConnectMemberName": "", // Last Connector Name
				"lastStartDate": "",   // Last start time
				"lastStartMemberId": 0, // Last start member ID
				"lastStartMemberName": "", // Last start member name
				"proxy": {             // proxy information
					"country": "",     // country
					"countryCode": "", // countryCode
					"createDate": "",  // createDate
					"delFlag": 0,      // 1 - deleted 2 - not deleted
					"expiryTime": 0,   // Expiration time
					"exportIp": "",    // Export IP
					"groupId": 0,      // Group ID
					"id": 0,           // Primary key
					"providerCode": "", // Provider area
					"proxyAreaCode": "", // Proxy area
					"proxyCatagoryType": 0, // Proxy type: 0-site group 1-cloud platform 2-own IP 3-vps 4-virtual machine
					"proxyCheckStatus": 0, // Detection status: 0 - pending detection 1 - successful detection 2 - detection failure 3 - unknown error
					"proxyInfo": "", // Proxy Information
					"proxyIp": "",   // Proxy IP
					"proxyName": "", // Proxy name
					"proxyPort": 0,  // Proxy port
					"proxyRegionCode": "", // Platform proxy country
					"proxyStatus": 0, // 0-Normal 1-Pending allocation 2-Upgrading 3-Expired
					"proxySub": {    // Proxy subscription
						"activeRecordId": 0, // Subscription records in activation
						"businessId": "",    // Proxy ID
						"createMember": 0,   // Create a member
						"endTime": 0, // End time
						"id": 0,      // Subscription ID
						"nextBillingTime": 0, // Next deduction time
						"startTime": 0, // Validity period
						"subPayMethod": "", // subPayMethod
						"subStatus": 0, // Subscription Status: 0-Pending 1-Subscribed 2-Cancelled
						"subType": 0, // Subscription Type: 1-Agent 2-Package
						"teamId": 0   // Team ID
					},
					"proxyType": 0,   // Proxy type：0-http 1-https 2-socks5 4-Oxylabs 5-Proxys.io 6-GeoSurf 9-Oxylabsauto 10-Trogan 11-Shadowsocks 12-vmess
					"proxyTypeCode": "", // Platform Proxy Type Code
					"regionKey": "",  // Cloud Platform Key
					"releaseTime": "", // Release time: deletion time if deleted, expiration time if expired
					"uniqueId": 0      // Sort ID
				},
				"proxyStatus": 0,      // Proxy Status: 0-Not Detected 1-Detecting 2-Detecting Failed 3-Detecting Successful
				"supportAdb": true,    // Whether adb is supported
				"tagIds": [],          // Tag IDs
				"tagInfo": [           // Tag information
					{
						"id": 0,       // Primary key
						"tagIcon": "",
						"tagName": "",
						"tagSource": "",
						"tagType": ""
					}
				],
				"updateDate": "",      // Modify Time
				"updateMember": 0      // Modify User
			}
		],
		"pages": 0,
		"total": 0
	},
	"requestId": "",   // Operation Request ID
}

2 Creating a Cloud Phone Profile

Basic information

• Interface description: Create a new cloud phone profile, support batch creation. The MoreLogin application needs to be updated to version 2.9.0 and above.

Request Parameters

Body parameter, non-required parameters can be left out, the format of the parameter is JSON.

Example of a request

{
	"altitude": 0,
	"automaticGeo": true,
	"automaticLanguage": true,
	"automaticLocation": true,
	"country": "",
	"envRemark": "",
	"groupId": "",
	"language": "",
	"latitude": 0,
	"longitude": 0,
	"proxyId": 0,
	"quantity": 0,
	"timezone": ""
}

Return Data

{
	"code": 0,  // Return result code 0:Normal Other codes are exceptions.
	"msg": "",  // Error message
	"data": []  // Cloud Phone ID
	"requestId": "",   // Operation Request ID
}

3 Start up Cloud Phone

Basic information

• Interface description: Start the cloud phone profile. The MoreLogin application needs to be updated to version 2.9.0 and above.

Request Parameters

Body parameter, non-required parameters can be left out, the format of the parameter is JSON.

Example of a request

{
	"id": 0
}

Return Data

{
	"code": 0,  // Return result code 0:Normal Other codes are exceptions.
	"msg": "",  // Error message
	"requestId": "",   // Operation Request ID
}

4 Shut down the cloud phone

Basic information

• Interface description: Stops the cloud phone profile. The MoreLogin application needs to be updated to version 2.9.0 and above.

Request Parameters

Body parameter, non-required parameters can be left out, the format of the parameter is JSON.

Example of a request

{
	"id": 0
}

Return Data

{
	"code": 0,  // Return result code 0:Normal Other codes are exceptions.
	"msg": "",  // Error message
	"requestId": "",   // Operation Request ID
}

5 Modify the cloud phone profile

• Interface description: Modify the cloud phone profile information, can batch modify the cloud phone binding proxy and other information. The MoreLogin application needs to be updated to version 2.9.0 and above.

Request Parameters

Body parameter, non-required parameters can be left out, the format of the parameter is JSON.

Example of a request

{
	"altitude": 0,
	"automaticGeo": true,
	"automaticLanguage": true,
	"automaticLocation": true,
	"country": "",
	"id": [],
	"language": "",
	"latitude": 0,
	"longitude": 0,
	"proxyId": 0,
	"timezone": ""
}

Return Data

{
	"code": 0,  // Return result code 0:Normal Other codes are exceptions.
	"msg": "",  // Error message
	"requestId": "",   // Operation Request ID
}

6 Delete Cloud Phone Profile

Basic information

• Interface description: batch delete cloud phone profiles. The MoreLogin application needs to be updated to version 2.9.0 and above.

Request Parameters

Body parameter, non-required parameters can be left out, the format of the parameter is JSON.

Example of a request

{
	"ids": []
}

Return Data

{
	"code": 0,  // Return result code 0:Normal Other codes are exceptions.
	"msg": "",  // Error message
	"data": {}  // The operation returns data
	"requestId": "",   // Operation Request ID
}

7 Update Cloud Phone ADB Status

Basic information

• Interface description: Batch enable/disable the ADB status of the cloud phone profile. The MoreLogin application needs to be updated to version 2.9.0 and above.

Request Parameters

Body parameter, non-required parameters can be left out, the format of the parameter is JSON.

Example of a request

{
	"enableAdb": true,
	"ids": []
}

Return Data

{
	"code": 0,  // Return result code 0:Normal Other codes are exceptions.
	"msg": "",  // Error message
	"requestId": "",   // Operation Request ID
}

8 One-click new cloud phone

Basic information

• Interface Description: Performs one-click new phone operation for cloud phones. The MoreLogin application needs to be updated to version 2.9.0 and above.

Request Parameters

Body parameter, non-required parameters can be left out, the format of the parameter is JSON.

Example of a request

{
	"id": 0
}

Return Data

{
	"code": 0,  // Return result code 0:Normal Other codes are exceptions.
	"msg": "",  // Error message
	"requestId": "",   // Operation Request ID
}

9 Uploading files

Basic information

• Content-Type：multipart/form-data
• Interface description: Upload files to cloud phone.The MoreLogin application needs to be updated to version 2.9.0 and above.

Request Parameters

Body parameter, non-required parameters can be left out, the format of the parameter is JSON.

Return Data

{
	"code": 0,  // Return result code 0:Normal Other codes are exceptions.
	"msg": "",  // Error message
	"requestId": "",   // Operation Request ID
}