Skip to content
Tài liệu tham khảo API
/
/
/
Tạo lịch trình

Tạo lịch trình

Request

Lưu tác vụ theo lịch trình điện thoại đám mây.

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
  1. Data Structure
  • Submit parameters in JSON object format: {"key1": "value1", "key2": "value2"}
  • Final parameter values must be deserialized according to business logic before use
  1. 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}
  1. 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"
}
  1. 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:
"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 templateParameter parameter to the target API.
Bodyapplication/jsonrequired
taskNamestringrequired

Tên tác vụ

templateIdstringrequired

ID mẫu

templateTypestringrequired

Loại mẫu. PERSONAL:cá nhân; MARKET:thị trường

taskTypestringrequired

Loại tác vụ. TEMPORARY hoặc SCHEDULED

notesstring

Ghi chú kế hoạch

cloudPhoneConfigsArray of objectsrequired

Bộ sưu tập cấu hình lịch trình điện thoại đám mây

scheduleConfigobjectrequired

Cấu hình lịch trình tác vụ

curl -i -X POST \
  http://127.0.0.1:40000/api/cloudphone/rpa/task/save \
  -H 'Content-Type: application/json' \
  -d '{
    "cloudPhoneConfigs": [
      {
        "cloudPhoneId": "1661515884160372",
        "triggerTime": "string",
        "templateParameter": "string"
      }
    ],
    "scheduleConfig": {
      "endTime": "string",
      "scheduleType": "string"
    },
    "taskName": "example-name",
    "taskType": "string",
    "templateId": "1661515884160372",
    "templateType": "string"
  }'

Responses

Thành công. data là một giá trị số nguyên duy nhất.

Headers
any
Bodyapplication/json
codeintegerrequired

Mã phản hồi, 0 cho biết thành công, >0 cho biết thất bại

msgstring or nullrequired

Thông báo lỗi

requestIdstringrequired

ID theo dõi yêu cầu

dataintegerrequired

ID lịch trình

Response
{
  "code": 0,
  "msg": null,
  "requestId": "0d8b6f1c-9f4e-4d02-9d1a-7c3f5a1b2c3d",
  "data": 1
}