Skip to main content

1.Automation Operations

iClick provides rich automation operation interfaces to remotely control iOS devices for clicking, swiping, input, and other operations. ⚠️ Prerequisites Before using automation features, you must enable AssistiveTouch on the iOS device, otherwise operations will not work

2.Send Action

Execute system-level quick actions, such as returning to home screen, opening app switcher, controlling volume and brightness, etc.

Endpoint Description

Endpoint Type

Parameters

Response Payload

Supported Actions

Usage Examples

Return to Home and Open App Switcher

3.Open App

Open a specified iOS application via Spotlight search.

Endpoint Description

Endpoint Type

Parameters

Response Payload

Basic Usage

Open Application

How It Works

This interface opens the application through the following steps:
  1. Invoke Spotlight
  2. Enter application name
  3. Automatically open the application

4.Kill Recents

Clear all background running applications on iOS device.

Endpoint Description

Endpoint Type

Parameters

Response Payload

Basic Usage

Kill Recent Apps

How It Works

This interface clears background applications through the following steps:
  1. Open app switcher
  2. Clear background app cards through swipe operations
Performance Tip
  • This interface performs multiple swipe operations
  • If there are many background apps, it may take longer

5.Click Operation

Execute click operation at specified coordinate position.

Endpoint Description

Endpoint Type

Parameters

Response Payload

Basic Usage

Simple Click

focus Parameter?

⚠️ Use in Specific ScenariosThe focus parameter is only for specific scenarios
✅ Applicable Scenarios: System-level Alert Buttons System-level alert boxes (such as permission requests, system popups, etc.) buttons sometimes cannot respond to normal click events. In this case, use focus: true: Examples of Applicable System-level Alerts:
  • 📱 Permission request popups (camera, location, notifications, etc.)
  • 🔐 System security alerts
  • ⚙️ System settings related popups
  • 🔔 iOS system-level confirmation dialogs
❌ Not Applicable: Normal App Interfaces For normal buttons and UI elements in apps, do not use focus: true

❓ Does focus: true Affect Performance?

It will slightly increase execution time.

6.Move Cursor

Move device cursor to specified coordinate position.

Endpoint Description

Endpoint Type

Parameters

Response Payload

Basic Usage

7.Reset Cursor

Reset device cursor to top-left initial position (0, 0).

Endpoint Description

Endpoint Type

Parameters

Response Payload

Basic Usage

Execution Scenario

🔄 If pointer drift or abnormal behavior occurs, manual reset can solve the issue

8.Mouse Down

Press mouse button at specified coordinate position (without releasing).

Endpoint Description

Endpoint Type

Parameters

key Parameter Values

Response Payload

Basic Usage

Auto Release Button

9.Mouse Up

Release mouse button at specified coordinate position.

Endpoint Description

Endpoint Type

Parameters

key Parameter Values

Response Payload

Basic Usage

10.Mouse Wheel

Execute mouse wheel scroll operation, used to scroll pages or content areas.

Endpoint Description

Endpoint Type

Parameters

tilt Parameter Description

Response Payload

Basic Usage

11.Swipe Operation

Execute a swipe operation from starting coordinates to ending coordinates.

Endpoint Description

Endpoint Type

Parameters

Response Payload

Basic Usage

Simple Swipe

12.Key Down

Press keyboard key (without releasing).

Endpoint Description

Endpoint Type

Parameters

key Parameter Values

Supported function keys: 💡 Letter and Number Keys For letter keys (A-Z) and number keys (0-9), use the sendKey interface, which automatically handles press and release.

Response Payload

Basic Usage

13.Key Up

Release keyboard key.

Endpoint Description

Endpoint Type

Parameters

key Parameter Values

Same as keyDown, supports all standard keyboard keys.

Response Payload

Basic Usage

14.Send Key

Send complete key events, automatically handles press and release, supports single keys, multiple keys, and combination keys.
⚠️ Note: sendKey can only input keyboard characters (English letters, digits, and common symbols). It does not support other languages or arbitrary text. To send any text to the device, see Send Text.

Endpoint Description

Endpoint Type

Parameters

Response Payload

Basic Usage

Input Single Character

Input Multiple Characters

Combination Key Usage

With Modifier Keys

15.Send Text

The sendText API can send arbitrary text to devices, supporting Chinese, English, numbers, symbols, and emojis.

API Description

The sendText API automatically handles different types of text:
  • Regular characters (letters, numbers, common symbols): Input directly via keyboard
  • Other characters (Chinese, emojis, etc.): Automatically write to clipboard via Shortcuts and paste
⚠️ Note: When sending non-regular characters, you need to install and bind the official Shortcut on the target device. See Shortcut APIs.

Parameters

Example