Skip to content
API Reference
/
/
Cloud Phone/Schedules man...

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

Download OpenAPI description
open-api.json
open-api.yaml
Languages
Servers
Morelogin open api endponint
https://api.morelogin.com/

Authorization

Operations

Cloud Phone

Operations

Cloud Phone/File Management

Operations

Cloud Phone/App Management

Operations

Cloud Phone/Schedules management

Operations

Get market template pages

Request

Query Schedules market template, template name supports fuzzy query

Headers
Authorizationstringrequired

Token for request access token interface response access_token field

Example:
Bodyapplication/jsonrequired
searchKeystring or null

Template Name

pageNointeger or null

Default:1

pageSizeinteger or null

Default:10

curl -i -X POST \
  https://api.morelogin.com/cloudphone/rpa/template/market/page \
  -H 'Authorization: { '\''[object Object]'\'': null }' \
  -H 'Content-Type: application/json' \
  -d '{
    "pageNo": 0,
    "pageSize": 0,
    "searchWords": ""
  }'

Responses

Bodyapplication/json
codeintegerrequired

Response code, 0 indicates success,>0 indicates failure

msgstringrequired

Error msg

requestIdstringrequired

Request trace id

dataobjectrequired
data.​dataListArray of objectsrequired
data.​dataList[].​idinteger
data.​dataList[].​titlestring

Market template title

data.​dataList[].​parameterstringrequired

Template parameter JSON string

data.​dataList[].​descriptionstring

Market template Description

data.​dataList[].​appIconUrlsArray of strings
data.​dataList[].​sortinteger

sort

data.​dataList[].​authorstring

author

data.​dataList[].​updateDatestring

Last update time

data.​currentintegerrequired

Current page number

data.​pagesintegerrequired

Total pages

data.​totalintegerrequired

Total count

Response
application/json
{
  "code": 0,
  "msg": "",
  "data": {
    "current": 0,
    "dataList": [ … ],
    "pages": 0,
    "total": 0
  }
}

Get Personal template pages

Request

Query Schedules market template, template name supports fuzzy query

Headers
Authorizationstringrequired

Token for request access token interface response access_token field

Example:
Bodyapplication/jsonrequired
searchKeystring or null

Template name

descstring

Template description

pageNointeger or null

Default:1

pageSizeinteger or null

Default:10

curl -i -X POST \
  https://api.morelogin.com/cloudphone/rpa/template/personal/page \
  -H 'Authorization: { '\''[object Object]'\'': null }' \
  -H 'Content-Type: application/json' \
  -d '{
    "pageNo": 1,
    "pageSize": 10,
    "searchWords": ""
  }'

Responses

Bodyapplication/json
codeintegerrequired

Response code, 0 indicates success,>0 indicates failure

msgstringrequired

Error msg

requestIdstringrequired

Request trace id

dataobjectrequired
data.​dataListArray of objectsrequired
data.​dataList[].​idinteger
data.​dataList[].​titlestring

Market template title

data.​dataList[].​parameterstring

Template parameter JSON string

data.​dataList[].​descriptionstring

Market template Description

data.​dataList[].​appIconUrlsArray of strings
data.​dataList[].​sortinteger

sort

data.​dataList[].​updateDatestring

Last update time

data.​currentintegerrequired

Current page number

data.​pagesintegerrequired

Total pages

data.​totalintegerrequired

Total count

Response
application/json
{
  "code": 0,
  "msg": "",
  "data": {
    "current": 0,
    "dataList": [ … ],
    "pages": 0,
    "total": 0
  }
}

Get a schedules list

Request

Query
enabledboolean or null

Is the plan enabled

Example: enabled=false
mainTaskNamestring or null[ 1 .. 150 ] characters

plan name

taskStateinteger or null<= 3

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

templateTitlestring or null[ 0 .. 150 ] characters

Template Title

pageNostring

default:1

pageSizestring

default:20

Headers
Authorizationstringrequired

Token for request access token interface response access_token field

Example:
Bodyapplication/jsonrequired
enabledboolean or null

Is the plan enabled

taskNamestring or null

Plan name

templateTitlestring or null

Template title

taskStateinteger or null

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

pageNointeger or null

default:1

pageSizeinteger or null

default:10

curl -i -X POST \
  'https://api.morelogin.com/cloudphone/rpa/task/page?enabled=false&mainTaskName=string&taskState=3&templateTitle=string&pageNo=string&pageSize=string' \
  -H 'Authorization: { '\''[object Object]'\'': null }' \
  -H 'Content-Type: application/json'

Responses

Bodyapplication/json
codeintegerrequired

Response code, 0 indicates success,>0 indicates failure

msgstringrequired

Error msg

requestIdstringrequired

Request trace id

dataobjectrequired
data.​dataListArray of objectsrequired

Plan list

data.​dataList[].​idinteger

Schedule id

data.​dataList[].​taskNamestring

Schedule Task name

data.​dataList[].​createMemberstringrequired

Member name

data.​dataList[].​enabledboolean

Whether enabled

data.​dataList[].​endTimestring

Task end time

data.​dataList[].​failCountinteger

Number of failed executions

data.​dataList[].​handleTimestring

Execution start time

data.​dataList[].​notesstring

schedule notes

data.​dataList[].​scheduleConfigstring

Task schedule configuration

data.​dataList[].​successCountinteger

Number of successful executions

data.​dataList[].​taskPreviewTimeTableArray of objects
data.​dataList[].​taskStateinteger

Schedule Task state. 0:waiting; 1:running; 2:completed 3:Cancel

data.​dataList[].​templateIdinteger

Template id

data.​dataList[].​templateTitlestring

Template title

data.​currentintegerrequired

Current page number

data.​pagesintegerrequired

Total pages

data.​totalintegerrequired

Total count

Response
application/json
{
  "code": 0,
  "data": {
    "current": 0,
    "dataList": [ … ],
    "pages": 0,
    "total": 0
  },
  "msg": ""
}

Creating a schedule

Request

Headers
Authorizationstringrequired

Token for request access token interface response access_token field

Example:
Bodyapplication/jsonrequired
taskNamestringrequired

Task name

templateIdintegerrequired

Template ID

templateTypestringrequired

Template type. PERSONAL:personal; MARKET:marketplace

taskTypestringrequired

Task type. TEMPORARY or SCHEDULED

notesstring

Plan notes

cloudPhoneConfigsArray of objectsrequired

Collection of cloud phone schedule configurations

cloudPhoneConfigs[].​cloudPhoneIdintegerrequired

Cloud phone ID

cloudPhoneConfigs[].​triggerTimestringrequired

Task execution time, UTC+0 time zone

cloudPhoneConfigs[].​templateParameterstringrequired

Template parameters

scheduleConfigobjectrequired

Task schedule configuration

scheduleConfig.​endTimestringrequired

date-time

scheduleConfig.​scheduleTypestringrequired

Schedule type. ONCE:one-time; DAILY:daily; WEEKLY:weekly

scheduleConfig.​timezonestringrequired

Timezone

curl -i -X POST \
  https://api.morelogin.com/cloudphone/rpa/task/save \
  -H 'Authorization: { '\''[object Object]'\'': null }' \
  -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"
  }'

Responses

Bodyapplication/json
codeintegerrequired

Response code, 0 indicates success,>0 indicates failure

msgstringrequired

Error msg

requestIdstringrequired

Request trace id

dataintegerrequired

Schedules id

Response
application/json
{
  "code": 0,
  "data": 0,
  "msg": ""
}

Cancel schedule

Request

Query
idintegerrequired
Headers
Authorizationstringrequired

Token for request access token interface response access_token field

Example:
Bodyapplication/jsonrequired
idintegerrequired

Plan id

curl -i -X POST \
  'https://api.morelogin.com/cloudphone/rpa/task/cancel?id=0' \
  -H 'Authorization: { '\''[object Object]'\'': null }' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 1678919049331329
  }'

Responses

Bodyapplication/json
codeintegerrequired

Response code, 0 indicates success,>0 indicates failure

msgstringrequired

Error msg

requestIdstringrequired

Request trace id

Response
application/json
{
  "code": 0,
  "data": null,
  "msg": ""
}

Page query task executions record

Request

Query Schedules market template, template name supports fuzzy query

Headers
Authorizationstringrequired

Token for request access token interface response access_token field

Example:
Bodyapplication/jsonrequired
taskIdinteger or null

Task id

taskNamestring or null[ 1 .. 255 ] characters

Task name

taskStateinteger or null[ 0 .. 9 ]

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

templateIdinteger or null[ 0 .. 99999999999 ]

Template id

templateTitlestring or null[ 0 .. 255 ] characters

Template title

cloudPhoneIdinteger or null

cloud phone id

Example: 1559133625483282
cloudPhoneNamestring or null[ 0 .. 100 ] characters

Cloud phone name

beginTimestring or null

Task start time UTC+0 time zone

Example: "2025-01-01 23:59:59"
endTimestring or null

Task end time UTC+0 time zone

Example: "2025-01-02 23:59:59"
pageNointeger or null

Default:1

Example: 1
pageSizeinteger or null

Default:10

curl -i -X POST \
  https://api.morelogin.com/cloudphone/rpa/subTask/page \
  -H 'Authorization: { '\''[object Object]'\'': null }' \
  -H 'Content-Type: application/json' \
  -d '{
    "pageNo": 1,
    "pageSize": 10
  }'

Responses

Bodyapplication/json
codeintegerrequired

Response code, 0 indicates success,>0 indicates failure

msgstringrequired

Error msg

requestIdstringrequired

Request trace id

dataobjectrequired
data.​dataListArray of objects(Execution DTO)required
data.​dataList[].​idinteger

Execution record id

data.​dataList[].​taskNamestring

Schedule Task name

data.​dataList[].​taskStateinteger

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

data.​dataList[].​cloudPhoneIdinteger

Cloud phone ID

data.​dataList[].​cloudPhoneNamestring

Cloud phone name

data.​dataList[].​templateNamestring

Template title

data.​dataList[].​handleFailCodestring

Task failure code

data.​dataList[].​handleFailReasonstring

Task failure reason

data.​dataList[].​handleResultinteger

Task result. 0:failed; 1:succeeded

data.​dataList[].​handleResultAttachmentstring

Task execution result attachment

data.​dataList[].​handleTimestring

Execution time

data.​dataList[].​endTimestring

Task end time

data.​dataList[].​powerOnTimestring

Cloud phone power-on time

data.​dataList[].​triggerNextTimestring

Next scheduled trigger time

data.​dataList[].​triggerTimestring

Scheduled trigger time

data.​dataList[].​createDatestring

Creation time

data.​dataList[].​createMemberstring

Creator

data.​dataList[].​updateDatestring

Last update time

data.​dataList[].​updateMemberstring

Last updater

data.​currentintegerrequired

Current page number

data.​pagesintegerrequired

Total pages

data.​totalintegerrequired

Total count

Response
application/json
{
  "code": 0,
  "msg": "",
  "data": {
    "current": 0,
    "dataList": [ … ],
    "pages": 0,
    "total": 0
  }
}

Get a task execution

Request

Query Schedules market template, template name supports fuzzy query

Path
idintegerrequired

Execution task id

Example: 1678919049331331
Headers
Authorizationstringrequired

Token for request access token interface response access_token field

Example:
Bodyapplication/jsonrequired
taskIdinteger or null

Task id

taskNamestring or null[ 1 .. 255 ] characters

Task name

taskStateinteger or null[ 0 .. 9 ]

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

templateIdinteger or null[ 0 .. 99999999999 ]

Template id

templateTitlestring or null[ 0 .. 255 ] characters

Template title

cloudPhoneIdinteger or null

cloud phone id

Example: 1559133625483282
cloudPhoneNamestring or null[ 0 .. 100 ] characters

Cloud phone name

beginTimestring or null

Task start time UTC+0 time zone

Example: "2025-01-01 23:59:59"
endTimestring or null

Task end time UTC+0 time zone

Example: "2025-01-02 23:59:59"
pageNointeger or null

Default:1

Example: 1
pageSizeinteger or null

Default:10

curl -i -X POST \
  https://api.morelogin.com/cloudphone/rpa/subTask/detail/1678919049331331 \
  -H 'Authorization: { '\''[object Object]'\'': null }' \
  -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
  }'

Responses

Bodyapplication/json
codeintegerrequired

Response code, 0 indicates success,>0 indicates failure

msgstringrequired

Error msg

requestIdstringrequired

Request trace id

dataobjectrequired
data.​idinteger

Execution record id

data.​taskNamestring

Schedule Task name

data.​taskStateinteger

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

data.​cloudPhoneIdinteger

Cloud phone ID

data.​cloudPhoneNamestring

Cloud phone name

data.​templateNamestring

Template title

data.​handleFailCodestring

Task failure code

data.​handleFailReasonstring

Task failure reason

data.​handleResultinteger

Task result. 0:failed; 1:succeeded

data.​handleResultAttachmentstring

Task execution result attachment

data.​handleTimestring

Execution time

data.​endTimestring

Task end time

data.​powerOnTimestring

Cloud phone power-on time

data.​triggerNextTimestring

Next scheduled trigger time

data.​triggerTimestring

Scheduled trigger time

data.​createDatestring

Creation time

data.​createMemberstring

Creator

data.​updateDatestring

Last update time

data.​updateMemberstring

Last updater

Response
application/json
{
  "code": 0,
  "msg": "",
  "data": {
    "current": 0,
    "dataList": [ … ],
    "pages": 0,
    "total": 0
  }
}

Cancel execution

Request

Path
idstringrequired
Bodyapplication/jsonrequired
idintegerrequired

Plan id

curl -i -X POST \
  'https://api.morelogin.com/cloudphone/rpa/subTask/cancel/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 1678919049331329
  }'

Responses

Bodyapplication/json
codeintegerrequired

Response code, 0 indicates success,>0 indicates failure

msgstringrequired

Error msg

requestIdstringrequired

Request trace id

Response
application/json
{
  "code": 0,
  "data": null,
  "msg": ""
}

Proxy Management

Operations

Group Management

Operations

Tag Management

Operations