n8n-nodes-morelogin 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. package/README.md +65 -0
  2. package/credentials/moreLoginOAuth2Api.credentials.ts +43 -0
  3. package/dist/credentials/moreLoginOAuth2Api.credentials.d.ts +9 -0
  4. package/dist/credentials/moreLoginOAuth2Api.credentials.js +43 -0
  5. package/dist/credentials/moreLoginOAuth2Api.credentials.js.map +1 -0
  6. package/dist/icons/morelogin.dark.svg +23 -0
  7. package/dist/icons/morelogin.svg +38 -0
  8. package/dist/nodes/Morelogin/Morelogin.node.d.ts +5 -0
  9. package/dist/nodes/Morelogin/Morelogin.node.js +200 -0
  10. package/dist/nodes/Morelogin/Morelogin.node.js.map +1 -0
  11. package/dist/nodes/Morelogin/Morelogin.node.json +18 -0
  12. package/dist/nodes/Morelogin/resources/account/getInfo.d.ts +2 -0
  13. package/dist/nodes/Morelogin/resources/account/getInfo.js +20 -0
  14. package/dist/nodes/Morelogin/resources/account/getInfo.js.map +1 -0
  15. package/dist/nodes/Morelogin/resources/account/getToken.d.ts +2 -0
  16. package/dist/nodes/Morelogin/resources/account/getToken.js +59 -0
  17. package/dist/nodes/Morelogin/resources/account/getToken.js.map +1 -0
  18. package/dist/nodes/Morelogin/resources/account/index.d.ts +2 -0
  19. package/dist/nodes/Morelogin/resources/account/index.js +49 -0
  20. package/dist/nodes/Morelogin/resources/account/index.js.map +1 -0
  21. package/dist/nodes/Morelogin/resources/schedule/createOnceSchedule.d.ts +5 -0
  22. package/dist/nodes/Morelogin/resources/schedule/createOnceSchedule.js +54 -0
  23. package/dist/nodes/Morelogin/resources/schedule/createOnceSchedule.js.map +1 -0
  24. package/dist/nodes/Morelogin/resources/schedule/createSchedule.d.ts +5 -0
  25. package/dist/nodes/Morelogin/resources/schedule/createSchedule.js +115 -0
  26. package/dist/nodes/Morelogin/resources/schedule/createSchedule.js.map +1 -0
  27. package/dist/nodes/Morelogin/resources/schedule/index.d.ts +2 -0
  28. package/dist/nodes/Morelogin/resources/schedule/index.js +73 -0
  29. package/dist/nodes/Morelogin/resources/schedule/index.js.map +1 -0
  30. package/dist/nodes/Morelogin/resources/schedule/searchMarketTemplatePage.d.ts +5 -0
  31. package/dist/nodes/Morelogin/resources/schedule/searchMarketTemplatePage.js +31 -0
  32. package/dist/nodes/Morelogin/resources/schedule/searchMarketTemplatePage.js.map +1 -0
  33. package/dist/nodes/Morelogin/resources/schedule/searchPersonalTemplatePage.d.ts +5 -0
  34. package/dist/nodes/Morelogin/resources/schedule/searchPersonalTemplatePage.js +40 -0
  35. package/dist/nodes/Morelogin/resources/schedule/searchPersonalTemplatePage.js.map +1 -0
  36. package/dist/nodes/Morelogin/shared/descriptions.d.ts +4 -0
  37. package/dist/nodes/Morelogin/shared/descriptions.js +44 -0
  38. package/dist/nodes/Morelogin/shared/descriptions.js.map +1 -0
  39. package/dist/nodes/Morelogin/shared/transport.d.ts +2 -0
  40. package/dist/nodes/Morelogin/shared/transport.js +14 -0
  41. package/dist/nodes/Morelogin/shared/transport.js.map +1 -0
  42. package/dist/package.json +57 -0
  43. package/dist/tsconfig.tsbuildinfo +1 -0
  44. package/icons/morelogin.dark.svg +23 -0
  45. package/icons/morelogin.svg +38 -0
  46. package/nodes/Morelogin/Morelogin.node.json +18 -0
  47. package/nodes/Morelogin/Morelogin.node.ts +235 -0
  48. package/nodes/Morelogin/openApi.yaml +4313 -0
  49. package/nodes/Morelogin/resources/account/getInfo.ts +19 -0
  50. package/nodes/Morelogin/resources/account/getToken.ts +58 -0
  51. package/nodes/Morelogin/resources/account/index.ts +48 -0
  52. package/nodes/Morelogin/resources/schedule/createOnceSchedule.ts +54 -0
  53. package/nodes/Morelogin/resources/schedule/createSchedule.ts +115 -0
  54. package/nodes/Morelogin/resources/schedule/index.ts +73 -0
  55. package/nodes/Morelogin/resources/schedule/searchMarketTemplatePage.ts +31 -0
  56. package/nodes/Morelogin/resources/schedule/searchPersonalTemplatePage.ts +40 -0
  57. package/nodes/Morelogin/shared/descriptions.ts +44 -0
  58. package/nodes/Morelogin/shared/transport.ts +27 -0
  59. package/package.json +57 -0
@@ -0,0 +1,4313 @@
1
+ openapi: 3.1.0
2
+ info:
3
+ title: Open API
4
+ description: "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"
5
+ version: 1.0.0
6
+ tags:
7
+ - name: Authorization
8
+ - name: Cloud Phone
9
+ - name: Cloud Phone/File Management
10
+ - name: Cloud Phone/App Management
11
+ - name: Cloud Phone/Schedules management
12
+ - name: Proxy Management
13
+ - name: Group Management
14
+ - name: Tag Management
15
+ paths:
16
+ /oauth2/token:
17
+ post:
18
+ summary: Access Token
19
+ deprecated: false
20
+ description: ''
21
+ tags:
22
+ - Authorization
23
+ parameters:
24
+ - name: Content-Type
25
+ in: header
26
+ required: true
27
+ example: application/json
28
+ schema:
29
+ type: string
30
+ requestBody:
31
+ content:
32
+ application/json:
33
+ schema:
34
+ type: object
35
+ properties:
36
+ client_id:
37
+ description: A API ID identifies an member
38
+ type: string
39
+ client_secret:
40
+ description: |
41
+ A API Key authenticates a client ID. To call MoreLogin APIs, you'll
42
+ exchange your API ID and API Key for an access token. Keep this
43
+ secret safe.
44
+ type: string
45
+ grant_type:
46
+ description: Package name — required only if appVersionId is not provided
47
+ type: string
48
+ example: client_credentials
49
+ required:
50
+ - client_id
51
+ - client_secret
52
+ - grant_type
53
+ example:
54
+ client_id: 1672940217990530
55
+ client_secret: client_secret
56
+ grant_type: client_credentials
57
+ responses:
58
+ '200':
59
+ description: ''
60
+ content:
61
+ application/json:
62
+ schema:
63
+ type: object
64
+ properties:
65
+ code:
66
+ type: integer
67
+ msg:
68
+ type: 'null'
69
+ data:
70
+ type: object
71
+ properties:
72
+ scope:
73
+ type: string
74
+ access_token:
75
+ type: string
76
+ token_type:
77
+ type: string
78
+ expires_in:
79
+ type: integer
80
+ client_metadata:
81
+ type: object
82
+ properties:
83
+ name:
84
+ type: string
85
+ required:
86
+ - name
87
+ x-apidog-orders:
88
+ - name
89
+ x-apidog-ignore-properties: []
90
+ required:
91
+ - scope
92
+ - access_token
93
+ - token_type
94
+ - expires_in
95
+ - client_metadata
96
+ x-apidog-orders:
97
+ - scope
98
+ - access_token
99
+ - token_type
100
+ - expires_in
101
+ - client_metadata
102
+ x-apidog-ignore-properties: []
103
+ requestId:
104
+ type: string
105
+ required:
106
+ - code
107
+ - msg
108
+ - data
109
+ - requestId
110
+ x-apidog-orders:
111
+ - code
112
+ - msg
113
+ - data
114
+ - requestId
115
+ x-apidog-ignore-properties: []
116
+ example:
117
+ code: 0
118
+ msg: null
119
+ data:
120
+ scope: cloudphone
121
+ access_token: |
122
+ eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxNjU4MjYwNzYyNjA3OTU2IiwibmFtZSI6InpodXp1YmluNTU155qE5Zui6ZifIiwiZXhwIjoxNzY2ODkxNDY4LCJpYXQiOjE3NjY4ODc4Njh9.CJ_h-EQTG440qL-zSPcAockuw9PmBfyllyGZd0cmF0Q
123
+ token_type: Bearer
124
+ expires_in: 3600
125
+ client_metadata:
126
+ name: team name
127
+ requestId: 1d4f3ea968664593860b94b35d4ebf5e
128
+ headers: {}
129
+ x-apidog-name: 成功
130
+ x-apidog-ordering: 0
131
+ security: []
132
+ /oauth2/userinfo:
133
+ get:
134
+ summary: User Info
135
+ deprecated: false
136
+ description: ''
137
+ tags:
138
+ - Authorization
139
+ parameters:
140
+ - name: Authorization
141
+ in: header
142
+ description: Token for request access token interface response access_token field
143
+ required: true
144
+ example: {{Authorization}}
145
+ schema:
146
+ type: string
147
+ responses:
148
+ '200':
149
+ description: ''
150
+ content:
151
+ application/json:
152
+ schema:
153
+ type: object
154
+ properties:
155
+ code:
156
+ type: integer
157
+ msg:
158
+ type: 'null'
159
+ data:
160
+ type: object
161
+ properties:
162
+ teamId:
163
+ type: string
164
+ teamName:
165
+ type: string
166
+ memberId:
167
+ type: string
168
+ memberNickName:
169
+ type: string
170
+ memberEmail:
171
+ type: string
172
+ requestId:
173
+ type: string
174
+ required:
175
+ - code
176
+ - msg
177
+ - data
178
+ - requestId
179
+ example:
180
+ code: 0
181
+ msg: null
182
+ data:
183
+ scope: cloudphone
184
+ access_token: |
185
+ eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxNjU4MjYwNzYyNjA3OTU2IiwibmFtZSI6InpodXp1YmluNTU155qE5Zui6ZifIiwiZXhwIjoxNzY2ODkxNDY4LCJpYXQiOjE3NjY4ODc4Njh9.CJ_h-EQTG440qL-zSPcAockuw9PmBfyllyGZd0cmF0Q
186
+ token_type: Bearer
187
+ expires_in: 3600
188
+ client_metadata:
189
+ name: team name
190
+ requestId: 1d4f3ea968664593860b94b35d4ebf5e
191
+ headers: {}
192
+ security: []
193
+ /cloudphone/uploadUrl:
194
+ post:
195
+ summary: Get file upload URL
196
+ deprecated: false
197
+ description: Upload temporary files through this interface, and the system will automatically delete them after 7 days
198
+ operationId: get
199
+ tags:
200
+ - Cloud Phone/File Management
201
+ parameters:
202
+ - name: Authorization
203
+ in: header
204
+ description: Token for request access token interface response access_token field
205
+ required: true
206
+ example: {{Authorization}}
207
+ schema:
208
+ type: string
209
+ requestBody:
210
+ content:
211
+ application/json:
212
+ schema:
213
+ type: object
214
+ properties:
215
+ id:
216
+ type: integer
217
+ description: Cloud phone ID
218
+ fileName:
219
+ type: string
220
+ description: Upload file name
221
+ example:
222
+ fileName: "example.jpg"
223
+ id: 0
224
+ responses:
225
+ "200":
226
+ description: ""
227
+ content:
228
+ application/json:
229
+ schema:
230
+ type: object
231
+ properties:
232
+ code:
233
+ type: integer
234
+ description: Return result code 0:Normal Other codes are exceptions.
235
+ msg:
236
+ type: string
237
+ description: |
238
+ error message
239
+ data:
240
+ type: object
241
+ properties:
242
+ presignedUrl:
243
+ type: string
244
+ description: File upload URL use https PUT uploading files to cloud storage
245
+ required:
246
+ - presignedUrl
247
+ requestId:
248
+ type: string
249
+ required:
250
+ - code
251
+ - msg
252
+ - data
253
+ - requestId
254
+ headers: {}
255
+ security: []
256
+ /cloudphone/uploadFile:
257
+ post:
258
+ summary: Uploading files
259
+ deprecated: false
260
+ description: ""
261
+ operationId: fileUploadUsing
262
+ tags:
263
+ - Cloud Phone/File Management
264
+ parameters:
265
+ - name: Authorization
266
+ in: header
267
+ description: Token for request access token interface response access_token field
268
+ required: true
269
+ example: {{Authorization}}
270
+ schema:
271
+ type: string
272
+ requestBody:
273
+ content:
274
+ multipart/form-data:
275
+ schema:
276
+ type: object
277
+ properties:
278
+ id:
279
+ description: Cloud phone ID
280
+ type: string
281
+ example: '1661515884160372'
282
+ url:
283
+ type: string
284
+ description: upload file url
285
+ example: https://example.com/test.jpg
286
+ uploadDest:
287
+ description: Upload destination directory
288
+ type: string
289
+ example: /Download
290
+ responses:
291
+ '200':
292
+ description: ''
293
+ content:
294
+ application/json:
295
+ schema:
296
+ type: object
297
+ properties:
298
+ code:
299
+ type: integer
300
+ msg:
301
+ type: 'null'
302
+ data:
303
+ type: object
304
+ properties:
305
+ fileId:
306
+ type: string
307
+ description: Uploaded file ID
308
+ id:
309
+ type: cloud phone ID
310
+ status:
311
+ type: integer
312
+ description: Upload status 0:uploading 1:success 2:failed
313
+ required:
314
+ - fileId
315
+ - id
316
+ - status
317
+ requestId:
318
+ type: string
319
+ required:
320
+ - code
321
+ - msg
322
+ - data
323
+ - requestId
324
+ example:
325
+ code: 0
326
+ msg: null
327
+ data:
328
+ fileId: "1661515884160111"
329
+ id: 1661515884160372
330
+ status: 1
331
+ requestId: 1d4f3ea968664593860b94b35d4ebf5e
332
+ headers: {}
333
+ security: []
334
+ /cloudphone/uploadFileResult:
335
+ post:
336
+ summary: uploadFile result
337
+ deprecated: false
338
+ description: ""
339
+ operationId: fileUploadResult
340
+ tags:
341
+ - Cloud Phone/File Management
342
+ parameters:
343
+ - name: Authorization
344
+ in: header
345
+ description: Token for request access token interface response access_token field
346
+ required: true
347
+ example: {{Authorization}}
348
+ schema:
349
+ type: string
350
+ requestBody:
351
+ content:
352
+ multipart/form-data:
353
+ schema:
354
+ type: object
355
+ properties:
356
+ id:
357
+ description: Cloud phone ID
358
+ type: string
359
+ example: '1661515884160372'
360
+ fileId:
361
+ type: string
362
+ description: Uploaded file ID
363
+ responses:
364
+ '200':
365
+ description: ''
366
+ content:
367
+ application/json:
368
+ schema:
369
+ type: object
370
+ properties:
371
+ code:
372
+ type: integer
373
+ msg:
374
+ type: 'null'
375
+ data:
376
+ type: object
377
+ properties:
378
+ id:
379
+ type: cloud phone ID
380
+ fileId:
381
+ type: string
382
+ description: Uploaded file ID
383
+ status:
384
+ type: integer
385
+ description: Upload status 0:uploading 1:success 2:failed
386
+ required:
387
+ - fileId
388
+ - id
389
+ - status
390
+ requestId:
391
+ type: string
392
+ required:
393
+ - code
394
+ - msg
395
+ - data
396
+ - requestId
397
+ example:
398
+ code: 0
399
+ msg: null
400
+ data:
401
+ id: 1661515884160372
402
+ fileId: "1661515884160111"
403
+ status: 1
404
+ requestId: 1d4f3ea968664593860b94b35d4ebf5e
405
+ headers: {}
406
+ security: []
407
+ /cloudphone/download:
408
+ post:
409
+ summary: File download
410
+ deprecated: false
411
+ description: ''
412
+ tags:
413
+ - Cloud Phone/File Management
414
+ parameters: []
415
+ requestBody:
416
+ content:
417
+ application/json:
418
+ schema:
419
+ type: object
420
+ properties:
421
+ id:
422
+ type: integer
423
+ description: cloud phone id
424
+ filePath:
425
+ type: string
426
+ description: |
427
+ file path: /sdcard/Download/a.txt
428
+ required:
429
+ - filePath
430
+ - id
431
+ example:
432
+ filePath: ''
433
+ id: 0
434
+ required: true
435
+ responses:
436
+ '200':
437
+ description: ''
438
+ content:
439
+ application/json:
440
+ schema:
441
+ type: object
442
+ properties:
443
+ code:
444
+ type: integer
445
+ description: Response code, 0 indicates success,>0 indicates failure
446
+ msg:
447
+ type: string
448
+ data:
449
+ type: object
450
+ properties:
451
+ id:
452
+ type: integer
453
+ description: Cloud phone id
454
+ downId:
455
+ type: integer
456
+ description: 'File download id '
457
+ required:
458
+ - id
459
+ - downId
460
+ required:
461
+ - code
462
+ - msg
463
+ - data
464
+ example:
465
+ code: 0
466
+ msg: ''
467
+ data:
468
+ id: 0
469
+ downId: 0
470
+ headers: {}
471
+ security: []
472
+ /cloudphone/download/result:
473
+ post:
474
+ summary: File download result
475
+ deprecated: false
476
+ description: ''
477
+ tags:
478
+ - Cloud Phone/File Management
479
+ parameters: []
480
+ requestBody:
481
+ content:
482
+ application/json:
483
+ schema:
484
+ type: object
485
+ properties:
486
+ id:
487
+ type: integer
488
+ description: cloud phone id
489
+ downId:
490
+ type: integer
491
+ description: file download id
492
+ required:
493
+ - downId
494
+ - id
495
+ example:
496
+ downId: 0
497
+ id: 0
498
+ required: true
499
+ responses:
500
+ '200':
501
+ description: ''
502
+ content:
503
+ application/json:
504
+ schema:
505
+ type: object
506
+ properties:
507
+ code:
508
+ type: integer
509
+ description: Response code, 0 indicates success,>0 indicates failure
510
+ msg:
511
+ type: 'null'
512
+ data:
513
+ type: object
514
+ properties:
515
+ status:
516
+ type: integer
517
+ description: >-
518
+ Download file status;10:Running, 20:Successful,
519
+ 30:Failed, 40:Cancelled
520
+ downUrl:
521
+ type: string
522
+ description: File download url
523
+ required:
524
+ - status
525
+ - downUrl
526
+ requestId:
527
+ type: string
528
+ required:
529
+ - code
530
+ - msg
531
+ - data
532
+ - requestId
533
+ example:
534
+ code: 0
535
+ msg: null
536
+ data:
537
+ status: 20
538
+ downUrl: https://get.morelogin.com/...
539
+ requestId: 17d9dbfd958e4f40a51897520138d3ff
540
+ headers: {}
541
+ security: []
542
+ /cloudphone/setKeyBox:
543
+ post:
544
+ summary: Set Keybox
545
+ deprecated: false
546
+ description: ""
547
+ tags:
548
+ - Cloud Phone/File Management
549
+ parameters:
550
+ - name: Authorization
551
+ in: header
552
+ description: Token for request access token interface response access_token field
553
+ required: true
554
+ example: {{Authorization}}
555
+ schema:
556
+ type: string
557
+ requestBody:
558
+ content:
559
+ application/json:
560
+ schema:
561
+ type: object
562
+ properties:
563
+ filePath:
564
+ type: string
565
+ description: File path, e.g., /sdcard/Download/xxx.xml
566
+ id:
567
+ type: integer
568
+ description: Cloud phone ID
569
+ example:
570
+ filePath: ""
571
+ id: 0
572
+ responses:
573
+ "200":
574
+ description: ""
575
+ content:
576
+ application/json:
577
+ schema:
578
+ type: object
579
+ properties:
580
+ code:
581
+ type: integer
582
+ description: 'Response code: 0 = success, >0 = error'
583
+ msg:
584
+ type: string
585
+ data:
586
+ type: boolean
587
+ headers: {}
588
+ security: []
589
+ /cloudphone/app/install:
590
+ post:
591
+ summary: Install app on cloud phone
592
+ deprecated: false
593
+ description: ""
594
+ tags:
595
+ - Cloud Phone/App Management
596
+ parameters:
597
+ - name: Authorization
598
+ in: header
599
+ description: Token for request access token interface response access_token field
600
+ required: true
601
+ example: {{Authorization}}
602
+ schema:
603
+ type: string
604
+ requestBody:
605
+ content:
606
+ application/json:
607
+ schema:
608
+ type: object
609
+ properties:
610
+ appVersionId:
611
+ description: App version ID
612
+ type: string
613
+ id:
614
+ description: Cloud phone ID
615
+ type: integer
616
+ packageName:
617
+ description: Package name — required only if appVersionId is not provided
618
+ type: string
619
+ versionCode:
620
+ description: Version code — required only if appVersionId is not provided
621
+ type: integer
622
+ required:
623
+ - id
624
+ example:
625
+ appVersionId: '1672940217990530'
626
+ id: 1673823102599682
627
+ responses:
628
+ "200":
629
+ description: ""
630
+ content:
631
+ application/json:
632
+ schema:
633
+ type: object
634
+ properties:
635
+ code:
636
+ type: integer
637
+ msg:
638
+ type: 'null'
639
+ data:
640
+ type: boolean
641
+ requestId:
642
+ type: string
643
+ headers: {}
644
+ security: []
645
+ /cloudphone/app/page:
646
+ post:
647
+ summary: Get APP application list
648
+ deprecated: false
649
+ description: Fetch APP application list
650
+ tags:
651
+ - Cloud Phone/App Management
652
+ parameters:
653
+ - name: Authorization
654
+ in: header
655
+ description: Token for request access token interface response access_token field
656
+ required: true
657
+ example: {{Authorization}}
658
+ schema:
659
+ type: string
660
+ requestBody:
661
+ content:
662
+ application/json:
663
+ schema:
664
+ type: object
665
+ properties:
666
+ appName:
667
+ description: App name (partial match)
668
+ type: string
669
+ pageNum:
670
+ description: 'Page number; Default:1'
671
+ type: integer
672
+ pageSize:
673
+ description: 'Items per page; Default:10'
674
+ type: integer
675
+ example:
676
+ appName: de
677
+ pageNum: 1
678
+ pageSize: 10
679
+ responses:
680
+ "200":
681
+ description: ""
682
+ content:
683
+ application/json:
684
+ schema:
685
+ type: object
686
+ properties:
687
+ code:
688
+ type: integer
689
+ msg:
690
+ type: 'null'
691
+ data:
692
+ type: object
693
+ properties:
694
+ total:
695
+ type: string
696
+ current:
697
+ type: string
698
+ pages:
699
+ type: string
700
+ dataList:
701
+ type: array
702
+ items:
703
+ type: object
704
+ properties: {}
705
+ requestId:
706
+ type: string
707
+ headers: {}
708
+ security: []
709
+ /cloudphone/app/installedList:
710
+ post:
711
+ summary: Query installed apps list
712
+ deprecated: false
713
+ description: Query list of installed apps on a cloud phone
714
+ tags:
715
+ - Cloud Phone/App Management
716
+ parameters:
717
+ - name: Authorization
718
+ in: header
719
+ description: Token for request access token interface response access_token field
720
+ required: true
721
+ example: {{Authorization}}
722
+ schema:
723
+ type: string
724
+ requestBody:
725
+ content:
726
+ application/json:
727
+ schema:
728
+ type: object
729
+ properties:
730
+ id:
731
+ description: Cloud phone ID
732
+ type: integer
733
+ required:
734
+ - id
735
+ example:
736
+ id: 1674550360293464
737
+ responses:
738
+ "200":
739
+ description: ""
740
+ content:
741
+ application/json:
742
+ schema:
743
+ type: object
744
+ properties:
745
+ code:
746
+ type: integer
747
+ msg:
748
+ type: 'null'
749
+ data:
750
+ type: array
751
+ items:
752
+ type: object
753
+ properties:
754
+ appName:
755
+ type: string
756
+ appIcon:
757
+ type: string
758
+ packageName:
759
+ type: string
760
+ versionCode:
761
+ type: string
762
+ versionName:
763
+ type: string
764
+ requestId:
765
+ type: string
766
+ headers: {}
767
+ security: []
768
+ /cloudphone/app/start:
769
+ post:
770
+ summary: Launch APP
771
+ deprecated: false
772
+ description: Launch an installed app on the cloud phone
773
+ tags:
774
+ - Cloud Phone/App Management
775
+ parameters:
776
+ - name: Authorization
777
+ in: header
778
+ description: Token for request access token interface response access_token field
779
+ required: true
780
+ example: {{Authorization}}
781
+ schema:
782
+ type: string
783
+ requestBody:
784
+ content:
785
+ application/json:
786
+ schema:
787
+ type: object
788
+ properties:
789
+ id:
790
+ description: Cloud phone ID
791
+ type: integer
792
+ packageName:
793
+ description: App package name
794
+ type: string
795
+ required:
796
+ - id
797
+ - packageName
798
+ example:
799
+ id: 1674550360293464
800
+ packageName: "com.depop"
801
+ responses:
802
+ "200":
803
+ description: ""
804
+ content:
805
+ application/json:
806
+ schema:
807
+ type: object
808
+ properties:
809
+ code:
810
+ type: integer
811
+ msg:
812
+ type: string
813
+ data:
814
+ type: 'null'
815
+ requestId:
816
+ type: string
817
+ headers: {}
818
+ security: []
819
+ /cloudphone/app/restart:
820
+ post:
821
+ summary: Restart APP
822
+ deprecated: false
823
+ description: ""
824
+ tags:
825
+ - Cloud Phone/App Management
826
+ parameters:
827
+ - name: Authorization
828
+ in: header
829
+ description: Token for request access token interface response access_token field
830
+ required: true
831
+ example: {{Authorization}}
832
+ schema:
833
+ type: string
834
+ requestBody:
835
+ content:
836
+ application/json:
837
+ schema:
838
+ type: object
839
+ properties:
840
+ id:
841
+ type: integer
842
+ description: Cloud phone ID
843
+ packageName:
844
+ type: string
845
+ description: App package name
846
+ example:
847
+ id: 0
848
+ packageName: ""
849
+ responses:
850
+ "200":
851
+ description: ""
852
+ content:
853
+ application/json:
854
+ schema:
855
+ type: object
856
+ properties:
857
+ code:
858
+ type: integer
859
+ description: Response code:0 = success, >0 = error
860
+ msg:
861
+ type: string
862
+ description: Response msg, Error message returned if code > 0
863
+ data:
864
+ type: boolean
865
+ required:
866
+ - msg
867
+ headers: {}
868
+ security: []
869
+ /cloudphone/app/stop:
870
+ post:
871
+ summary: Stop APP
872
+ deprecated: false
873
+ description: ""
874
+ tags:
875
+ - Cloud Phone/App Management
876
+ parameters: []
877
+ requestBody:
878
+ content:
879
+ application/json:
880
+ schema:
881
+ type: object
882
+ properties:
883
+ id:
884
+ type: integer
885
+ description: Cloud phone ID
886
+ packageName:
887
+ type: string
888
+ description: App package name
889
+ example:
890
+ id: 0
891
+ packageName: ""
892
+ responses:
893
+ "200":
894
+ description: ""
895
+ content:
896
+ application/json:
897
+ schema:
898
+ type: object
899
+ properties:
900
+ code:
901
+ type: integer
902
+ description: 'Response code: 0 = success, >0 = error'
903
+ data:
904
+ type: boolean
905
+ msg:
906
+ type: string
907
+ description: Message; populated if code > 0
908
+ headers: {}
909
+ security: []
910
+ /cloudphone/app/uninstall:
911
+ post:
912
+ summary: Uninstall APP
913
+ deprecated: false
914
+ description: ""
915
+ tags:
916
+ - Cloud Phone/App Management
917
+ parameters:
918
+ - name: Authorization
919
+ in: header
920
+ description: Token for request access token interface response access_token field
921
+ required: true
922
+ example: {{Authorization}}
923
+ schema:
924
+ type: string
925
+ requestBody:
926
+ content:
927
+ application/json:
928
+ schema:
929
+ type: object
930
+ properties:
931
+ id:
932
+ type: integer
933
+ description: Cloud phone ID
934
+ packageName:
935
+ type: string
936
+ description: App package name
937
+ example:
938
+ id: 0
939
+ packageName: ""
940
+ responses:
941
+ "200":
942
+ description: ""
943
+ content:
944
+ application/json:
945
+ schema:
946
+ type: object
947
+ properties:
948
+ code:
949
+ type: integer
950
+ description: 'Response code: 0 = success, >0 = error'
951
+ data:
952
+ type: boolean
953
+ msg:
954
+ type: string
955
+ description: Message; populated if code > 0
956
+ headers: {}
957
+ security: []
958
+ /cloudphone/page:
959
+ post:
960
+ summary: Getting a list of cloud phone profiles
961
+ operationId: pageUsingPOST
962
+ tags:
963
+ - Cloud Phone
964
+ parameters:
965
+ - name: Authorization
966
+ in: header
967
+ description: Token for request access token interface response access_token field
968
+ required: true
969
+ example: {{Authorization}}
970
+ schema:
971
+ type: string
972
+ requestBody:
973
+ required: true
974
+ content:
975
+ application/json:
976
+ schema:
977
+ type: object
978
+ properties:
979
+ bindIp:
980
+ type: boolean
981
+ description: 'Whether IP is bound: true = bound, false = not'
982
+ example: false
983
+ keyword:
984
+ type: string
985
+ description: 'Keyword to filter: proxy info, group name, tag name, environment name'
986
+ example: "CP-424"
987
+ pageNo:
988
+ type: integer
989
+ format: int64
990
+ description: Current page
991
+ example: 1
992
+ pageSize:
993
+ type: integer
994
+ format: int64
995
+ description: Items per page
996
+ example: 100
997
+ sort:
998
+ type: array
999
+ description: 'Dynamic sort fields. Currently only "envName" is supported for cloud phones.'
1000
+ items:
1001
+ type: object
1002
+ properties:
1003
+ sortDirection:
1004
+ type: string
1005
+ enum: [asc, desc]
1006
+ description: Sort direction
1007
+ example: "asc"
1008
+ sortField:
1009
+ type: string
1010
+ description: Field to sort by (only "envName" is currently supported)
1011
+ example: "envName"
1012
+ required:
1013
+ - sortDirection
1014
+ - sortField
1015
+ example:
1016
+ - sortDirection: "asc"
1017
+ sortField: "envName"
1018
+ example:
1019
+ bindIp: false
1020
+ keyword: "CP-424"
1021
+ pageNo: 1
1022
+ pageSize: 100
1023
+ sort:
1024
+ - sortDirection: "asc"
1025
+ sortField: "envName"
1026
+ responses:
1027
+ '200':
1028
+ description: OK
1029
+ content:
1030
+ application/json:
1031
+ schema:
1032
+ type: object
1033
+ properties:
1034
+ code:
1035
+ type: integer
1036
+ description: Return result code 0:Normal Other codes are exceptions.
1037
+ msg:
1038
+ type: string
1039
+ description: error message
1040
+ data:
1041
+ type: object
1042
+ properties:
1043
+ current:
1044
+ type: integer
1045
+ dataList:
1046
+ type: array
1047
+ items:
1048
+ $ref: '#/components/schemas/CloudPhoneProfile'
1049
+ pages:
1050
+ type: integer
1051
+ total:
1052
+ type: integer
1053
+ required:
1054
+ - current
1055
+ - dataList
1056
+ - pages
1057
+ - total
1058
+ requestId:
1059
+ type: string
1060
+ description: Operation Request ID
1061
+ required:
1062
+ - code
1063
+ - msg
1064
+ - data
1065
+ - requestId
1066
+
1067
+ /cloudphone/create:
1068
+ post:
1069
+ summary: Creating a Cloud Phone Profile
1070
+ operationId: createUsingPOST
1071
+ tags:
1072
+ - Cloud Phone
1073
+ parameters:
1074
+ - name: Authorization
1075
+ in: header
1076
+ description: Token for request access token interface response access_token field
1077
+ required: true
1078
+ example: {{Authorization}}
1079
+ schema:
1080
+ type: string
1081
+ requestBody:
1082
+ required: true
1083
+ content:
1084
+ application/json:
1085
+ schema:
1086
+ type: object
1087
+ properties:
1088
+ skuId:
1089
+ type: string
1090
+ description: |
1091
+ Cloud Phone model
1092
+ skuId:10002 model:Android 12
1093
+ skuId:10013 model:Android 13
1094
+ skuId:10005 model:Android 14
1095
+ skuId:10004 model:Android 15
1096
+ skuId:10014 model:Android 15A
1097
+ Refer to the appendix for a detailed description of the model's parameters
1098
+ quantity:
1099
+ type: integer
1100
+ minimum: 1
1101
+ maximum: 10
1102
+ description: Number of cloud phone created. Range of values:[1-10]
1103
+ envRemark:
1104
+ type: string
1105
+ maxLength: 1500
1106
+ description: Profile Remarks (Length limit 1500 characters)
1107
+ automaticGeo:
1108
+ type: boolean
1109
+ description: Whether to automatically match the geographic location. Default:true
1110
+ automaticLanguage:
1111
+ type: boolean
1112
+ description: Whether to automatically match the language. Default:true
1113
+ automaticLocation:
1114
+ type: boolean
1115
+ description: Whether to auto-match location (time zone, country). Default:true
1116
+ country:
1117
+ type: string
1118
+ description: Country, e.g. us. Check appendix for country code details
1119
+ timezone:
1120
+ type: string
1121
+ description: Time zone, e.g. America/New_York
1122
+ language:
1123
+ type: string
1124
+ description: Language, e.g. en-US
1125
+ altitude:
1126
+ type: integer
1127
+ latitude:
1128
+ type: number
1129
+ description: Latitude. Example:22.309182
1130
+ longitude:
1131
+ type: number
1132
+ description: Longitude. Example:114.176817
1133
+ proxyId:
1134
+ type: integer
1135
+ format: int64
1136
+ description: Proxy ID
1137
+ required:
1138
+ - skuId
1139
+ - quantity
1140
+ - altitude
1141
+ example:
1142
+ skuId: "10002"
1143
+ envRemark: "Remark added at creation"
1144
+ groupId: "1565859744475508"
1145
+ automaticGeo: false
1146
+ automaticLanguage: false
1147
+ automaticLocation: false
1148
+ country: "au"
1149
+ timezone: "Australia/Currie"
1150
+ language: "de-AT"
1151
+ altitude: 1980
1152
+ latitude: 83.73
1153
+ longitude: 106.49
1154
+ proxyId: 1634660919386770
1155
+ quantity: 1
1156
+ responses:
1157
+ '200':
1158
+ description: OK
1159
+ content:
1160
+ application/json:
1161
+ schema:
1162
+ type: object
1163
+ properties:
1164
+ code:
1165
+ type: integer
1166
+ msg:
1167
+ type: string
1168
+ nullable: true
1169
+ data:
1170
+ type: array
1171
+ items:
1172
+ type: string
1173
+ requestId:
1174
+ type: string
1175
+ error:
1176
+ type: object
1177
+ properties: {}
1178
+ required:
1179
+ - code
1180
+ - msg
1181
+ - requestId
1182
+
1183
+ /cloudphone/powerOn:
1184
+ post:
1185
+ summary: Startup cloud phone
1186
+ operationId: powerOnUsingPOST
1187
+ tags:
1188
+ - Cloud Phone
1189
+ parameters:
1190
+ - name: Authorization
1191
+ in: header
1192
+ description: Token for request access token interface response access_token field
1193
+ required: true
1194
+ example: {{Authorization}}
1195
+ schema:
1196
+ type: string
1197
+ requestBody:
1198
+ required: true
1199
+ content:
1200
+ application/json:
1201
+ schema:
1202
+ type: object
1203
+ properties:
1204
+ id:
1205
+ type: integer
1206
+ format: int64
1207
+ required:
1208
+ - id
1209
+ example:
1210
+ id: 1637226321190925
1211
+ responses:
1212
+ '200':
1213
+ description: OK
1214
+ content:
1215
+ application/json:
1216
+ schema:
1217
+ type: object
1218
+ properties:
1219
+ code:
1220
+ type: integer
1221
+ description: Return result code 0:Normal Other codes are exceptions.
1222
+ msg:
1223
+ type: string
1224
+ description: Error message
1225
+ requestId:
1226
+ type: string
1227
+ description: Operation Request ID
1228
+ required:
1229
+ - code
1230
+ - msg
1231
+ - requestId
1232
+
1233
+ /cloudphone/powerOff:
1234
+ post:
1235
+ summary: Shut down the cloud phone
1236
+ operationId: powerOffUsingPOST
1237
+ tags:
1238
+ - Cloud Phone
1239
+ parameters:
1240
+ - name: Authorization
1241
+ in: header
1242
+ description: Token for request access token interface response access_token field
1243
+ required: true
1244
+ example: {{Authorization}}
1245
+ schema:
1246
+ type: string
1247
+ requestBody:
1248
+ required: true
1249
+ content:
1250
+ application/json:
1251
+ schema:
1252
+ type: object
1253
+ properties:
1254
+ id:
1255
+ type: integer
1256
+ format: int64
1257
+ required:
1258
+ - id
1259
+ example:
1260
+ id: 1596527092376632
1261
+ responses:
1262
+ '200':
1263
+ description: OK
1264
+ content:
1265
+ application/json:
1266
+ schema:
1267
+ type: object
1268
+ properties:
1269
+ code:
1270
+ type: integer
1271
+ description: Return result code 0:Normal Other codes are exceptions.
1272
+ msg:
1273
+ type: string
1274
+ description: Error message
1275
+ requestId:
1276
+ type: string
1277
+ description: Operation Request ID
1278
+ required:
1279
+ - code
1280
+ - msg
1281
+ - requestId
1282
+
1283
+ /cloudphone/edit/batch:
1284
+ post:
1285
+ summary: Modify the cloud phone profile
1286
+ operationId: editBatchUsingPOST
1287
+ tags:
1288
+ - Cloud Phone
1289
+ parameters:
1290
+ - name: Authorization
1291
+ in: header
1292
+ description: Token for request access token interface response access_token field
1293
+ required: true
1294
+ example: {{Authorization}}
1295
+ schema:
1296
+ type: string
1297
+ requestBody:
1298
+ required: true
1299
+ content:
1300
+ application/json:
1301
+ schema:
1302
+ type: object
1303
+ properties:
1304
+ id:
1305
+ type: array
1306
+ items:
1307
+ type: integer
1308
+ format: int64
1309
+ description: Cloud phone IDs
1310
+ proxyId:
1311
+ type: integer
1312
+ format: int64
1313
+ description: Proxy ID
1314
+ groupId:
1315
+ type: integer
1316
+ format: int64
1317
+ description: Environment group ID
1318
+ tagIds:
1319
+ type: array
1320
+ items:
1321
+ type: integer
1322
+ format: int64
1323
+ description: Environment tag IDs
1324
+ tagOps:
1325
+ type: string
1326
+ enum: [ADD, UPDATE, CLEAR]
1327
+ description: Tag operation
1328
+ envRemark:
1329
+ type: string
1330
+ maxLength: 1500
1331
+ description: Environment remark (≤1500 chars, line breaks supported)
1332
+ automaticGeo:
1333
+ type: boolean
1334
+ description: Auto geolocation
1335
+ automaticLanguage:
1336
+ type: boolean
1337
+ description: Auto language
1338
+ automaticLocation:
1339
+ type: boolean
1340
+ description: Auto location (timezone & country)
1341
+ country:
1342
+ type: string
1343
+ description: Country
1344
+ timezone:
1345
+ type: string
1346
+ description: Timezone
1347
+ language:
1348
+ type: string
1349
+ description: Language
1350
+ altitude:
1351
+ type: number
1352
+ description: Altitude
1353
+ latitude:
1354
+ type: number
1355
+ description: Latitude
1356
+ longitude:
1357
+ type: number
1358
+ description: Longitude
1359
+ required:
1360
+ - id
1361
+ example:
1362
+ id:
1363
+ - 1637238770951311
1364
+ proxyId: 0
1365
+ automaticGeo: false
1366
+ automaticLanguage: false
1367
+ automaticLocation: false
1368
+ country: bo
1369
+ timezone: America/La_Paz
1370
+ language: de-CH
1371
+ latitude: 0
1372
+ longitude: 0
1373
+ responses:
1374
+ '200':
1375
+ description: OK
1376
+ content:
1377
+ application/json:
1378
+ schema:
1379
+ type: object
1380
+ properties:
1381
+ code:
1382
+ type: integer
1383
+ description: Return result code:0,Normal Other codes are exceptions.
1384
+ msg:
1385
+ type: string
1386
+ description: Error message
1387
+ requestId:
1388
+ type: string
1389
+ description: Operation Request ID
1390
+ required:
1391
+ - code
1392
+ - msg
1393
+ - requestId
1394
+
1395
+ /cloudphone/delete/batch:
1396
+ post:
1397
+ summary: Delete cloud phone profile
1398
+ operationId: deleteUsingPOST
1399
+ tags:
1400
+ - Cloud Phone
1401
+ parameters:
1402
+ - name: Authorization
1403
+ in: header
1404
+ description: 'Token for request access token interface response access_token field'
1405
+ required: true
1406
+ example: {{Authorization}}
1407
+ schema:
1408
+ type: string
1409
+ requestBody:
1410
+ required: true
1411
+ content:
1412
+ application/json:
1413
+ schema:
1414
+ type: object
1415
+ properties:
1416
+ ids:
1417
+ type: array
1418
+ items:
1419
+ type: string
1420
+ required:
1421
+ - ids
1422
+ example:
1423
+ ids:
1424
+ - '1595755686723985'
1425
+ responses:
1426
+ '200':
1427
+ description: OK
1428
+ content:
1429
+ application/json:
1430
+ schema:
1431
+ type: object
1432
+ properties:
1433
+ code:
1434
+ type: integer
1435
+ description: Return result code 0:Normal Other codes are exceptions.
1436
+ msg:
1437
+ type: string
1438
+ description: Error message
1439
+ requestId:
1440
+ type: string
1441
+ description: Operation Request ID
1442
+ required:
1443
+ - code
1444
+ - msg
1445
+ - requestId
1446
+
1447
+ /cloudphone/newMachine:
1448
+ post:
1449
+ summary: One-click new cloud phone
1450
+ operationId: oneNewUsingPOST
1451
+ tags:
1452
+ - Cloud Phone
1453
+ requestBody:
1454
+ required: true
1455
+ content:
1456
+ application/json:
1457
+ schema:
1458
+ type: object
1459
+ properties:
1460
+ id:
1461
+ type: integer
1462
+ format: int64
1463
+ description: Cloud phone ID
1464
+ brand:
1465
+ type: string
1466
+ description: Brand
1467
+ modelId:
1468
+ type: integer
1469
+ description: Model ID
1470
+ example:
1471
+ id: 1595372958075305
1472
+ responses:
1473
+ '200':
1474
+ description: OK
1475
+ content:
1476
+ application/json:
1477
+ schema:
1478
+ type: object
1479
+ properties:
1480
+ code:
1481
+ type: integer
1482
+ description: 'Response code:0 indicates success, >0 indicates failure'
1483
+ msg:
1484
+ type: string
1485
+ required:
1486
+ - code
1487
+ - msg
1488
+
1489
+ /cloudphone/info:
1490
+ post:
1491
+ summary: Cloud phone - single device details
1492
+ operationId: infoUsingPOST
1493
+ tags:
1494
+ - Cloud Phone
1495
+ parameters:
1496
+ - name: Authorization
1497
+ in: header
1498
+ description: Token for request access token interface response access_token field
1499
+ required: true
1500
+ example: {{Authorization}}
1501
+ schema:
1502
+ type: string
1503
+ requestBody:
1504
+ required: true
1505
+ content:
1506
+ application/json:
1507
+ schema:
1508
+ type: object
1509
+ properties:
1510
+ id:
1511
+ type: integer
1512
+ format: int64
1513
+ description: Cloud phone ID
1514
+ required:
1515
+ - id
1516
+ example:
1517
+ id: 1672532391231745
1518
+ responses:
1519
+ '200':
1520
+ description: OK
1521
+ content:
1522
+ application/json:
1523
+ schema:
1524
+ type: object
1525
+ properties:
1526
+ code:
1527
+ type: integer
1528
+ example: 0
1529
+ msg:
1530
+ type: string
1531
+ nullable: true
1532
+ example: null
1533
+ data:
1534
+ $ref: '#/components/schemas/CloudPhoneDetail'
1535
+ requestId:
1536
+ type: string
1537
+ example: "4d0f4fa68613441e9a11446a6437bb5a"
1538
+ required:
1539
+ - code
1540
+ - msg
1541
+ - data
1542
+ - requestId
1543
+
1544
+ /cloudphone/brand/models:
1545
+ post:
1546
+ summary: Query brand & model list
1547
+ description: Query available brand & model list for given Android version
1548
+ tags:
1549
+ - Cloud Phone
1550
+ parameters:
1551
+ - name: Authorization
1552
+ in: header
1553
+ description: Token for request access token interface response access_token field
1554
+ required: true
1555
+ example: {{Authorization}}
1556
+ schema:
1557
+ type: string
1558
+ requestBody:
1559
+ required: true
1560
+ content:
1561
+ application/json:
1562
+ schema:
1563
+ type: object
1564
+ properties:
1565
+ skuId:
1566
+ type: integer
1567
+ description: Cloud phone product ID
1568
+ required:
1569
+ - skuId
1570
+ example:
1571
+ skuId: 0
1572
+ responses:
1573
+ '200':
1574
+ description: OK
1575
+ content:
1576
+ application/json:
1577
+ schema:
1578
+ type: object
1579
+ properties:
1580
+ code:
1581
+ type: integer
1582
+ msg:
1583
+ type: string
1584
+ requestId:
1585
+ type: string
1586
+ timestamp:
1587
+ type: integer
1588
+ data:
1589
+ type: array
1590
+ items:
1591
+ type: object
1592
+ properties:
1593
+ brand:
1594
+ type: string
1595
+ model:
1596
+ type: string
1597
+
1598
+ /cloudphone/updateAdb:
1599
+ post:
1600
+ summary: Update cloud phone ADB status
1601
+ operationId: updateAdbUsingPOST
1602
+ tags:
1603
+ - Cloud Phone
1604
+ parameters:
1605
+ - name: Authorization
1606
+ in: header
1607
+ description: Token for request access token interface response access_token field
1608
+ required: true
1609
+ example: {{Authorization}}
1610
+ schema:
1611
+ type: string
1612
+ requestBody:
1613
+ required: true
1614
+ content:
1615
+ application/json:
1616
+ schema:
1617
+ type: object
1618
+ properties:
1619
+ enableAdb:
1620
+ type: boolean
1621
+ ids:
1622
+ type: array
1623
+ items:
1624
+ type: integer
1625
+ format: int64
1626
+ required:
1627
+ - enableAdb
1628
+ - ids
1629
+ example:
1630
+ enableAdb: true
1631
+ ids:
1632
+ - 1633612946805630
1633
+ responses:
1634
+ '200':
1635
+ description: OK
1636
+ content:
1637
+ application/json:
1638
+ schema:
1639
+ type: object
1640
+ properties:
1641
+ code:
1642
+ type: integer
1643
+ description: Return result code 0:Normal Other codes are exceptions.
1644
+ msg:
1645
+ type: string
1646
+ description: Error message
1647
+ requestId:
1648
+ type: string
1649
+ description: Operation Request ID
1650
+ required:
1651
+ - code
1652
+ - msg
1653
+ - requestId
1654
+
1655
+ /cloudphone/exeCommand:
1656
+ post:
1657
+ summary: Execute shell command
1658
+ operationId: executeShellCommand
1659
+ tags:
1660
+ - Cloud Phone
1661
+ parameters:
1662
+ - name: Authorization
1663
+ in: header
1664
+ description: Token for request access token interface response access_token field
1665
+ required: true
1666
+ example: {{Authorization}}
1667
+ schema:
1668
+ type: string
1669
+ requestBody:
1670
+ required: true
1671
+ content:
1672
+ application/json:
1673
+ schema:
1674
+ type: object
1675
+ properties:
1676
+ id:
1677
+ type: integer
1678
+ format: int64
1679
+ description: Cloud phone ID
1680
+ command:
1681
+ type: string
1682
+ description: Shell command to execute
1683
+ required:
1684
+ - id
1685
+ - command
1686
+ example:
1687
+ command: am start -n com.android.chrome/com.google.android.apps.chrome.Main
1688
+ id: 1674153897828425
1689
+ responses:
1690
+ '200':
1691
+ description: OK
1692
+ content:
1693
+ application/json:
1694
+ schema:
1695
+ type: object
1696
+ properties:
1697
+ code:
1698
+ type: integer
1699
+ description: 'Response code: 0 indicates success, >0 indicates failure'
1700
+ data:
1701
+ type: string
1702
+ description: Response Information
1703
+ msg:
1704
+ type: string
1705
+ description: Response message:An error message will be returned when code is greater than 0
1706
+ required:
1707
+ - code
1708
+ - data
1709
+ - msg
1710
+ /cloudphone/rpa/template/market/page:
1711
+ post:
1712
+ summary: Get market template pages
1713
+ deprecated: false
1714
+ description: Query Schedules market template, template name supports fuzzy query
1715
+ tags:
1716
+ - Cloud Phone/Schedules management
1717
+ parameters:
1718
+ - name: Authorization
1719
+ in: header
1720
+ description: Token for request access token interface response access_token field
1721
+ required: true
1722
+ example: {{Authorization}}
1723
+ schema:
1724
+ type: string
1725
+ requestBody:
1726
+ content:
1727
+ application/json:
1728
+ schema:
1729
+ type: object
1730
+ properties:
1731
+ searchKey:
1732
+ type: string
1733
+ description: Template Name
1734
+ nullable: true
1735
+ pageNo:
1736
+ type: integer
1737
+ description: Default:1
1738
+ nullable: true
1739
+ pageSize:
1740
+ type: integer
1741
+ description: Default:10
1742
+ nullable: true
1743
+ example:
1744
+ pageNo: 0
1745
+ pageSize: 0
1746
+ searchWords: ''
1747
+ required: true
1748
+ responses:
1749
+ '200':
1750
+ description: ''
1751
+ content:
1752
+ application/json:
1753
+ schema:
1754
+ type: object
1755
+ properties:
1756
+ code:
1757
+ type: integer
1758
+ description: Response code, 0 indicates success,>0 indicates failure
1759
+ msg:
1760
+ type: string
1761
+ description: Error msg
1762
+ requestId:
1763
+ type: string
1764
+ description: Request trace id
1765
+ data:
1766
+ type: object
1767
+ properties:
1768
+ dataList:
1769
+ type: array
1770
+ items:
1771
+ type: object
1772
+ properties:
1773
+ id:
1774
+ type: integer
1775
+ title:
1776
+ type: string
1777
+ description: Market template title
1778
+ parameter:
1779
+ type: string
1780
+ description: Template parameter JSON string
1781
+ description:
1782
+ type: string
1783
+ description: Market template Description
1784
+ appIconUrls:
1785
+ type: array
1786
+ items:
1787
+ type: string
1788
+ sort:
1789
+ type: integer
1790
+ description: sort
1791
+ author:
1792
+ type: string
1793
+ description: author
1794
+ updateDate:
1795
+ type: string
1796
+ description: Last update time
1797
+ required:
1798
+ - parameter
1799
+ current:
1800
+ type: integer
1801
+ description: Current page number
1802
+ pages:
1803
+ type: integer
1804
+ description: Total pages
1805
+ total:
1806
+ type: integer
1807
+ description: Total count
1808
+ required:
1809
+ - current
1810
+ - dataList
1811
+ - pages
1812
+ - total
1813
+ required:
1814
+ - code
1815
+ - msg
1816
+ - data
1817
+ - requestId
1818
+ example:
1819
+ code: 0
1820
+ msg: ''
1821
+ data:
1822
+ current: 0
1823
+ dataList:
1824
+ - appIconUrls: []
1825
+ author: ''
1826
+ description: ''
1827
+ parameter: ''
1828
+ id: 0
1829
+ sort: 0
1830
+ title: ''
1831
+ type: 0
1832
+ updateDate: ''
1833
+ pages: 0
1834
+ total: 0
1835
+ headers: {}
1836
+ security: []
1837
+ /cloudphone/rpa/template/personal/page:
1838
+ post:
1839
+ summary: Get Personal template pages
1840
+ deprecated: false
1841
+ description: Query Schedules market template, template name supports fuzzy query
1842
+ tags:
1843
+ - Cloud Phone/Schedules management
1844
+ parameters:
1845
+ - name: Authorization
1846
+ in: header
1847
+ description: Token for request access token interface response access_token field
1848
+ required: true
1849
+ example: {{Authorization}}
1850
+ schema:
1851
+ type: string
1852
+ requestBody:
1853
+ content:
1854
+ application/json:
1855
+ schema:
1856
+ type: object
1857
+ properties:
1858
+ searchKey:
1859
+ type: string
1860
+ description: Template name
1861
+ nullable: true
1862
+ desc:
1863
+ type: string
1864
+ description: Template description
1865
+ pageNo:
1866
+ type: integer
1867
+ description: Default:1
1868
+ nullable: true
1869
+ pageSize:
1870
+ type: integer
1871
+ description: Default:10
1872
+ nullable: true
1873
+ example:
1874
+ pageNo: 1
1875
+ pageSize: 10
1876
+ searchWords: ''
1877
+ required: true
1878
+ responses:
1879
+ '200':
1880
+ description: ''
1881
+ content:
1882
+ application/json:
1883
+ schema:
1884
+ type: object
1885
+ properties:
1886
+ code:
1887
+ type: integer
1888
+ description: Response code, 0 indicates success,>0 indicates failure
1889
+ msg:
1890
+ type: string
1891
+ description: Error msg
1892
+ requestId:
1893
+ type: string
1894
+ description: Request trace id
1895
+ data:
1896
+ type: object
1897
+ properties:
1898
+ dataList:
1899
+ type: array
1900
+ items:
1901
+ type: object
1902
+ properties:
1903
+ id:
1904
+ type: integer
1905
+ title:
1906
+ type: string
1907
+ description: Market template title
1908
+ parameter:
1909
+ type: string
1910
+ description: Template parameter JSON string
1911
+ description:
1912
+ type: string
1913
+ description: Market template Description
1914
+ appIconUrls:
1915
+ type: array
1916
+ items:
1917
+ type: string
1918
+ sort:
1919
+ type: integer
1920
+ description: sort
1921
+ updateDate:
1922
+ type: string
1923
+ description: Last update time
1924
+ current:
1925
+ type: integer
1926
+ description: Current page number
1927
+ pages:
1928
+ type: integer
1929
+ description: Total pages
1930
+ total:
1931
+ type: integer
1932
+ description: Total count
1933
+ required:
1934
+ - current
1935
+ - dataList
1936
+ - pages
1937
+ - total
1938
+ required:
1939
+ - code
1940
+ - msg
1941
+ - data
1942
+ - requestId
1943
+ example:
1944
+ code: 0
1945
+ msg: ''
1946
+ data:
1947
+ current: 0
1948
+ dataList:
1949
+ - id: 0
1950
+ title: ''
1951
+ appIconUrls: []
1952
+ author: ''
1953
+ description: ''
1954
+ parameter: ''
1955
+ sort: 0
1956
+ updateDate: ''
1957
+ pages: 0
1958
+ total: 0
1959
+ headers: {}
1960
+ security: []
1961
+ /cloudphone/rpa/task/page:
1962
+ post:
1963
+ summary: Get a schedules list
1964
+ deprecated: false
1965
+ description: ''
1966
+ tags:
1967
+ - Cloud Phone/Schedules management
1968
+ parameters:
1969
+ - name: Authorization
1970
+ in: header
1971
+ description: Token for request access token interface response access_token field
1972
+ required: true
1973
+ example: {{Authorization}}
1974
+ schema:
1975
+ type: string
1976
+ - name: enabled
1977
+ in: query
1978
+ description: Is the plan enabled
1979
+ required: false
1980
+ example: 'false'
1981
+ schema:
1982
+ type: boolean
1983
+ nullable: true
1984
+ - name: mainTaskName
1985
+ in: query
1986
+ description: plan name
1987
+ required: false
1988
+ schema:
1989
+ type: string
1990
+ maxLength: 150
1991
+ minLength: 1
1992
+ nullable: true
1993
+ - name: taskState
1994
+ in: query
1995
+ description: >-
1996
+ Plan status; 0:awaiting execution; 1:Executing; 2:Execution
1997
+ completed 3:Cancel
1998
+ required: false
1999
+ schema:
2000
+ type: integer
2001
+ maximum: 3
2002
+ nullable: true
2003
+ - name: templateTitle
2004
+ in: query
2005
+ description: Template Title
2006
+ required: false
2007
+ schema:
2008
+ type: string
2009
+ maxLength: 150
2010
+ minLength: 0
2011
+ nullable: true
2012
+ - name: pageNo
2013
+ in: query
2014
+ description: default:1
2015
+ required: false
2016
+ schema:
2017
+ type: string
2018
+ - name: pageSize
2019
+ in: query
2020
+ description: default:20
2021
+ required: false
2022
+ schema:
2023
+ type: string
2024
+ requestBody:
2025
+ content:
2026
+ application/json:
2027
+ schema:
2028
+ type: object
2029
+ properties:
2030
+ enabled:
2031
+ type: boolean
2032
+ description: Is the plan enabled
2033
+ nullable: true
2034
+ taskName:
2035
+ type: string
2036
+ description: Plan name
2037
+ nullable: true
2038
+ templateTitle:
2039
+ type: string
2040
+ description: Template title
2041
+ nullable: true
2042
+ taskState:
2043
+ type: integer
2044
+ description: |
2045
+ Schedule status; 0:awaiting execution; 1:Executing; 2:Execution completed 3:Cancel
2046
+ nullable: true
2047
+ pageNo:
2048
+ type: integer
2049
+ description: default:1
2050
+ nullable: true
2051
+ pageSize:
2052
+ type: integer
2053
+ description: default:10
2054
+ nullable: true
2055
+ example: |-
2056
+ {
2057
+ "pageNo": 1,
2058
+ "pageSize": 10,
2059
+ }
2060
+ required: true
2061
+ responses:
2062
+ '200':
2063
+ description: ''
2064
+ content:
2065
+ application/json:
2066
+ schema:
2067
+ type: object
2068
+ properties:
2069
+ code:
2070
+ type: integer
2071
+ description: Response code, 0 indicates success,>0 indicates failure
2072
+ msg:
2073
+ type: string
2074
+ description: Error msg
2075
+ requestId:
2076
+ type: string
2077
+ description: Request trace id
2078
+ data:
2079
+ type: object
2080
+ properties:
2081
+ dataList:
2082
+ type: array
2083
+ items:
2084
+ type: object
2085
+ properties:
2086
+ id:
2087
+ type: integer
2088
+ description: Schedule id
2089
+ taskName:
2090
+ type: string
2091
+ description: Schedule Task name
2092
+ createMember:
2093
+ type: string
2094
+ description: Member name
2095
+ enabled:
2096
+ type: boolean
2097
+ description: Whether enabled
2098
+ endTime:
2099
+ type: string
2100
+ description: Task end time
2101
+ failCount:
2102
+ type: integer
2103
+ description: Number of failed executions
2104
+ handleTime:
2105
+ type: string
2106
+ description: Execution start time
2107
+ notes:
2108
+ type: string
2109
+ description: schedule notes
2110
+ scheduleConfig:
2111
+ type: string
2112
+ description: Task schedule configuration
2113
+ successCount:
2114
+ type: integer
2115
+ description: Number of successful executions
2116
+ taskPreviewTimeTable:
2117
+ type: array
2118
+ items:
2119
+ type: object
2120
+ properties:
2121
+ cloudPhoneId:
2122
+ type: integer
2123
+ description: Cloud phone ID
2124
+ cloudPhoneName:
2125
+ type: string
2126
+ description: Cloud phone name
2127
+ times:
2128
+ type: array
2129
+ items:
2130
+ type: string
2131
+ description: List of execution times
2132
+ taskState:
2133
+ type: integer
2134
+ description: >-
2135
+ Schedule Task state. 0:waiting; 1:running;
2136
+ 2:completed 3:Cancel
2137
+ templateId:
2138
+ type: integer
2139
+ description: Template id
2140
+ templateTitle:
2141
+ type: string
2142
+ description: Template title
2143
+ required:
2144
+ - createMember
2145
+ description: Plan list
2146
+ current:
2147
+ type: integer
2148
+ description: Current page number
2149
+ pages:
2150
+ type: integer
2151
+ description: Total pages
2152
+ total:
2153
+ type: integer
2154
+ description: Total count
2155
+ required:
2156
+ - current
2157
+ - dataList
2158
+ - pages
2159
+ - total
2160
+ required:
2161
+ - code
2162
+ - data
2163
+ - msg
2164
+ - requestId
2165
+ example:
2166
+ code: 0
2167
+ data:
2168
+ current: 0
2169
+ dataList:
2170
+ - createMember: ''
2171
+ enabled: true
2172
+ endTime: ''
2173
+ failCount: 0
2174
+ handleTime: ''
2175
+ id: 0
2176
+ notes: ''
2177
+ scheduleConfig: ''
2178
+ successCount: 0
2179
+ taskName: ''
2180
+ taskPreviewTimeTable:
2181
+ - billingType: 0
2182
+ cloudPhoneId: 0
2183
+ cloudPhoneName: ''
2184
+ times:
2185
+ - ''
2186
+ taskState: 0
2187
+ templateId: 0
2188
+ templateTitle: ''
2189
+ pages: 0
2190
+ total: 0
2191
+ msg: ''
2192
+ headers: {}
2193
+ security: []
2194
+ /cloudphone/rpa/task/save:
2195
+ post:
2196
+ summary: Creating a schedule
2197
+ deprecated: false
2198
+ description: ''
2199
+ tags:
2200
+ - Cloud Phone/Schedules management
2201
+ parameters:
2202
+ - name: Authorization
2203
+ in: header
2204
+ description: Token for request access token interface response access_token field
2205
+ required: true
2206
+ example: {{Authorization}}
2207
+ schema:
2208
+ type: string
2209
+ requestBody:
2210
+ content:
2211
+ application/json:
2212
+ schema:
2213
+ type: object
2214
+ properties:
2215
+ taskName:
2216
+ type: string
2217
+ description: Task name
2218
+ templateId:
2219
+ type: integer
2220
+ description: Template ID
2221
+ templateType:
2222
+ type: string
2223
+ description: Template type. PERSONAL:personal; MARKET:marketplace
2224
+ taskType:
2225
+ type: string
2226
+ description: Task type. TEMPORARY or SCHEDULED
2227
+ notes:
2228
+ type: string
2229
+ description: Plan notes
2230
+ cloudPhoneConfigs:
2231
+ type: array
2232
+ items:
2233
+ type: object
2234
+ properties:
2235
+ cloudPhoneId:
2236
+ type: integer
2237
+ description: Cloud phone ID
2238
+ triggerTime:
2239
+ type: string
2240
+ description: Task execution time, UTC+0 time zone
2241
+ templateParameter:
2242
+ type: string
2243
+ description: Template parameters
2244
+ required:
2245
+ - cloudPhoneId
2246
+ - triggerTime
2247
+ - templateParameter
2248
+ description: Collection of cloud phone schedule configurations
2249
+ scheduleConfig:
2250
+ type: object
2251
+ properties:
2252
+ endTime:
2253
+ type: string
2254
+ description: date-time
2255
+ scheduleType:
2256
+ type: string
2257
+ description: Schedule type. ONCE:one-time; DAILY:daily
2258
+ timezone:
2259
+ type: string
2260
+ description: Timezone
2261
+ required:
2262
+ - endTime
2263
+ - scheduleType
2264
+ - timezone
2265
+ description: Task schedule configuration
2266
+ required:
2267
+ - cloudPhoneConfigs
2268
+ - scheduleConfig
2269
+ - taskName
2270
+ - taskType
2271
+ - templateId
2272
+ - templateType
2273
+ example:
2274
+ cloudPhoneConfigs:
2275
+ - cloudPhoneId: 1678331966138097
2276
+ templateParameter: {"keyword":"abc"}
2277
+ triggerTime: 2025-12-29 23:00:00
2278
+ notes: notes test
2279
+ scheduleConfig:
2280
+ endTime: 2025-12-30 00:00:00
2281
+ scheduleType: ONCE
2282
+ taskName: test
2283
+ templateId: 1678347487160296
2284
+ templateType: PERSONAL
2285
+ required: true
2286
+ responses:
2287
+ '200':
2288
+ description: ''
2289
+ content:
2290
+ application/json:
2291
+ schema:
2292
+ type: object
2293
+ properties:
2294
+ code:
2295
+ type: integer
2296
+ description: Response code, 0 indicates success,>0 indicates failure
2297
+ msg:
2298
+ type: string
2299
+ description: Error msg
2300
+ requestId:
2301
+ type: string
2302
+ description: Request trace id
2303
+ data:
2304
+ type: integer
2305
+ description: Schedules id
2306
+ required:
2307
+ - code
2308
+ - data
2309
+ - msg
2310
+ - requestId
2311
+ example:
2312
+ code: 0
2313
+ data: 0
2314
+ msg: ''
2315
+ headers: {}
2316
+ security: []
2317
+ /cloudphone/rpa/task/cancel:
2318
+ post:
2319
+ summary: Cancel schedule
2320
+ deprecated: false
2321
+ description: ''
2322
+ tags:
2323
+ - Cloud Phone/Schedules management
2324
+ parameters:
2325
+ - name: Authorization
2326
+ in: header
2327
+ description: Token for request access token interface response access_token field
2328
+ required: true
2329
+ example: {{Authorization}}
2330
+ schema:
2331
+ type: string
2332
+ - name: id
2333
+ in: query
2334
+ description: ''
2335
+ required: true
2336
+ schema:
2337
+ type: integer
2338
+ requestBody:
2339
+ content:
2340
+ application/json:
2341
+ schema:
2342
+ type: object
2343
+ properties:
2344
+ id:
2345
+ type: integer
2346
+ description: Plan id
2347
+ required:
2348
+ - id
2349
+ example:
2350
+ id: 1678919049331329
2351
+ required: true
2352
+ responses:
2353
+ '200':
2354
+ description: ''
2355
+ content:
2356
+ application/json:
2357
+ schema:
2358
+ type: object
2359
+ properties:
2360
+ code:
2361
+ type: integer
2362
+ description: Response code, 0 indicates success,>0 indicates failure
2363
+ msg:
2364
+ type: string
2365
+ description: Error msg
2366
+ requestId:
2367
+ type: string
2368
+ description: Request trace id
2369
+ required:
2370
+ - code
2371
+ - data
2372
+ - msg
2373
+ - requestId
2374
+ example:
2375
+ code: 0
2376
+ data: null
2377
+ msg: ''
2378
+ headers: {}
2379
+ security: []
2380
+ /cloudphone/rpa/subTask/page:
2381
+ post:
2382
+ summary: Page query task executions record
2383
+ deprecated: false
2384
+ description: Query Schedules market template, template name supports fuzzy query
2385
+ tags:
2386
+ - Cloud Phone/Schedules management
2387
+ parameters:
2388
+ - name: Authorization
2389
+ in: header
2390
+ description: Token for request access token interface response access_token field
2391
+ required: true
2392
+ example: {{Authorization}}
2393
+ schema:
2394
+ type: string
2395
+ requestBody:
2396
+ content:
2397
+ application/json:
2398
+ schema:
2399
+ type: object
2400
+ properties:
2401
+ taskId:
2402
+ type: integer
2403
+ description: Task id
2404
+ nullable: true
2405
+ taskName:
2406
+ type: string
2407
+ description: Task name
2408
+ maxLength: 255
2409
+ minLength: 1
2410
+ nullable: true
2411
+ taskState:
2412
+ type: integer
2413
+ description: >-
2414
+ Plan status; 0:awaiting execution; 1:Executing; 2:Execution
2415
+ completed 3:Cancel
2416
+ maximum: 9
2417
+ minimum: 0
2418
+ nullable: true
2419
+ templateId:
2420
+ type: integer
2421
+ description: Template id
2422
+ maximum: 99999999999
2423
+ minimum: 0
2424
+ nullable: true
2425
+ templateTitle:
2426
+ type: string
2427
+ description: Template title
2428
+ maxLength: 255
2429
+ minLength: 0
2430
+ nullable: true
2431
+ cloudPhoneId:
2432
+ type: integer
2433
+ description: cloud phone id
2434
+ nullable: true
2435
+ example: 1559133625483282
2436
+ cloudPhoneName:
2437
+ type: string
2438
+ description: Cloud phone name
2439
+ maxLength: 100
2440
+ minLength: 0
2441
+ nullable: true
2442
+ beginTime:
2443
+ type: string
2444
+ description: Task start time UTC+0 time zone
2445
+ nullable: true
2446
+ example: 2025-01-01 23:59:59
2447
+ endTime:
2448
+ type: string
2449
+ description: |
2450
+ Task end time UTC+0 time zone
2451
+ nullable: true
2452
+ example: 2025-01-02 23:59:59
2453
+ pageNo:
2454
+ type: integer
2455
+ description: Default:1
2456
+ nullable: true
2457
+ example: 1
2458
+ pageSize:
2459
+ type: integer
2460
+ description: Default:10
2461
+ nullable: true
2462
+ example:
2463
+ pageNo: 1
2464
+ pageSize: 10
2465
+ required: true
2466
+ responses:
2467
+ '200':
2468
+ description: ''
2469
+ content:
2470
+ application/json:
2471
+ schema:
2472
+ type: object
2473
+ properties:
2474
+ code:
2475
+ type: integer
2476
+ description: Response code, 0 indicates success,>0 indicates failure
2477
+ msg:
2478
+ type: string
2479
+ description: Error msg
2480
+ requestId:
2481
+ type: string
2482
+ description: Request trace id
2483
+ data:
2484
+ type: object
2485
+ properties:
2486
+ dataList:
2487
+ type: array
2488
+ items:
2489
+ $ref: '#/components/schemas/Execution DTO'
2490
+ current:
2491
+ type: integer
2492
+ description: Current page number
2493
+ pages:
2494
+ type: integer
2495
+ description: Total pages
2496
+ total:
2497
+ type: integer
2498
+ description: Total count
2499
+ required:
2500
+ - current
2501
+ - dataList
2502
+ - pages
2503
+ - total
2504
+ required:
2505
+ - code
2506
+ - msg
2507
+ - data
2508
+ - requestId
2509
+ example:
2510
+ code: 0
2511
+ msg: ''
2512
+ data:
2513
+ current: 0
2514
+ dataList:
2515
+ - appIconUrls: []
2516
+ author: ''
2517
+ description: ''
2518
+ id: 0
2519
+ sort: 0
2520
+ title: ''
2521
+ type: 0
2522
+ updateDate: ''
2523
+ pages: 0
2524
+ total: 0
2525
+ headers: {}
2526
+ security: []
2527
+ /cloudphone/rpa/subTask/detail/{id}:
2528
+ post:
2529
+ summary: Get a task execution
2530
+ deprecated: false
2531
+ description: Query Schedules market template, template name supports fuzzy query
2532
+ tags:
2533
+ - Cloud Phone/Schedules management
2534
+ parameters:
2535
+ - name: Authorization
2536
+ in: header
2537
+ description: Token for request access token interface response access_token field
2538
+ required: true
2539
+ example: {{Authorization}}
2540
+ schema:
2541
+ type: string
2542
+ - name: id
2543
+ in: path
2544
+ description: Execution task id
2545
+ required: true
2546
+ example: 1678919049331331
2547
+ schema:
2548
+ type: integer
2549
+ requestBody:
2550
+ content:
2551
+ application/json:
2552
+ schema:
2553
+ type: object
2554
+ properties:
2555
+ taskId:
2556
+ type: integer
2557
+ description: Task id
2558
+ nullable: true
2559
+ taskName:
2560
+ type: string
2561
+ description: Task name
2562
+ maxLength: 255
2563
+ minLength: 1
2564
+ nullable: true
2565
+ taskState:
2566
+ type: integer
2567
+ description: >-
2568
+ Plan status; 0:awaiting execution; 1:Executing; 2:Execution
2569
+ completed 3:Cancel
2570
+ maximum: 9
2571
+ minimum: 0
2572
+ nullable: true
2573
+ templateId:
2574
+ type: integer
2575
+ description: Template id
2576
+ maximum: 99999999999
2577
+ minimum: 0
2578
+ nullable: true
2579
+ templateTitle:
2580
+ type: string
2581
+ description: Template title
2582
+ maxLength: 255
2583
+ minLength: 0
2584
+ nullable: true
2585
+ cloudPhoneId:
2586
+ type: integer
2587
+ description: cloud phone id
2588
+ nullable: true
2589
+ example: 1559133625483282
2590
+ cloudPhoneName:
2591
+ type: string
2592
+ description: Cloud phone name
2593
+ maxLength: 100
2594
+ minLength: 0
2595
+ nullable: true
2596
+ beginTime:
2597
+ type: string
2598
+ description: Task start time UTC+0 time zone
2599
+ nullable: true
2600
+ example: 2025-01-01 23:59:59
2601
+ endTime:
2602
+ type: string
2603
+ description: |
2604
+ Task end time UTC+0 time zone
2605
+ nullable: true
2606
+ example: 2025-01-02 23:59:59
2607
+ pageNo:
2608
+ type: integer
2609
+ description: Default:1
2610
+ nullable: true
2611
+ example: 1
2612
+ pageSize:
2613
+ type: integer
2614
+ description: Default:10
2615
+ nullable: true
2616
+ example: ''
2617
+ required: true
2618
+ responses:
2619
+ '200':
2620
+ description: ''
2621
+ content:
2622
+ application/json:
2623
+ schema:
2624
+ type: object
2625
+ properties:
2626
+ code:
2627
+ type: integer
2628
+ description: Response code, 0 indicates success,>0 indicates failure
2629
+ msg:
2630
+ type: string
2631
+ description: Error msg
2632
+ requestId:
2633
+ type: string
2634
+ description: Request trace id
2635
+ data:
2636
+ type: object
2637
+ properties:
2638
+ id:
2639
+ type: integer
2640
+ description: Execution record id
2641
+ taskName:
2642
+ type: string
2643
+ description: Schedule Task name
2644
+ taskState:
2645
+ type: integer
2646
+ description: >-
2647
+ Schedule status; 0:awaiting execution; 1:Executing;
2648
+ 2:Execution completed 3:Cancel
2649
+ cloudPhoneId:
2650
+ type: integer
2651
+ description: Cloud phone ID
2652
+ cloudPhoneName:
2653
+ type: string
2654
+ description: Cloud phone name
2655
+ templateName:
2656
+ type: string
2657
+ description: Template title
2658
+ handleFailCode:
2659
+ type: string
2660
+ description: Task failure code
2661
+ handleFailReason:
2662
+ type: string
2663
+ description: Task failure reason
2664
+ handleResult:
2665
+ type: integer
2666
+ description: Task result. 0:failed; 1:succeeded
2667
+ handleResultAttachment:
2668
+ type: string
2669
+ description: Task execution result attachment
2670
+ handleTime:
2671
+ type: string
2672
+ description: Execution time
2673
+ endTime:
2674
+ type: string
2675
+ description: Task end time
2676
+ powerOnTime:
2677
+ type: string
2678
+ description: Cloud phone power-on time
2679
+ triggerNextTime:
2680
+ type: string
2681
+ description: Next scheduled trigger time
2682
+ triggerTime:
2683
+ type: string
2684
+ description: Scheduled trigger time
2685
+ createDate:
2686
+ type: string
2687
+ description: Creation time
2688
+ createMember:
2689
+ type: string
2690
+ description: Creator
2691
+ updateDate:
2692
+ type: string
2693
+ description: Last update time
2694
+ updateMember:
2695
+ type: string
2696
+ description: Last updater
2697
+ required:
2698
+ - code
2699
+ - msg
2700
+ - data
2701
+ - requestId
2702
+ example:
2703
+ code: 0
2704
+ msg: ''
2705
+ data:
2706
+ current: 0
2707
+ dataList:
2708
+ - appIconUrls: []
2709
+ author: ''
2710
+ description: ''
2711
+ id: 0
2712
+ sort: 0
2713
+ title: ''
2714
+ type: 0
2715
+ updateDate: ''
2716
+ pages: 0
2717
+ total: 0
2718
+ headers: {}
2719
+ security: []
2720
+ /cloudphone/rpa/subTask/cancel/{id}:
2721
+ post:
2722
+ summary: Cancel execution
2723
+ deprecated: false
2724
+ description: ''
2725
+ tags:
2726
+ - Cloud Phone/Schedules management
2727
+ parameters:
2728
+ - name: id
2729
+ in: path
2730
+ description: ''
2731
+ required: true
2732
+ schema:
2733
+ type: string
2734
+ requestBody:
2735
+ content:
2736
+ application/json:
2737
+ schema:
2738
+ type: object
2739
+ properties:
2740
+ id:
2741
+ type: integer
2742
+ description: Plan id
2743
+ required:
2744
+ - id
2745
+ example:
2746
+ id: 1678919049331329
2747
+ required: true
2748
+ responses:
2749
+ '200':
2750
+ description: ''
2751
+ content:
2752
+ application/json:
2753
+ schema:
2754
+ type: object
2755
+ properties:
2756
+ code:
2757
+ type: integer
2758
+ description: Response code, 0 indicates success,>0 indicates failure
2759
+ msg:
2760
+ type: string
2761
+ description: Error msg
2762
+ requestId:
2763
+ type: string
2764
+ description: Request trace id
2765
+ required:
2766
+ - code
2767
+ - data
2768
+ - msg
2769
+ - requestId
2770
+ example:
2771
+ code: 0
2772
+ data: null
2773
+ msg: ''
2774
+ headers: {}
2775
+ security: []
2776
+ /proxyInfo/page:
2777
+ post:
2778
+ summary: Getting a list of proxies
2779
+ deprecated: false
2780
+ description: ""
2781
+ operationId: queryProxyInfoPageUsingPOST
2782
+ tags:
2783
+ - Proxy Management
2784
+ parameters:
2785
+ - name: Authorization
2786
+ in: header
2787
+ description: Token for request access token interface response access_token field
2788
+ required: true
2789
+ example: {{Authorization}}
2790
+ schema:
2791
+ type: string
2792
+ requestBody:
2793
+ required: true
2794
+ content:
2795
+ application/json:
2796
+ schema:
2797
+ type: object
2798
+ properties:
2799
+ pageNo:
2800
+ type: integer
2801
+ description: Current page number (starts from 1)
2802
+ example: 1
2803
+ pageSize:
2804
+ type: integer
2805
+ description: Number of items per page
2806
+ example: 10
2807
+ isCloudPhoneProxy:
2808
+ type: boolean
2809
+ description: |
2810
+ Whether the proxy is for cloud phone usage.
2811
+ - `true`: Exclude local/private IPs (e.g., 127.0.0.1, 360, pia, private ranges)
2812
+ - `false`: Return all proxies
2813
+ example: false
2814
+ proxyCategoryType:
2815
+ type: integer
2816
+ description: |
2817
+ Proxy category type:
2818
+ - `1` = Cloud platform
2819
+ - `2` = Self-owned IP
2820
+ example: 2
2821
+ proxyIp:
2822
+ type: string
2823
+ description: Filter by proxy IP address (partial match)
2824
+ example: ""
2825
+ proxyName:
2826
+ type: string
2827
+ description: Filter by proxy name (partial match)
2828
+ example: ""
2829
+ proxyProviders:
2830
+ type: array
2831
+ items:
2832
+ type: integer
2833
+ description: |
2834
+ List of proxy provider IDs. Supported values:
2835
+ - `0` = None
2836
+ - `4` = Oxylabs
2837
+ - `5` = Proxys.io
2838
+ - `6` = GeoSurf
2839
+ - `7` = Luminati
2840
+ - `8` = Lumauto
2841
+ - `9` = Oxylabsauto
2842
+ - `10` = Trojan
2843
+ - `11` = Shadowsocks
2844
+ - `12` = vmess
2845
+ - `13` = ABCPROXY
2846
+ - `14` = LunaProxy
2847
+ - `15` = IPHTML
2848
+ - `16` = PiaProxy
2849
+ - `17` = 922S5
2850
+ example: []
2851
+ proxyStatus:
2852
+ type: integer
2853
+ description: |
2854
+ Proxy assignment status:
2855
+ - `0` = Normal
2856
+ - `1` = Unassigned
2857
+ - `2` = Upgrading
2858
+ - `3` = Expired
2859
+ - `4` = Expiring soon
2860
+ > Note: Self-owned proxies always use status `1`.
2861
+ example: 1
2862
+ proxyCheckStatus:
2863
+ type: integer
2864
+ description: |
2865
+ Proxy health check status:
2866
+ - `0` = Pending
2867
+ - `1` = Success
2868
+ - `2` = Failed
2869
+ - `3` = Unknown error
2870
+ example: 1
2871
+ proxyTypes:
2872
+ type: array
2873
+ items:
2874
+ type: integer
2875
+ description: |
2876
+ Proxy protocol types:
2877
+ - `0` = HTTP
2878
+ - `1` = HTTPS
2879
+ - `2` = SOCKS5
2880
+ - `3` = SSH
2881
+ example: []
2882
+ required: []
2883
+ example:
2884
+ pageNo: 1
2885
+ pageSize: 10
2886
+ isCloudPhoneProxy: false
2887
+ proxyCategoryType: 2
2888
+ proxyIp: ""
2889
+ proxyName: ""
2890
+ proxyProviders: []
2891
+ proxyStatus: 1
2892
+ proxyCheckStatus: 1
2893
+ proxyTypes: []
2894
+ responses:
2895
+ "200":
2896
+ description: ""
2897
+ content:
2898
+ application/json:
2899
+ schema:
2900
+ type: object
2901
+ properties:
2902
+ code:
2903
+ description: Return result code 0:Normal Other codes are exceptions.
2904
+ type: integer
2905
+ msg:
2906
+ description: Error message
2907
+ type: string
2908
+ data:
2909
+ type: object
2910
+ properties:
2911
+ current:
2912
+ type: integer
2913
+ dataList:
2914
+ type: array
2915
+ items:
2916
+ type: object
2917
+ properties:
2918
+ expiryTime:
2919
+ description: Expiration time
2920
+ type: integer
2921
+ id:
2922
+ description: Primary key
2923
+ type: integer
2924
+ proxyCategoryType:
2925
+ description: Proxy type 1:Platform proxy; 2:Self-owned proxy
2926
+ type: integer
2927
+ proxyCheckStatus:
2928
+ description: Detection status 0-pending detection 1-monitoring success 2-detection failure 3-unknown error
2929
+ type: integer
2930
+ proxyIp:
2931
+ description: Proxy IP
2932
+ type: string
2933
+ exportIp:
2934
+ description: export IP
2935
+ type: string
2936
+ countryCode:
2937
+ description: countryCode
2938
+ type: string
2939
+ proxyName:
2940
+ description: Proxy Name
2941
+ type: string
2942
+ proxyProvider:
2943
+ description: |
2944
+ Proxy Provider:default value 0 - none 4-Oxylabs 5-Proxys.io 7-Luminati 8-Lumauto 9-Oxylabsauto 10-Trojan,11-Shadowsocks 13-ABCPROXY 14-LunaProxy 15-IPHTML 16-PiaProxy 17-922S5
2945
+ type: integer
2946
+ proxyType:
2947
+ description: Proxy Type:0-http 1-https 2-socks5 3-ssh
2948
+ type: integer
2949
+ username:
2950
+ description: Proxy username
2951
+ type: string
2952
+ password:
2953
+ description: Proxy password
2954
+ type: string
2955
+ refreshUrl:
2956
+ description: Proxy refresh URL
2957
+ type: string
2958
+ pages:
2959
+ type: integer
2960
+ total:
2961
+ type: integer
2962
+ required:
2963
+ - current
2964
+ - dataList
2965
+ - pages
2966
+ - total
2967
+ requestId:
2968
+ description: Operation Request ID
2969
+ type: string
2970
+ required:
2971
+ - code
2972
+ - msg
2973
+ - data
2974
+ - requestId
2975
+ headers: {}
2976
+ security: []
2977
+
2978
+ /proxyInfo/add:
2979
+ post:
2980
+ summary: Adding proxy
2981
+ deprecated: false
2982
+ description: ""
2983
+ operationId: addUsingPOST
2984
+ tags:
2985
+ - Proxy Management
2986
+ parameters:
2987
+ - name: Authorization
2988
+ in: header
2989
+ description: Token for request access token interface response access_token field
2990
+ required: true
2991
+ example: {{Authorization}}
2992
+ schema:
2993
+ type: string
2994
+ requestBody:
2995
+ required: true
2996
+ content:
2997
+ application/json:
2998
+ schema:
2999
+ type: object
3000
+ properties:
3001
+ city:
3002
+ type: string
3003
+ description: City
3004
+ example: ""
3005
+ country:
3006
+ type: string
3007
+ description: |
3008
+ Country code (ISO 3166-1 alpha-2). Required only if proxyProvider=17.
3009
+ example: "AD"
3010
+ encryptionType:
3011
+ type: integer
3012
+ format: int32
3013
+ description: Encryption type, valid values are integers from 1 to 14.
3014
+ example: 14
3015
+ ipChangeAction:
3016
+ type: integer
3017
+ format: int32
3018
+ description: Action on IP change:0 = Block, 1 = Warn
3019
+ example: 1
3020
+ ipMonitor:
3021
+ type: boolean
3022
+ description: Enable IP change monitoring
3023
+ example: false
3024
+ password:
3025
+ type: string
3026
+ description: Password for proxy authentication
3027
+ example: ""
3028
+ proxyIp:
3029
+ type: string
3030
+ description: Proxy IP address
3031
+ example: "8.10.22.46"
3032
+ proxyName:
3033
+ type: string
3034
+ description: Proxy name (supports placeholders like {{random}})
3035
+ example: "sock5_{{random}}"
3036
+ proxyPort:
3037
+ type: integer
3038
+ format: int32
3039
+ description: Proxy port number
3040
+ example: 65534
3041
+ proxyProvider:
3042
+ type: integer
3043
+ format: int32
3044
+ description: |
3045
+ Proxy provider type:
3046
+ 0=HTTP, 1=HTTPS, 2=SOCKS5, 3=SSH, 4=Oxylabs, ..., 17=922S5.
3047
+ Special rules:
3048
+ - If proxyProvider is 7 or 8, proxyType is required.
3049
+ - If proxyProvider is 17, country is required; state and city are optional.
3050
+ example: 2
3051
+ proxyType:
3052
+ type: integer
3053
+ format: int32
3054
+ description: |
3055
+ Proxy protocol type: 0=HTTP, 1=HTTPS, 2=SOCKS5, 3=SSH.
3056
+ Required only when proxyProvider is 7 or 8.
3057
+ example: 1
3058
+ refreshUrl:
3059
+ type: string
3060
+ description: URL to refresh dynamic proxy IP (if supported)
3061
+ example: ""
3062
+ state:
3063
+ type: string
3064
+ description: State/Province
3065
+ example: ""
3066
+ username:
3067
+ type: string
3068
+ description: Username for proxy authentication
3069
+ example: ""
3070
+ required:
3071
+ - proxyIp
3072
+ - proxyPort
3073
+ - proxyProvider
3074
+ example:
3075
+ proxyIp: "8.10.22.46"
3076
+ proxyPort: 65534
3077
+ proxyProvider: 2
3078
+ proxyType: 1
3079
+ country: "AD"
3080
+ state: ""
3081
+ city: ""
3082
+ encryptionType: 14
3083
+ ipChangeAction: 1
3084
+ ipMonitor: false
3085
+ proxyName: "sock5_{{random}}"
3086
+ refreshUrl: ""
3087
+ username: ""
3088
+ password: ""
3089
+ responses:
3090
+ "200":
3091
+ description: ""
3092
+ content:
3093
+ application/json:
3094
+ schema:
3095
+ type: object
3096
+ properties:
3097
+ code:
3098
+ description: Return result code 0:Normal Other codes are exceptions.
3099
+ type: integer
3100
+ msg:
3101
+ description: Error message
3102
+ type: string
3103
+ data:
3104
+ description: Proxy ID
3105
+ type: integer
3106
+ requestId:
3107
+ description: Operation Request ID
3108
+ type: string
3109
+ required:
3110
+ - code
3111
+ - msg
3112
+ - data
3113
+ - requestId
3114
+ example:
3115
+ code: 0
3116
+ msg: ""
3117
+ data: 0
3118
+ requestId: "abcd1234"
3119
+ headers: {}
3120
+ security: []
3121
+
3122
+ /proxyInfo/update:
3123
+ post:
3124
+ summary: Modifying proxy information
3125
+ deprecated: false
3126
+ description: ""
3127
+ operationId: updateProxyUsingPOST
3128
+ tags:
3129
+ - Proxy Management
3130
+ parameters:
3131
+ - name: Authorization
3132
+ in: header
3133
+ description: Token for request access token interface response access_token field
3134
+ required: true
3135
+ example: {{Authorization}}
3136
+ schema:
3137
+ type: string
3138
+ requestBody:
3139
+ required: true
3140
+ content:
3141
+ application/json:
3142
+ schema:
3143
+ type: object
3144
+ required:
3145
+ - id
3146
+ - proxyIp
3147
+ - proxyPort
3148
+ properties:
3149
+ id:
3150
+ type: integer
3151
+ format: int64
3152
+ description: Unique proxy ID
3153
+ proxyIp:
3154
+ type: string
3155
+ description: Proxy server IP address
3156
+ proxyPort:
3157
+ type: integer
3158
+ description: Proxy server port
3159
+ proxyName:
3160
+ type: string
3161
+ description: Custom name for the proxy
3162
+ country:
3163
+ type: string
3164
+ description: Country (e.g., "US", "CN")
3165
+ city:
3166
+ type: string
3167
+ description: City name
3168
+ username:
3169
+ type: string
3170
+ description: Authentication username (if required)
3171
+ password:
3172
+ type: string
3173
+ description: Authentication password (if required)
3174
+ proxyType:
3175
+ type: integer
3176
+ description: |
3177
+ Proxy protocol type:
3178
+ - `0` = HTTP
3179
+ - `1` = HTTPS
3180
+ - `2` = SOCKS5
3181
+ - `3` = SSH
3182
+ proxyProvider:
3183
+ type: integer
3184
+ description: |
3185
+ Proxy provider ID:
3186
+ - `0` = None / Self-owned
3187
+ - `4` = Oxylabs
3188
+ - `5` = Proxys.io
3189
+ - `6` = GeoSurf
3190
+ - `7` = Luminati
3191
+ - `8` = Lumauto
3192
+ - `9` = Oxylabsauto
3193
+ - `10` = Trojan
3194
+ - `11` = Shadowsocks
3195
+ - `12` = vmess
3196
+ - `13` = ABCPROXY
3197
+ - `14` = LunaProxy
3198
+ - `15` = IPHTML
3199
+ - `16` = PiaProxy
3200
+ - `17` = 922S5
3201
+ encryptionType:
3202
+ type: integer
3203
+ description: Encryption type (provider-specific, usually 0 for plain)
3204
+ ipMonitor:
3205
+ type: boolean
3206
+ description: Enable IP change monitoring
3207
+ ipChangeAction:
3208
+ type: integer
3209
+ description: |
3210
+ Action to take when IP changes:
3211
+ - `1` = Notify / Refresh (common value)
3212
+ > Check system documentation for full options.
3213
+ refreshUrl:
3214
+ type: string
3215
+ description: URL to trigger IP refresh (if supported by provider)
3216
+ state:
3217
+ type: string
3218
+ description: Reserved field or custom state (optional)
3219
+ example:
3220
+ id: 1566403036579198
3221
+ proxyIp: "108.11.23.85"
3222
+ proxyPort: 4096
3223
+ proxyName: "MyProxy"
3224
+ country: "US"
3225
+ city: "New York"
3226
+ username: ""
3227
+ password: ""
3228
+ proxyType: 0
3229
+ proxyProvider: 0
3230
+ encryptionType: 0
3231
+ ipMonitor: true
3232
+ ipChangeAction: 1
3233
+ refreshUrl: ""
3234
+ state: ""
3235
+ responses:
3236
+ "200":
3237
+ description: ""
3238
+ content:
3239
+ application/json:
3240
+ schema:
3241
+ type: object
3242
+ properties:
3243
+ code:
3244
+ description: Return result code 0:Normal Other codes are exceptions.
3245
+ type: integer
3246
+ msg:
3247
+ description: Error message
3248
+ type: string
3249
+ requestId:
3250
+ description: Operation Request ID
3251
+ type: string
3252
+ required:
3253
+ - code
3254
+ - msg
3255
+ - requestId
3256
+ example:
3257
+ code: 0
3258
+ msg: ""
3259
+ requestId: "efgh5678"
3260
+ headers: {}
3261
+ security: []
3262
+
3263
+ /proxyInfo/delete:
3264
+ post:
3265
+ summary: Delete proxy
3266
+ deprecated: false
3267
+ description: ""
3268
+ operationId: deleteProxyUsingPOST
3269
+ tags:
3270
+ - Proxy Management
3271
+ parameters:
3272
+ - name: Authorization
3273
+ in: header
3274
+ description: Token for request access token interface response access_token field
3275
+ required: true
3276
+ example: {{Authorization}}
3277
+ schema:
3278
+ type: string
3279
+ requestBody:
3280
+ required: true
3281
+ content:
3282
+ application/json:
3283
+ schema:
3284
+ type: array
3285
+ items:
3286
+ type: integer
3287
+ format: int64
3288
+ example:
3289
+ - 1054661322597744600
3290
+ - 1054661322597744601
3291
+ responses:
3292
+ "200":
3293
+ description: ""
3294
+ content:
3295
+ application/json:
3296
+ schema:
3297
+ type: object
3298
+ properties:
3299
+ code:
3300
+ description: Return result code 0:Normal Other codes are exceptions.
3301
+ type: integer
3302
+ msg:
3303
+ description: Error message
3304
+ type: string
3305
+ requestId:
3306
+ description: Operation Request ID
3307
+ type: string
3308
+ required:
3309
+ - code
3310
+ - msg
3311
+ - requestId
3312
+ example:
3313
+ code: 0
3314
+ msg: ""
3315
+ requestId: "ijkl9012"
3316
+ headers: {}
3317
+ security: []
3318
+ /envgroup/page:
3319
+ post:
3320
+ summary: Get a list of groups
3321
+ deprecated: false
3322
+ description: ""
3323
+ tags:
3324
+ - Group Management
3325
+ parameters:
3326
+ - name: Authorization
3327
+ in: header
3328
+ description: Token for request access token interface response access_token field
3329
+ required: true
3330
+ example: {{Authorization}}
3331
+ schema:
3332
+ type: string
3333
+ requestBody:
3334
+ content:
3335
+ application/json:
3336
+ schema:
3337
+ type: object
3338
+ properties:
3339
+ groupName:
3340
+ type: string
3341
+ title: Group name (partial match)
3342
+ pageNo:
3343
+ type: integer
3344
+ title: Current page
3345
+ pageSize:
3346
+ type: integer
3347
+ title: Items per page
3348
+ required:
3349
+ - groupName
3350
+ - pageNo
3351
+ - pageSize
3352
+ example:
3353
+ groupName: 132-kernel
3354
+ pageNo: 1
3355
+ pageSize: 10
3356
+ responses:
3357
+ "200":
3358
+ description: ""
3359
+ content:
3360
+ application/json:
3361
+ schema:
3362
+ type: object
3363
+ properties:
3364
+ code:
3365
+ description: Return result code 0:Normal Other codes are exceptions.
3366
+ type: integer
3367
+ msg:
3368
+ description: Error message
3369
+ type: string
3370
+ data:
3371
+ type: object
3372
+ properties:
3373
+ current:
3374
+ type: integer
3375
+ dataList:
3376
+ type: array
3377
+ items:
3378
+ type: object
3379
+ properties:
3380
+ id:
3381
+ description: Group ID
3382
+ type: integer
3383
+ groupName:
3384
+ description: Group name
3385
+ type: string
3386
+ pages:
3387
+ type: integer
3388
+ total:
3389
+ type: integer
3390
+ required:
3391
+ - current
3392
+ - dataList
3393
+ - pages
3394
+ - total
3395
+ requestId:
3396
+ description: Operation Request ID
3397
+ type: string
3398
+ required:
3399
+ - code
3400
+ - msg
3401
+ - data
3402
+ - requestId
3403
+ example:
3404
+ code: 0
3405
+ msg: ""
3406
+ data:
3407
+ current: 0
3408
+ dataList:
3409
+ - id: 0
3410
+ groupName: ""
3411
+ pages: 0
3412
+ total: 0
3413
+ requestId: ""
3414
+ headers: {}
3415
+ security: []
3416
+ /envgroup/edit:
3417
+ post:
3418
+ summary: Modify grouping information
3419
+ deprecated: false
3420
+ description: ""
3421
+ tags:
3422
+ - Group Management
3423
+ parameters:
3424
+ - name: Authorization
3425
+ in: header
3426
+ description: Token for request access token interface response access_token field
3427
+ required: true
3428
+ example: {{Authorization}}
3429
+ schema:
3430
+ type: string
3431
+ requestBody:
3432
+ required: true
3433
+ content:
3434
+ application/json:
3435
+ schema:
3436
+ type: object
3437
+ required:
3438
+ - groupName
3439
+ - id
3440
+ properties:
3441
+ groupName:
3442
+ type: string
3443
+ description: New name for the environment group
3444
+ id:
3445
+ type: integer
3446
+ format: int64
3447
+ description: Unique ID of the group to be updated
3448
+ example:
3449
+ groupName: "Group-1574544945848579"
3450
+ id: 1574525425557584
3451
+ responses:
3452
+ "200":
3453
+ description: ""
3454
+ content:
3455
+ application/json:
3456
+ schema:
3457
+ type: object
3458
+ properties:
3459
+ code:
3460
+ description: Return result code 0:Normal Other codes are exceptions.
3461
+ type: integer
3462
+ msg:
3463
+ description: Error message
3464
+ type: string
3465
+ data:
3466
+ type: boolean
3467
+ description: result
3468
+ requestId:
3469
+ description: Operation Request ID
3470
+ type: string
3471
+ required:
3472
+ - code
3473
+ - msg
3474
+ - data
3475
+ - requestId
3476
+ example:
3477
+ code: 0
3478
+ msg: ""
3479
+ data: 0
3480
+ requestId: ""
3481
+ headers: {}
3482
+ security: []
3483
+ /envgroup/create:
3484
+ post:
3485
+ summary: Add group
3486
+ deprecated: false
3487
+ description: ""
3488
+ tags:
3489
+ - Group Management
3490
+ parameters:
3491
+ - name: Authorization
3492
+ in: header
3493
+ description: Token for request access token interface response access_token field
3494
+ required: true
3495
+ example: {{Authorization}}
3496
+ schema:
3497
+ type: string
3498
+ requestBody:
3499
+ content:
3500
+ application/json:
3501
+ schema:
3502
+ type: object
3503
+ properties: {}
3504
+ example:
3505
+ groupName: Group-333
3506
+ responses:
3507
+ "200":
3508
+ description: ""
3509
+ content:
3510
+ application/json:
3511
+ schema:
3512
+ type: object
3513
+ properties:
3514
+ code:
3515
+ description: Return result code 0:Normal Other codes are exceptions.
3516
+ type: integer
3517
+ msg:
3518
+ description: Error message
3519
+ type: string
3520
+ data:
3521
+ description: The data returned by the operation
3522
+ type: integer
3523
+ requestId:
3524
+ description: Operation Request ID
3525
+ type: string
3526
+ required:
3527
+ - code
3528
+ - msg
3529
+ - data
3530
+ - requestId
3531
+ example:
3532
+ code: 0
3533
+ msg: ""
3534
+ data: 0
3535
+ requestId: ""
3536
+ headers: {}
3537
+ security: []
3538
+ /envgroup/delete:
3539
+ post:
3540
+ summary: Delete group
3541
+ deprecated: false
3542
+ description: ""
3543
+ tags:
3544
+ - Group Management
3545
+ parameters:
3546
+ - name: Authorization
3547
+ in: header
3548
+ description: Token for request access token interface response access_token field
3549
+ required: true
3550
+ example: {{Authorization}}
3551
+ schema:
3552
+ type: string
3553
+ requestBody:
3554
+ content:
3555
+ application/json:
3556
+ schema:
3557
+ type: object
3558
+ properties: {}
3559
+ example:
3560
+ ids:
3561
+ - 1588991461723549
3562
+ isDeleteAllEnv: false
3563
+ responses:
3564
+ "200":
3565
+ description: ""
3566
+ content:
3567
+ application/json:
3568
+ schema:
3569
+ type: object
3570
+ properties:
3571
+ code:
3572
+ description: Return result code 0:Normal Other codes are exceptions.
3573
+ type: integer
3574
+ msg:
3575
+ description: Error message
3576
+ type: string
3577
+ data:
3578
+ type: boolean
3579
+ requestId:
3580
+ description: Operation Request ID
3581
+ type: string
3582
+ required:
3583
+ - code
3584
+ - msg
3585
+ - data
3586
+ - requestId
3587
+ example:
3588
+ code: 0
3589
+ msg: ""
3590
+ data: true
3591
+ requestId: ""
3592
+ headers: {}
3593
+ security: []
3594
+ /envtag/all:
3595
+ get:
3596
+ summary: Getting a list of tags
3597
+ deprecated: false
3598
+ description: ""
3599
+ tags:
3600
+ - Tag Management
3601
+ parameters:
3602
+ - name: Authorization
3603
+ in: header
3604
+ description: Token for request access token interface response access_token field
3605
+ required: true
3606
+ example: {{Authorization}}
3607
+ schema:
3608
+ type: string
3609
+ responses:
3610
+ "200":
3611
+ description: ""
3612
+ content:
3613
+ application/json:
3614
+ schema:
3615
+ type: object
3616
+ properties:
3617
+ code:
3618
+ description: Return result code 0:Normal Other codes are exceptions.
3619
+ type: integer
3620
+ msg:
3621
+ description: error message
3622
+ type: string
3623
+ data:
3624
+ type: array
3625
+ items:
3626
+ type: object
3627
+ properties:
3628
+ id:
3629
+ description: ID of tags
3630
+ type: integer
3631
+ tagName:
3632
+ description: Name of tags
3633
+ type: string
3634
+ requestId:
3635
+ description: Operation Request ID
3636
+ type: string
3637
+ required:
3638
+ - code
3639
+ - msg
3640
+ - data
3641
+ - requestId
3642
+ example:
3643
+ code: 0
3644
+ msg: ""
3645
+ data:
3646
+ - id: 0
3647
+ tagName: ""
3648
+ requestId: ""
3649
+ headers: {}
3650
+ security: []
3651
+ /envtag/create:
3652
+ post:
3653
+ summary: Create tags
3654
+ deprecated: false
3655
+ description: ""
3656
+ tags:
3657
+ - Tag Management
3658
+ parameters:
3659
+ - name: Authorization
3660
+ in: header
3661
+ description: Token for request access token interface response access_token field
3662
+ required: true
3663
+ example: {{Authorization}}
3664
+ schema:
3665
+ type: string
3666
+ requestBody:
3667
+ content:
3668
+ application/json:
3669
+ schema:
3670
+ type: object
3671
+ properties: {}
3672
+ example:
3673
+ tagName: Tag-123
3674
+ responses:
3675
+ "200":
3676
+ description: ""
3677
+ content:
3678
+ application/json:
3679
+ schema:
3680
+ type: object
3681
+ properties:
3682
+ code:
3683
+ description: Return result code 0:Normal Other codes are exceptions.
3684
+ type: integer
3685
+ msg:
3686
+ description: error message
3687
+ type: string
3688
+ data:
3689
+ type: object
3690
+ properties:
3691
+ id:
3692
+ description: ID of tags
3693
+ type: integer
3694
+ tagName:
3695
+ description: Name of tags
3696
+ type: string
3697
+ required:
3698
+ - id
3699
+ - tagName
3700
+ requestId:
3701
+ description: Operation Request ID
3702
+ type: string
3703
+ error:
3704
+ type: object
3705
+ properties: {}
3706
+ required:
3707
+ - code
3708
+ - msg
3709
+ - data
3710
+ - requestId
3711
+ example:
3712
+ code: 0
3713
+ msg: ""
3714
+ data:
3715
+ id: 0
3716
+ tagName: ""
3717
+ requestId: ""
3718
+ headers: {}
3719
+ security: []
3720
+ /envtag/edit:
3721
+ post:
3722
+ summary: Modify information of tags
3723
+ deprecated: false
3724
+ description: ""
3725
+ tags:
3726
+ - Tag Management
3727
+ parameters:
3728
+ - name: Authorization
3729
+ in: header
3730
+ description: Token for request access token interface response access_token field
3731
+ required: true
3732
+ example: {{Authorization}}
3733
+ schema:
3734
+ type: string
3735
+ requestBody:
3736
+ content:
3737
+ application/json:
3738
+ schema:
3739
+ type: object
3740
+ properties: {}
3741
+ example:
3742
+ id: 1564715845550177
3743
+ tagName: Updated-123
3744
+ responses:
3745
+ "200":
3746
+ description: ""
3747
+ content:
3748
+ application/json:
3749
+ schema:
3750
+ type: object
3751
+ properties:
3752
+ code:
3753
+ description: Return result code 0:Normal Other codes are exceptions.
3754
+ type: integer
3755
+ msg:
3756
+ description: Error message
3757
+ type: string
3758
+ data:
3759
+ type: boolean
3760
+ requestId:
3761
+ description: Operation Request ID
3762
+ type: string
3763
+ error:
3764
+ type: object
3765
+ properties: {}
3766
+ required:
3767
+ - code
3768
+ - msg
3769
+ - data
3770
+ - requestId
3771
+ example:
3772
+ code: 0
3773
+ msg: ""
3774
+ data: true
3775
+ requestId: ""
3776
+ headers: {}
3777
+ security: []
3778
+ /envtag/delete:
3779
+ post:
3780
+ summary: Delete tags
3781
+ deprecated: false
3782
+ description: ""
3783
+ tags:
3784
+ - Tag Management
3785
+ parameters:
3786
+ - name: Authorization
3787
+ in: header
3788
+ description: Token for request access token interface response access_token field
3789
+ required: true
3790
+ example: {{Authorization}}
3791
+ schema:
3792
+ type: string
3793
+ requestBody:
3794
+ content:
3795
+ application/json:
3796
+ schema:
3797
+ type: object
3798
+ properties: {}
3799
+ example:
3800
+ ids:
3801
+ - "1574175499182143"
3802
+ - "1574175188803646"
3803
+ responses:
3804
+ "200":
3805
+ description: ""
3806
+ content:
3807
+ application/json:
3808
+ schema:
3809
+ type: object
3810
+ properties:
3811
+ code:
3812
+ description: Return result code 0:Normal Other codes are exceptions.
3813
+ type: integer
3814
+ msg:
3815
+ description: Error message
3816
+ type: string
3817
+ data:
3818
+ type: boolean
3819
+ requestId:
3820
+ description: Operation Request ID
3821
+ type: string
3822
+ required:
3823
+ - code
3824
+ - msg
3825
+ - data
3826
+ - requestId
3827
+ example:
3828
+ code: 0
3829
+ msg: ""
3830
+ data: true
3831
+ requestId: ""
3832
+ headers: {}
3833
+ security: []
3834
+ webhooks: {}
3835
+ components:
3836
+ schemas:
3837
+ CloudPhoneProfile:
3838
+ type: object
3839
+ properties:
3840
+ abnormalStatus:
3841
+ type: integer
3842
+ description: Abnormal status 0-No abnormality 1-Unactivated 2-Out-of-contract 3-Oversold 4-Deactivated
3843
+ adbInfo:
3844
+ $ref: '#/components/schemas/AdbInfo'
3845
+ billingType:
3846
+ type: integer
3847
+ description: Billing:0-Free 1-Flexible subscription 2-Monthly
3848
+ createDate:
3849
+ type: string
3850
+ format: date-time
3851
+ createMember:
3852
+ type: integer
3853
+ createMemberName:
3854
+ type: string
3855
+ enableAdb:
3856
+ type: boolean
3857
+ envName:
3858
+ type: string
3859
+ description: Cloud Phone Name
3860
+ envRemark:
3861
+ type: string
3862
+ description: Profile Remarks
3863
+ envStatus:
3864
+ type: integer
3865
+ description: Profile Status:0-New 1-Creation Failed 2-Stop 3-Starting up 4-Start 5-Reset In Progress
3866
+ expireTime:
3867
+ type: integer
3868
+ description: expiration time
3869
+ groupId:
3870
+ type: integer
3871
+ groupInfo:
3872
+ type: array
3873
+ items:
3874
+ $ref: '#/components/schemas/TagInfo'
3875
+ id:
3876
+ type: integer
3877
+ format: int64
3878
+ lastConnectDate:
3879
+ type: string
3880
+ format: date-time
3881
+ lastConnectMemberId:
3882
+ type: integer
3883
+ lastConnectMemberName:
3884
+ type: string
3885
+ lastStartDate:
3886
+ type: string
3887
+ format: date-time
3888
+ lastStartMemberId:
3889
+ type: integer
3890
+ lastStartMemberName:
3891
+ type: string
3892
+ proxy:
3893
+ $ref: '#/components/schemas/ProxyInfo'
3894
+ proxyStatus:
3895
+ type: integer
3896
+ description: Proxy Status:0-Not Detected 1-Detecting 2-Detecting Failed 3-Detecting Successful
3897
+ supportAdb:
3898
+ type: boolean
3899
+ tagIds:
3900
+ type: array
3901
+ items:
3902
+ type: string
3903
+ tagInfo:
3904
+ type: array
3905
+ items:
3906
+ $ref: '#/components/schemas/TagInfo'
3907
+ updateDate:
3908
+ type: string
3909
+ format: date-time
3910
+ updateMember:
3911
+ type: integer
3912
+
3913
+ AdbInfo:
3914
+ type: object
3915
+ properties:
3916
+ adbIp:
3917
+ type: string
3918
+ description: adb ip
3919
+ adbPassword:
3920
+ type: string
3921
+ description: adb connection password
3922
+ adbPort:
3923
+ type: string
3924
+ description: adb port
3925
+ remark:
3926
+ type: string
3927
+ description: Failure Remarks Information
3928
+ success:
3929
+ type: integer
3930
+ description: Successful acquisition 1=Yes 0=No
3931
+ required:
3932
+ - adbIp
3933
+ - adbPassword
3934
+ - adbPort
3935
+ - remark
3936
+ - success
3937
+
3938
+ ProxyInfo:
3939
+ type: object
3940
+ properties:
3941
+ country:
3942
+ type: string
3943
+ countryCode:
3944
+ type: string
3945
+ createDate:
3946
+ type: string
3947
+ format: date-time
3948
+ delFlag:
3949
+ type: integer
3950
+ description: 1 - deleted 2 - not deleted
3951
+ expiryTime:
3952
+ type: integer
3953
+ exportIp:
3954
+ type: string
3955
+ groupId:
3956
+ type: integer
3957
+ id:
3958
+ type: integer
3959
+ format: int64
3960
+ providerCode:
3961
+ type: string
3962
+ proxyAreaCode:
3963
+ type: string
3964
+ proxyCatagoryType:
3965
+ type: integer
3966
+ description: Proxy type:0:site group 1:cloud platform 2:own IP 3:vps 4:virtual machine
3967
+ proxyCheckStatus:
3968
+ type: integer
3969
+ description: Detection status:0:pending detection 1:successful detection 2:detection failure 3:unknown error
3970
+ proxyInfo:
3971
+ type: string
3972
+ proxyIp:
3973
+ type: string
3974
+ proxyName:
3975
+ type: string
3976
+ proxyPort:
3977
+ type: integer
3978
+ proxyRegionCode:
3979
+ type: string
3980
+ proxyStatus:
3981
+ type: integer
3982
+ description: 0-Normal 1-Pending allocation 2-Upgrading 3-Expired
3983
+ proxySub:
3984
+ $ref: '#/components/schemas/ProxySubscription'
3985
+ proxyType:
3986
+ type: integer
3987
+ description: Proxy type:0-http 1-https 2-socks5 4-Oxylabs 5-Proxys.io 6-GeoSurf 9-Oxylabsauto 10-Trogan 11-Shadowsocks 12-vmess
3988
+ proxyTypeCode:
3989
+ type: string
3990
+ regionKey:
3991
+ type: string
3992
+ releaseTime:
3993
+ type: string
3994
+ format: date-time
3995
+ description: Release time:deletion time if deleted, expiration time if expired
3996
+ uniqueId:
3997
+ type: integer
3998
+ required:
3999
+ - country
4000
+ - countryCode
4001
+ - createDate
4002
+ - delFlag
4003
+ - expiryTime
4004
+ - exportIp
4005
+ - groupId
4006
+ - id
4007
+ - providerCode
4008
+ - proxyAreaCode
4009
+ - proxyCatagoryType
4010
+ - proxyCheckStatus
4011
+ - proxyInfo
4012
+ - proxyIp
4013
+ - proxyName
4014
+ - proxyPort
4015
+ - proxyRegionCode
4016
+ - proxyStatus
4017
+ - proxySub
4018
+ - proxyType
4019
+ - proxyTypeCode
4020
+ - regionKey
4021
+ - releaseTime
4022
+ - uniqueId
4023
+
4024
+ ProxySubscription:
4025
+ type: object
4026
+ properties:
4027
+ activeRecordId:
4028
+ type: integer
4029
+ businessId:
4030
+ type: string
4031
+ createMember:
4032
+ type: integer
4033
+ endTime:
4034
+ type: integer
4035
+ id:
4036
+ type: integer
4037
+ nextBillingTime:
4038
+ type: integer
4039
+ startTime:
4040
+ type: integer
4041
+ subPayMethod:
4042
+ type: string
4043
+ subStatus:
4044
+ type: integer
4045
+ description: Subscription Status:0-Pending 1-Subscribed 2-Cancelled
4046
+ subType:
4047
+ type: integer
4048
+ description: Subscription Type:1-Agent 2-Package
4049
+ teamId:
4050
+ type: integer
4051
+ required:
4052
+ - activeRecordId
4053
+ - businessId
4054
+ - createMember
4055
+ - endTime
4056
+ - id
4057
+ - nextBillingTime
4058
+ - startTime
4059
+ - subPayMethod
4060
+ - subStatus
4061
+ - subType
4062
+ - teamId
4063
+
4064
+ TagInfo:
4065
+ type: object
4066
+ properties:
4067
+ id:
4068
+ type: integer
4069
+ tagIcon:
4070
+ type: string
4071
+ tagName:
4072
+ type: string
4073
+ tagSource:
4074
+ type: string
4075
+ description: 'Tag Source: ENV profile, PROXY proxy'
4076
+ tagType:
4077
+ type: string
4078
+ description: 'Tag type: TAG tag, GROUP group'
4079
+
4080
+ CloudPhoneDetail:
4081
+ type: object
4082
+ properties:
4083
+ id:
4084
+ type: string
4085
+ envName:
4086
+ type: string
4087
+ groupId:
4088
+ type: string
4089
+ skuId:
4090
+ type: string
4091
+ tagIds:
4092
+ type: array
4093
+ items:
4094
+ type: string
4095
+ billingType:
4096
+ type: integer
4097
+ proxyStatus:
4098
+ type: integer
4099
+ settings:
4100
+ type: object
4101
+ properties:
4102
+ automaticGeo:
4103
+ type: boolean
4104
+ automaticLocation:
4105
+ type: boolean
4106
+ automaticLanguage:
4107
+ type: boolean
4108
+ longitude:
4109
+ type: number
4110
+ nullable: true
4111
+ latitude:
4112
+ type: number
4113
+ nullable: true
4114
+ required:
4115
+ - automaticGeo
4116
+ - automaticLocation
4117
+ - automaticLanguage
4118
+ - longitude
4119
+ - latitude
4120
+ device:
4121
+ type: object
4122
+ properties:
4123
+ server:
4124
+ type: string
4125
+ nullable: true
4126
+ countryName:
4127
+ type: string
4128
+ rom:
4129
+ type: integer
4130
+ wifiBssid:
4131
+ type: string
4132
+ nullable: true
4133
+ bluetoothMac:
4134
+ type: string
4135
+ required:
4136
+ - server
4137
+ - countryName
4138
+ - rom
4139
+ - wifiBssid
4140
+ - bluetoothMac
4141
+ proxy:
4142
+ type: object
4143
+ properties:
4144
+ id:
4145
+ type: string
4146
+ proxyName:
4147
+ type: string
4148
+ proxyIp:
4149
+ type: string
4150
+ required:
4151
+ - id
4152
+ - proxyName
4153
+ - proxyIp
4154
+ lastStartMemberId:
4155
+ type: string
4156
+ lastStartMemberName:
4157
+ type: string
4158
+ nullable: true
4159
+ lastStartDate:
4160
+ type: string
4161
+ format: date-time
4162
+ lastConnectMemberId:
4163
+ type: string
4164
+ lastConnectMemberName:
4165
+ type: string
4166
+ nullable: true
4167
+ lastConnectDate:
4168
+ type: string
4169
+ format: date-time
4170
+ envStatus:
4171
+ type: integer
4172
+ abnormalStatus:
4173
+ type: integer
4174
+ expireTime:
4175
+ type: string
4176
+ envRemark:
4177
+ type: string
4178
+ createMember:
4179
+ type: string
4180
+ updateMember:
4181
+ type: string
4182
+ updateDate:
4183
+ type: string
4184
+ format: date-time
4185
+ createDate:
4186
+ type: string
4187
+ format: date-time
4188
+ createMemberName:
4189
+ type: string
4190
+ nullable: true
4191
+ required:
4192
+ - id
4193
+ - envName
4194
+ - groupId
4195
+ - skuId
4196
+ - tagIds
4197
+ - billingType
4198
+ - proxyStatus
4199
+ - settings
4200
+ - device
4201
+ - proxy
4202
+ - lastStartMemberId
4203
+ - lastStartMemberName
4204
+ - lastStartDate
4205
+ - lastConnectMemberId
4206
+ - lastConnectMemberName
4207
+ - lastConnectDate
4208
+ - envStatus
4209
+ - abnormalStatus
4210
+ - expireTime
4211
+ - envRemark
4212
+ - createMember
4213
+ - updateMember
4214
+ - updateDate
4215
+ - createDate
4216
+ - createMemberName
4217
+
4218
+ Execution DTO:
4219
+ type: object
4220
+ properties:
4221
+ id:
4222
+ type: integer
4223
+ description: Execution record id
4224
+ taskName:
4225
+ type: string
4226
+ description: Schedule Task name
4227
+ taskState:
4228
+ type: integer
4229
+ description: >-
4230
+ Schedule status; 0:awaiting execution; 1:Executing; 2:Execution
4231
+ completed 3:Cancel
4232
+ cloudPhoneId:
4233
+ type: integer
4234
+ description: Cloud phone ID
4235
+ cloudPhoneName:
4236
+ type: string
4237
+ description: Cloud phone name
4238
+ templateName:
4239
+ type: string
4240
+ description: Template title
4241
+ handleFailCode:
4242
+ type: string
4243
+ description: Task failure code
4244
+ handleFailReason:
4245
+ type: string
4246
+ description: Task failure reason
4247
+ handleResult:
4248
+ type: integer
4249
+ description: Task result. 0:failed; 1:succeeded
4250
+ handleResultAttachment:
4251
+ type: string
4252
+ description: Task execution result attachment
4253
+ handleTime:
4254
+ type: string
4255
+ description: Execution time
4256
+ endTime:
4257
+ type: string
4258
+ description: Task end time
4259
+ powerOnTime:
4260
+ type: string
4261
+ description: Cloud phone power-on time
4262
+ triggerNextTime:
4263
+ type: string
4264
+ description: Next scheduled trigger time
4265
+ triggerTime:
4266
+ type: string
4267
+ description: Scheduled trigger time
4268
+ createDate:
4269
+ type: string
4270
+ description: ' Creation time'
4271
+ createMember:
4272
+ type: string
4273
+ description: Creator
4274
+ updateDate:
4275
+ type: string
4276
+ description: Last update time
4277
+ updateMember:
4278
+ type: string
4279
+ description: Last updater
4280
+ responses:
4281
+ 404:
4282
+ description: ""
4283
+ content:
4284
+ application/json:
4285
+ schema:
4286
+ type: object
4287
+ properties:
4288
+ code:
4289
+ type: integer
4290
+ message:
4291
+ type: string
4292
+ required:
4293
+ - code
4294
+ - message
4295
+ 402:
4296
+ description: ""
4297
+ content:
4298
+ application/json:
4299
+ schema:
4300
+ type: object
4301
+ properties:
4302
+ code:
4303
+ type: integer
4304
+ message:
4305
+ type: string
4306
+ required:
4307
+ - code
4308
+ - message
4309
+ securitySchemes: {}
4310
+ servers:
4311
+ - url: https://api.morelogin.com
4312
+ description: Morelogin open api endponint
4313
+ security: []