Query Schedules market template, template name supports fuzzy query
Open API (1.0.0)
The MoreLogin 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 MoreLogin open API runs on your machine and is accessible at:https://api.morelogin.com
- Mock serverhttps://guide.morelogin.com/_mock/api-reference/open-api/open-api/cloudphone/rpa/template/market/page
- Morelogin open api endponinthttps://api.morelogin.com/cloudphone/rpa/template/market/page
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://guide.morelogin.com/_mock/api-reference/open-api/open-api/cloudphone/rpa/template/market/page \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"pageNo": 0,
"pageSize": 0,
"searchWords": ""
}'{ "code": 0, "msg": "", "data": { "current": 0, "dataList": [ … ], "pages": 0, "total": 0 } }
- Mock serverhttps://guide.morelogin.com/_mock/api-reference/open-api/open-api/cloudphone/rpa/template/personal/page
- Morelogin open api endponinthttps://api.morelogin.com/cloudphone/rpa/template/personal/page
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://guide.morelogin.com/_mock/api-reference/open-api/open-api/cloudphone/rpa/template/personal/page \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"pageNo": 1,
"pageSize": 10,
"searchWords": ""
}'{ "code": 0, "msg": "", "data": { "current": 0, "dataList": [ … ], "pages": 0, "total": 0 } }
Schedule status; 0:awaiting execution; 1:Executing; 2:Execution completed 3:Cancel
- Mock serverhttps://guide.morelogin.com/_mock/api-reference/open-api/open-api/cloudphone/rpa/task/page
- Morelogin open api endponinthttps://api.morelogin.com/cloudphone/rpa/task/page
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://guide.morelogin.com/_mock/api-reference/open-api/open-api/cloudphone/rpa/task/page?enabled=false&mainTaskName=string&taskState=3&templateTitle=string&pageNo=string&pageSize=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json'{ "code": 0, "data": { "current": 0, "dataList": [ … ], "pages": 0, "total": 0 }, "msg": "" }
Request
Save cloud phone scheduled task.
templateParameter Parameter Specification
- Parameter Source Parameter keys must be extracted from the
parameterfield returned by the following APIs:
- Get market template pages
- Get Personal template pages
- Data Structure
- Submit parameters in JSON object format:
{"key1": "value1", "key2": "value2"} - Final parameter values must be deserialized according to business logic before use
- 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}
- 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:
{
"__Extra__": {
"pic": {
"name": "pic_name",
"size": 204800
},
"video": {
"name": "video_name",
"size": 204800000
}
},
"pic": "https://get.morelogin.com/prod/cloudPhoneTaskVideo/1556061681934880/1c62314c7e2b4d298abe8d5452d7c050/test.png",
"video": "https://get.morelogin.com/pre/cloudPhoneTaskVideo/1542431036481556/4c4fed83685345ae8f1505fbe0c2f123/baby.mp4"
}- Parameter Configuration Example The following example demonstrates how to configure the
templateParameterparameter when saving a plan using a market template:
- Step 1: Retrieve Template Parameters Call the Market Template API:
GET /api/cloudphone/rpa/template/market/pageExtract theparameterfield from the response, for example:
"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:
{
"__Extra__": {
"videoDownloadUrl": {
"name": "video_name.mp4",
"size": 204800000
}
},
"videoDownloadUrl": "https://get.morelogin.com/pre/cloudPhoneTaskVideo/1542431036481556/4c4fed83685345ae8f1505fbe0c2f123/baby.mp4"
}- Step 3: Escape the JSON String Convert the JSON object into an escaped string format:
"{\"__Extra__\": {\"videoDownloadUrl\": {\"name\": \"video_name.mp4\",\"size\": 204800000}},\"videoDownloadUrl\": \"https://get.morelogin.com/pre/cloudPhoneTaskVideo/1542431036481556/4c4fed83685345ae8f1505fbe0c2f123/baby.mp4\"}"- Step 4: API Call Pass the escaped string as the value of the
templateParameterparameter to the target API.
Collection of cloud phone schedule configurations
Template parameters are defined in personal templates or market templates. The parameters in the template are defined as:{"Test":{"extra":{"type":"string","required":true,"multiline":{"enabled":false},"name":"Test","index":1},"type":"string"}} When requesting parameters, the parameter passed is:{"Test":"xxxx"}
- Mock serverhttps://guide.morelogin.com/_mock/api-reference/open-api/open-api/cloudphone/rpa/task/save
- Morelogin open api endponinthttps://api.morelogin.com/cloudphone/rpa/task/save
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://guide.morelogin.com/_mock/api-reference/open-api/open-api/cloudphone/rpa/task/save \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"cloudPhoneConfigs": [
{
"cloudPhoneId": 1678331966138097,
"templateParameter": "{\"keyword\": \"abc\"}",
"triggerTime": "2025-12-29 23:00:00"
}
],
"notes": "notes test",
"scheduleConfig": {
"endTime": "2025-12-30 00:00:00",
"scheduleType": "ONCE"
},
"taskName": "test",
"templateId": 1678347487160296,
"templateType": "PERSONAL"
}'{ "code": 0, "data": 0, "msg": "" }
Request
Save cloud phone once scheduled task
templateParameter Parameter Specification
- Parameter Source Parameter keys must be extracted from the
parameterfield returned by the following APIs:
- Get market template pages
- Get Personal template pages
- Data Structure
- Submit parameters in JSON object format:
{"key1": "value1", "key2": "value2"} - Final parameter values must be deserialized according to business logic before use
- 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}
- 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:
{
"__Extra__": {
"pic": {
"name": "pic_name",
"size": 204800
},
"video": {
"name": "video_name",
"size": 204800000
}
},
"pic": "https://get.morelogin.com/prod/cloudPhoneTaskVideo/1556061681934880/1c62314c7e2b4d298abe8d5452d7c050/test.png",
"video": "https://get.morelogin.com/pre/cloudPhoneTaskVideo/1542431036481556/4c4fed83685345ae8f1505fbe0c2f123/baby.mp4"
}- Parameter Configuration Example The following example demonstrates how to configure the
templateParameterparameter when saving a plan using a market template:
- Step 1: Retrieve Template Parameters Call the Market Template API:
GET /api/cloudphone/rpa/template/market/pageExtract theparameterfield from the response, for example:
"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:
{
"__Extra__": {
"videoDownloadUrl": {
"name": "video_name.mp4",
"size": 204800000
}
},
"videoDownloadUrl": "https://get.morelogin.com/pre/cloudPhoneTaskVideo/1542431036481556/4c4fed83685345ae8f1505fbe0c2f123/baby.mp4"
}- Step 3: Escape the JSON String Convert the JSON object into an escaped string format:
"{\"__Extra__\": {\"videoDownloadUrl\": {\"name\": \"video_name.mp4\",\"size\": 204800000}},\"videoDownloadUrl\": \"https://get.morelogin.com/pre/cloudPhoneTaskVideo/1542431036481556/4c4fed83685345ae8f1505fbe0c2f123/baby.mp4\"}"- Step 4: API Call Pass the escaped string as the value of the
templateParameterparameter to the target API.
Template parameters are defined in personal templates or market templates. The parameters in the template are defined as:{"Test":{"extra":{"type":"string","required":true,"multiline":{"enabled":false},"name":"Test","index":1},"type":"string"}} When requesting parameters, the parameter passed is:{"Test":"xxxx"}
- Mock serverhttps://guide.morelogin.com/_mock/api-reference/open-api/open-api/cloudphone/rpa/onceTask/save
- Morelogin open api endponinthttps://api.morelogin.com/cloudphone/rpa/onceTask/save
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://guide.morelogin.com/_mock/api-reference/open-api/open-api/cloudphone/rpa/onceTask/save \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"cloudPhoneId": 16783319661123,
"scheduleName": "test",
"templateId": 1678347487160256,
"templateParameter": "{\"keyword\": \"abc\"}",
"description": "schedule description"
}'{ "code": 0, "data": 0, "msg": "" }
- Mock serverhttps://guide.morelogin.com/_mock/api-reference/open-api/open-api/cloudphone/rpa/task/cancel
- Morelogin open api endponinthttps://api.morelogin.com/cloudphone/rpa/task/cancel
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://guide.morelogin.com/_mock/api-reference/open-api/open-api/cloudphone/rpa/task/cancel \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"id": 1678919049331329
}'{ "code": 0, "data": null, "msg": "" }
Plan status; 0:awaiting execution; 1:Executing; 2:Execution completed 3:Cancel
- Mock serverhttps://guide.morelogin.com/_mock/api-reference/open-api/open-api/cloudphone/rpa/subTask/page
- Morelogin open api endponinthttps://api.morelogin.com/cloudphone/rpa/subTask/page
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://guide.morelogin.com/_mock/api-reference/open-api/open-api/cloudphone/rpa/subTask/page \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"pageNo": 1,
"pageSize": 10
}'{ "code": 0, "msg": "", "data": { "current": 0, "dataList": [ … ], "pages": 0, "total": 0 } }
Plan status; 0:awaiting execution; 1:Executing; 2:Execution completed 3:Cancel
- Mock serverhttps://guide.morelogin.com/_mock/api-reference/open-api/open-api/cloudphone/rpa/subTask/detail/{id}
- Morelogin open api endponinthttps://api.morelogin.com/cloudphone/rpa/subTask/detail/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://guide.morelogin.com/_mock/api-reference/open-api/open-api/cloudphone/rpa/subTask/detail/1678919049331331 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"taskId": 0,
"taskName": "string",
"taskState": 9,
"templateId": 99999999999,
"templateTitle": "string",
"cloudPhoneId": 1559133625483282,
"cloudPhoneName": "string",
"beginTime": "2025-01-01 23:59:59",
"endTime": "2025-01-02 23:59:59",
"pageNo": 1,
"pageSize": 0
}'{ "code": 0, "msg": "", "data": { "current": 0, "dataList": [ … ], "pages": 0, "total": 0 } }
- Mock serverhttps://guide.morelogin.com/_mock/api-reference/open-api/open-api/cloudphone/rpa/subTask/cancel/{id}
- Morelogin open api endponinthttps://api.morelogin.com/cloudphone/rpa/subTask/cancel/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://guide.morelogin.com/_mock/api-reference/open-api/open-api/cloudphone/rpa/subTask/cancel/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"id": 1678919049331329
}'{ "code": 0, "data": null, "msg": "" }