Перейти к содержимому
Справочник API
/
/
/
Создание расписания на од...

Создание расписания на одну ночь

Request

Сохранение запланированной задачи в облаке телефона

Спецификация параметров шаблона

Источник параметров Ключи параметров должны быть извлечены из поля parameter, возвращаемого следующими API:

  • Получение страниц шаблонов рынка
  • Получение страниц персональных шаблонов
  1. Структура данных
  • Передача параметров в формате объекта JSON: {"key1": "value1", "key2": "value2"}
  • Окончательные значения параметров должны быть десериализованы в соответствии с бизнес-логикой перед использованием
  1. Общие типы параметров Для следующих типов параметров передавайте значения непосредственно в соответствующем формате:
  • строка: {"name": "John"}
  • десятичное число: {"amount": 100.50}
  • логическое значение: {"enabled": true}
  1. Параметры типа медиафайлов Для параметров медиафайлов, таких как изображение (pic) или видео (video), в дополнение к основной информации, используется фиксированный ключ Необходимо включить "__Extra__". Пример формата:
{
"__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": "morelogin://cloudfile?ids=1,2"
}
  1. Пример настройки параметров Следующий пример демонстрирует, как настроить параметр templateParameter при сохранении плана с использованием шаблона рынка:
  • Шаг 1: Получение параметров шаблона Вызовите API шаблона рынка: GET /api/cloudphone/rpa/template/market/page Извлеките поле parameter из ответа, например:
"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\":\"Идентификатор продукта поддерживает только цифры, максимум 50 символов.\",\"defaultValue\":{\"enabled\":false},\"index\":5}},\"productTitle\":{\"type\":\"string\",\"extra\":{\"name\":\"Название продукта\",\"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}}}"
  • Шаг 2: Создание JSON-объекта параметров Создайте JSON-объект в соответствии с требованиями к параметрам:
{

"__Extra__": {
"videoDownloadUrl": {
"name": "video_name.mp4",
"size": 204800000

}

},
"videoDownloadUrl": "morelogin://cloudfile?ids=1,2"
}
  • Шаг 3: Экранирование строки JSON Преобразуйте объект JSON в экранированную строку:
"{\"__Extra__\": {\"videoDownloadUrl\": {\"name\": \"video_name.mp4\",\"size\": 204800000}},\"videoDownloadUrl\": \"morelogin://cloudfile?ids=1,2\"}"
  • Шаг 4: Вызов API Передайте экранированную строку в качестве значения параметра templateParameter целевому API.

Задокументированные бизнес-ошибки: 33814, 33818. Значения кодов см. в Error Codes. Любая операция может дополнительно вернуть общие коды.

Security
Authorization
Bodyapplication/jsonrequired
cloudPhoneIdstringrequired

Идентификатор телефона в облаке

scheduleNamestringrequired

Название расписания

templateIdstringrequired

Идентификатор шаблона, персональный шаблон или идентификатор рыночного шаблона

templateParameterstring

Параметры шаблона определяются в личных шаблонах или шаблонах рынка. Параметры в шаблоне определяются следующим образом: {"Test":{"extra":{"type":"string","required":true,"multiline":{"enabled":false},"name":"Test","index":1},"type":"string"}} При запросе параметров передается следующий параметр: {"Test":"xxxx"}

descriptionstring

Описание расписания

curl -i -X POST \
  https://api.morelogin.com/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": "описание расписания"
  }'

Responses

Успех. data — одно значение типа integer.

Headers
any
Bodyapplication/json
codeintegerrequired

Код ответа: 0 означает успех, >0 — неудачу.

msgstring or nullrequired

Сообщение об ошибке

requestIdstringrequired

Идентификатор трассировки запроса

dataintegerrequired

Идентификаторы расписаний

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