Tài liệu API

I. Địa chỉ API

ws://127.0.0.1:22222/

II. Cấu trúc API

Cả yêu cầu và phản hồi đều là cấu trúc dữ liệu JSON và các tham số yêu cầu đều thuộc loại chuỗi trừ khi có quy định khác.

2.1 Ví dụ:

{
    "action":"pushEvent",
    "davices":"all",
    "data":{
        "type":"2"
    }
}

2.2 Ví dụ phản hồi

{
    "code": 10000,
    "message": "SUCCESS",
    "data": null
}

III. Tham số công khai API

3.1 Thông số yêu cầu

Bảng hiên thị mô tả các tham số yêu cầu công khai

Tên tham số
Kiểu
Có cần thiết không ?
Giá trị mẫu
Minh hoạ

Hành động

string

"pushEvent"

Loại sự kiện yêu cầu, không phân biệt chữ hoa chữ thường

Thiết bị

string

"all"|"xxx,xxx"

Số sê-ri/số sê-ri của thiết bị, tất cả đều có nghĩa là tất cả, nhiều số sê-ri của thiết bị được phân tách bằng dấu phẩy tiếng Anh, nếu không có số sê-ri, bạn có thể sử dụng [IP:port] để chuyển giá trị. Bạn có thể xem nó trong danh sách thiết bị-số sê-ri hoặc sử dụng [Lấy danh sách thiết bị] để lấy nó.

Dữ liệu

json

no

Thống số yêu cầu

JSON, optional

3.2 Giá trị trả về

Giải thích các tiêu chí để xác định thành công và trả về các ngoại lệ. Ngoài ra, hãy giải thích định dạng của dữ liệu được trả về (chẳng hạn như JSON/XML). Bảng sau đây mô tả các tham số trả về công khai.

Tên tham số
Kiểu
Giá trị mẫu
Minh hoạ

Code

int

10000

Code trả về , mặc định "10000"

Tin Nhắn

string

"Thành công"

Tin nhắn phản hồi, mặc định"Thành công"

Dữ liệu

json

null

Đó là JSON khi có dữ liệu và null khi không có nội dung.

VI. Code phản hồi công khai API

Bài viết này liệt kê và giải thích các mã phản hồi phổ biến. Nếu bạn muốn biết các mã lỗi liên quan đến logic nghiệp vụ của một giao diện nào đó, vui lòng tham khảo tài liệu về giao diện đó.

Trạng thái code
Code lỗi
Thông báo lỗi
Minh hoạ

Ví dụ: 400

Ví dụ: Thông số không hợp lệ

Ví dụ: Yêu cầu chứa tham số không hợp lệ.

ví dụ: yêu cầu chứa tham số không hợp lệ.

10000

10000

Kết quả thành công

10001

10001

Kết quả không thành công

V. API danh sách kiểm tra danh sách

Tất cả các API được cung cấp

STT
API
Hành động
Minh hoạ

1

Danh sách thiết bị

danh sách

Lấy danh sách các thiết bị hiện đang kết nối

2

Cập nhật tên và số thiết bị

Cập nhật thiết bị

Sửa đổi tên và số thứ tự của thiết bị

3

Thực thi lệnh adb

abd

Để thực thi lệnh adb shell, bạn chỉ cần truyền lệnh sau [adb shell], không cần truyền [adb shell]

4

Ảnh chụp màn hình

màn hình

Chụp ảnh khung hình hiện tại của điện thoại di động và mặc định lưu vào thư mục [D:\Pictures] của máy tính.

5

Điều khiển màn hình

pointerEvent

Các thao tác điều khiển trên màn hình 0 nhấn 1 nâng 2 di chuyển 4 con lăn lên 5 con lăn xuống 6 trượt lên 7 trượt xuống 8 trượt sang trái 9 trượt sang phải

6

Thao tác nhanh

pushEvent

Thao tác phím tắt của các nút trên điện thoại di động 1 Quản lý tác vụ 2 Màn hình chính 3 Trở về

7

Gửi vào bảng nhớ tạm

Viết vào bảng nhớ tạm

Gửi văn bản vào clipboard điện thoại

8

Tải tập tin lên

uploadFile

Tải tập tin lên điện thoại di động

9

Tải file về máy tính

pullFile

Tải các tập tin điện thoại di động xuống máy tính và lưu chúng vào thư mục [D:\Downloads] của máy tính theo mặc định.

10

Danh sách ứng dụng

apkList

Nhận danh sách ứng dụng di động

11

Cài đặt APK

installApk

Cài đặt ứng dụng trên điện thoại của bạn

12

Gỡ cài đặt APK

Uninstall APK

Gỡ cài đặt ứng dụng

13

Bắt đầu ứng dụng

start APK

Khởi chạy ứng dụng di động

14

Dừng ứng dụng

stopApk

Đóng ứng dụng di động

15

Nhận danh sách phương thức nhập

imeList

Lấy phương thức nhập hiện được cài đặt trên điện thoại

16

Cài đặt phương thức nhập màn hình

installInputIme

Cài đặt âm thầm phương thức nhập chiếu màn hình (phương thức nhập chiếu màn hình sẽ tự động được cài đặt khi điện thoại di động được kết nối và không cần gọi bình thường)

17

Chọn phương thức nhập

selectIme

Chọn phương thức nhập hiện tại

18

Nhập văn bản

input Text

Để nhập văn bản, điện thoại di động hiện tại cần phải ở trang nhập và phương thức nhập hiện tại là phương thức nhập chiếu màn hình.

19

Nhận tất cả các thẻ

getTags

Nhận tất cả các nhãn nhóm hiện tại

20

Tạo thẻ

addTag

Tạo nhãn nhóm

21

Sửa đổi nhãn

updateTag

Sửa đổi tên nhãn nhóm

22

Xóa thẻ

removeTag

Xóa tên nhãn nhóm

23

Thêm thiết bị vào nhóm nhãn

adddevicetag

Thêm thiết bị vào nhóm nhãn

24

Xóa thiết bị dưới nhãn

removeTagDevice

Xóa thiết bị khỏi nhãn nhóm

Danh sách Nhận danh sách thiết bị

Nhận danh sách tất cả các thiết bị hiện đang kết nối 1 Tham số yêu cầu

Tên tham số
Kiểu
Có cần thiết không?
Giá trị mẫu
Minh hoạ

Hành động

string

"list"

Sự kiện yêu cầu, không phân biệt chữ hoa chữ thường

2 Yêu cầu mẫu Đây là ví dụ về yêu cầu trong cấu hình chung. 3 Trả về tham số

Tên tham số
Tên tham số
Kiểu
Giá trị mẫu
Minh hoạ

code

int

10000

Giá trị trả về, mặc định 10000

tin nhắn

string

"SUCCESS"

Tin nhắn trả về "SUCCESS"

data

array

Nó là JSON khi có dữ liệu và null khi không có dữ liệu.

width

int

272

Width

height

int

480

height

serial

string

"ea1234a"

Số serial của chế độ kết nối hiện tại, ở chế độ kết nối wifi, otg, không rào cản là ip

model

string

"Samsung galaxy A5"

Mobile phone model

sort

int

1

Mobile phone number

name

string

"Samsung galaxy A5haha"

Mobile phone custom name

onlySerial

string

"ea1234a"

Số serial duy nhất, số serial cố định cho điện thoại di động, không bị ảnh hưởng bởi chế độ kết nối

hide

bool

false

Có tắt trạng thái màn hình không

mode

int

0

Chế độ kết nối: 0: usb; 1: WIFI, 2.OTG; 3. Khả năng tiếp cận

connectTime

int

1714294839013

connection timestamp

intranetIp

string

"192.168.111.103"

Intranet IP

sourceWidth

int

1080

original width

sourceHeight

int

1920

original height

4 Quay lại ví dụ Dưới đây là ví dụ về yêu cầu trong cấu hình chung. Ví dụ:

{
    "code": 10000,
    "message": "SUCCESS",
    "data": [
        {
            "width": 272,
            "height": 480,
            "serial": "ea85356a",
            "model": "Redmi Note 3",
            "sort": 1,
            "name": "Redmi Note 33",
            "onlySerial": "ea85356a",
            "hide": false,
            "mode": 0,
            "status": "online",
            "connectTime": 1714294839013,
            "intranetIp": "192.168.111.143",
            "sourceWidth": 1080,
            "sourceHeight": 1920
        }
    ]
}

Ví dụ trả về 1:

{
    "code": 10001,
    "message": "Request parameter error",
    "data": null
}

Ví dụ trả về 2:

{
    "code": 10001,
    "message": "Invalid action",
    "data": null
}

UpdateDevices Cập nhật tên và số thiết bị

Cập nhật tên và số thiết bị 1 Thông số yêu cầu

Last updated