Tài liệu API quản lý cuộc gọi
Các điểm cuối này cho phép bạn truy xuất thông tin của mình. Cuộc gọi nhỡ, Cuộc gọi đến đã được trả lời, Và Cuộc gọi đi Đã đồng bộ hóa từ ứng dụng di động SMSMobileAPI vào bảng điều khiển + API của bạn.
Quan trọng: Nếu ứng dụng di động chạy ngầm, hệ thống điện thoại có thể gây ra độ trễ (thường lên đến ~10 phút) giữa các lần đồng bộ hóa. Bạn luôn có thể mở ứng dụng để đồng bộ hóa thủ công nếu cần.
Bạn cần trợ giúp? api@smsmobileapi.com
Hướng dẫn nhanh
URL cơ sở
LẤY https://api.smsmobileapi.com
Tất cả các điểm cuối bên dưới đều được ghi lại như sau: LẤY yêu cầu. Thay thế KHÓA_API_CỦA_BẠN Với khóa thật của bạn (đừng chia sẻ công khai).
Ví dụ
GET https://api.smsmobileapi.com/call/missed/list/?apikey=YOUR_API_KEY
GET https://api.smsmobileapi.com/call/incoming/list/?apikey=YOUR_API_KEY&limit=50&offset=0&sort_by=call_date_ms&sort_dir=desc
GET https://api.smsmobileapi.com/call/outgoing/list/?apikey=YOUR_API_KEY&q=3247&date_from_ms=1700000000000&date_to_ms=1700864000000
Xác thực
Các thiết bị đầu cuối Quản lý cuộc gọi xác thực bằng cách sử dụng con khỉ tham số truy vấn.
Xác thực đăng ký: Các điểm cuối đến/đi xác thực khóa API của bạn và kiểm tra tính hợp lệ của gói đăng ký (dateLimit >= CURDATE()Nếu hết hạn, bạn sẽ nhận được api_expired.
Khái niệm chung
Đánh số trang
Sử dụng giới hạn Và bù lại để phân trang kết quả.
Dấu thời gian
- ngày gọi_ms là dấu thời gian UNIX trong mili giây.
- call_datetime_utc được lưu trữ dưới dạng chuỗi ngày giờ UTC (trường cơ sở dữ liệu).
- Đối với các cuộc gọi nhỡ, API trả về một định dạng được xác định. ngày Chuỗi ký tự (được suy ra từ giá trị mili giây).
Tìm kiếm
- Cuộc gọi nhỡ: tìm kiếm Phù hợp với số hoặc tên.
- Cuộc gọi đến/Đi: q các trận đấu số_điện_thoại hoặc tên_được_lưu_chứa.
Phân loại (Chỉ áp dụng cho thư đến/thư đi)
Việc phân loại được điều khiển bởi sắp xếp theo + thư mục sắp xếp (Chỉ các trường được cho phép). Cuộc gọi nhỡ luôn được sắp xếp theo thứ tự mới nhất trước.
Lỗi
| HTTP | Ví dụ lỗi | Nghĩa |
|---|---|---|
| 400 | {"success":false,"error":"missing_apikey"} | Thiếu hoặc trống con khỉ. |
| 403 | {"success":false,"error":"invalid_apikey"} | Không tìm thấy/không nhận dạng được khóa API. |
| 403 | {"success":false,"error":"api_expired"} | Gói đăng ký của bạn đã hết hạn (Giới hạn ngày (trước ngày hôm nay). |
| 500 | {"success":false,"error":"server_error","detail":"..."} | Lỗi máy chủ (cơ sở dữ liệu, SQL, ngoại lệ). |
Lưu ý: điểm cuối Cuộc gọi nhỡ cũng có thể trả về các thông báo như sau: Thiếu apikey hoặc các lỗi chuẩn bị câu lệnh SQL tùy thuộc vào tình huống.
Danh sách cuộc gọi nhỡ
Truy xuất các cuộc gọi nhỡ đã được đồng bộ hóa từ thiết bị di động.
Điểm cuối
LẤY https://api.smsmobileapi.com/call/missed/list/
Tham số truy vấn
| Tham số | Kiểu | Sự miêu tả |
|---|---|---|
| con khỉ | sợi dây | Yêu cầu Mã API của bạn được liên kết với điện thoại di động. |
| bù lại | số nguyên | Không bắt buộc Vị trí phân trang (mặc định: 0). |
| giới hạn | số nguyên | Không bắt buộc Số hàng tối đa (mặc định: 100, tối đa: 500). |
| tìm kiếm | sợi dây | Không bắt buộc Tìm kiếm theo số hoặc tên (SQL LIKE). |
| ngày bắt đầu | YYYY-MM-DD | Không bắt buộc Lọc dữ liệu từ ngày này (00:00:00). |
| ngày_kết thúc | YYYY-MM-DD | Không bắt buộc Lọc dữ liệu đến ngày hôm nay (23:59:59). |
Danh sách cuộc gọi đến
Nhận các cuộc gọi đến đã được trả lời và đồng bộ hóa từ thiết bị di động.
Điểm cuối
LẤY https://api.smsmobileapi.com/call/incoming/list/
Tham số truy vấn
| Tham số | Kiểu | Sự miêu tả |
|---|---|---|
| con khỉ | sợi dây | Yêu cầu Khóa API của bạn (đã được xác thực dựa trên gói đăng ký). |
| giới hạn | số nguyên | Không bắt buộc Số hàng trên mỗi trang (mặc định: 50, tối đa: 200). |
| bù lại | số nguyên | Không bắt buộc Vị trí phân trang (mặc định: 0). |
| sắp xếp theo | sợi dây | Không bắt buộc Cho phép: ngày gọi_ms call_datetime_utc thời lượng_giây số_điện_thoại created_at tên_được_lưu_chứa vị trí địa lý |
| thư mục sắp xếp | tăng dần|giảm dần | Không bắt buộc Mặc định: mô tả. |
| ngày_từ_ms | int (ms) | Không bắt buộc Lọc theo vị trí call_date_ms >= date_from_ms. |
| ngày_đến_ms | int (ms) | Không bắt buộc Lọc theo vị trí call_date_ms <= date_to_ms. |
| q | sợi dây | Không bắt buộc Tìm kiếm trên số_điện_thoại hoặc tên_được_lưu_chứa (GIỐNG). |
Danh sách cuộc gọi đi
Truy xuất các cuộc gọi đi đã được đồng bộ hóa từ thiết bị di động.
Điểm cuối
LẤY https://api.smsmobileapi.com/call/outgoing/list/
Tham số truy vấn
Các thông số và hoạt động tương tự như cuộc gọi đến.
| Tham số | Kiểu | Sự miêu tả |
|---|---|---|
| con khỉ | sợi dây | Yêu cầu Khóa API của bạn (đã được xác thực dựa trên gói đăng ký). |
| giới hạn | số nguyên | Không bắt buộc Số hàng trên mỗi trang (mặc định: 50, tối đa: 200). |
| bù lại | số nguyên | Không bắt buộc Vị trí phân trang (mặc định: 0). |
| sắp xếp theo | sợi dây | Không bắt buộc Cho phép: ngày gọi_ms call_datetime_utc thời lượng_giây số_điện_thoại created_at tên_được_lưu_chứa vị trí địa lý |
| thư mục sắp xếp | tăng dần|giảm dần | Không bắt buộc Mặc định: mô tả. |
| ngày_từ_ms | int (ms) | Không bắt buộc Lọc theo vị trí call_date_ms >= date_from_ms. |
| ngày_đến_ms | int (ms) | Không bắt buộc Lọc theo vị trí call_date_ms <= date_to_ms. |
| q | sợi dây | Không bắt buộc Tìm kiếm trên số_điện_thoại hoặc tên_được_lưu_chứa (GIỐNG). |
Trường cuộc gọi nhỡ
| Cánh đồng | Kiểu | Sự miêu tả |
|---|---|---|
| thành công | boolean | Trạng thái yêu cầu. |
| bù lại | số nguyên | Đã trả về vị trí offset của trang. |
| giới hạn | số nguyên | Đã trả về giới hạn phân trang. |
| đếm | số nguyên | Số lượng hàng được trả về trong dữ liệu. |
| dữ liệu | mảng | Danh sách các cuộc gọi nhỡ. |
| data[].number | sợi dây | Số điện thoại người gọi. |
| data[].name | sợi dây | Tên liên hệ được lưu trong bộ nhớ cache (có thể trống). |
| data[].date | sợi dây | Chuỗi ngày giờ được định dạng, được tạo ra từ dấu thời gian tính bằng mili giây. |
Trường đến/đi
| Cánh đồng | Kiểu | Sự miêu tả |
|---|---|---|
| thành công | boolean | Trạng thái yêu cầu. |
| con khỉ | sợi dây | Được API (khóa của bạn) phản hồi lại. |
| giới hạn | số nguyên | Số dòng trả về trên mỗi trang. |
| bù lại | số nguyên | Đã trả về vị trí offset của trang. |
| sắp xếp theo | sợi dây | Áp dụng trường sắp xếp. |
| thư mục sắp xếp | sợi dây | Hướng sắp xếp đã được áp dụng. |
| bộ lọc | sự vật | Bộ lọc phản xạ (ngày_từ_ms, ngày_đến_ms, q). |
| đếm | số nguyên | Số lượng hàng được trả về trong hàng. |
| hàng | mảng | Danh sách cuộc gọi. |
| hàng[].số_điện_thoại | sợi dây | Số điện thoại. |
| rows[].cached_name | chuỗi|null | Tên liên hệ được lưu trong bộ nhớ cache (có thể là null). |
| hàng[].ngày_cuộc_gọi_ms | số nguyên | Thời gian thực hiện cuộc gọi tính bằng mili giây. |
| hàng[].call_datetime_utc | sợi dây | Trường thời gian UTC (cơ sở dữ liệu). |
| hàng[].thời lượng_giây | số nguyên | Thời lượng tính bằng giây. |
| hàng[].vị trí địa lý | chuỗi|null | Nhãn vị trí địa lý (có thể là null/rỗng). |
| rows[].created_at | sợi dây | Thời điểm chèn dữ liệu vào máy chủ. |
English 
French 
German 
Spanish 
Portuguese 
Russian 
Finnish 
Japanese 
Chinese 
Vietnamese 
Dutch 
Greek 
Arabic 
Danish 
Italian 
Ukrainian