Tài liệu API thông báo
Các điểm cuối này cho phép bạn gửi thông báo nội bộ trên thiết bị di động Và truy xuất lịch sử thông báo Từ SMSMobileAPI. Thông báo có thể được gửi đến một thiết bị di động cụ thể và sau đó được theo dõi thông qua điểm cuối danh sách.
Các thông báo/danh sách Điểm cuối trả về thời gian gửi thông báo và thời gian phân phối. GMTbao gồm cả chuỗi ngày giờ đầy đủ và Dấu thời gian Unix.
Hướng dẫn nhanh
URL cơ sở
Ví dụ
Xác thực
Các điểm cuối thông báo xác thực bằng cách sử dụng con khỉ tham số.
Khái niệm chung
Target mobile
Thông báo được gửi đến một thiết bị di động cụ thể bằng cách sử dụng bênĐiểm cuối danh sách có thể lọc cùng một mục tiêu bằng cách sử dụng... chất nhận dạng hoặc bên.
Trạng thái phân phối
- phân phối=1 Điều này có nghĩa là thông báo đã được gửi đi.
- phân phối=0 Có nghĩa là chưa được phân phối.
- trạng thái phân phối trả lại phân phối hoặc không được phân phối.
Ngày tháng và múi giờ
- đã gửi_* Các trường này thể hiện ngày/giờ gửi thông báo. GMT.
- phân phối_* Các trường này thể hiện ngày/giờ phân phối. GMT.
- *_tại_unix Các trường này là dấu thời gian Unix.
Liệt kê hành vi điểm cuối
- Điểm cuối danh sách luôn trả về giá trị tối đa là 200 hàng.
- Kết quả được sắp xếp từ mới nhất đến cũ nhất dựa trên ngày/giờ gửi.
- Bộ lọc ngày sử dụng ngày thêm bên trong và được phơi bày ra ngoài như ngày_từ / ngày_đến.
Lỗi
| HTTP | Ví dụ lỗi | Nghĩa |
|---|---|---|
| 400 | {"success":false,"message":"Thiếu tham số bắt buộc: apikey."} | Thiếu hoặc trống con khỉ. |
| 400 | {"success":false,"message":"Thiếu các tham số bắt buộc: apikey và sid là bắt buộc."} | Mất tích bên TRÊN thông báo/gửi. |
| 400 | {"success":false,"message":"Thiếu tham số bắt buộc: message."} | Mất tích tin nhắn TRÊN thông báo/gửi. |
| 400 | {"success":false,"message":"Định dạng ngày tháng không hợp lệ. Dự kiến định dạng YYYY-MM-DD."} | Không hợp lệ ngày_từ định dạng trên thông báo/danh sách. |
| 400 | {"success":false,"message":"Giá trị được phân phối không hợp lệ. Các giá trị được cho phép: 0 hoặc 1."} | Không hợp lệ phân phối giá trị lọc. |
| 500 | {"success":false,"message":"Kết nối cơ sở dữ liệu thất bại."} | Lỗi kết nối cơ sở dữ liệu. |
| 500 | {"success":false,"message":"Truy vấn thất bại: ..."} | Lỗi thực thi SQL. |
Thông báo – Gửi
Tạo thông báo mới cho thiết bị di động mục tiêu.
Điểm cuối
Tham số truy vấn / nội dung
| 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. |
| bên | sợi dây | Yêu cầu Nhận dạng mục tiêu trên thiết bị di động. |
| tiêu đề | sợi dây | Không bắt buộc Tiêu đề thông báo. Mặc định: Thông báo. |
| tin nhắn | sợi dây | Yêu cầu Nội dung tin nhắn thông báo. |
| kiểu | sợi dây | Không bắt buộc Loại thông báo. Mặc định: thông báo. |
Ví dụ về phản hồi thành công
{ "success": true, "message": "Thông báo đã được tạo.", "id": 22087, "apikey": "YOUR_API_KEY", "sid": "508b004b4aadacc4" }
Thông báo – Danh sách
Truy xuất các thông báo mới nhất cho một khóa API, với tùy chọn lọc.
Điểm cuối
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. |
| chất nhận dạng | sợi dây | Không bắt buộc Lọc thông báo theo thiết bị di động mục tiêu. |
| bên | sợi dây | Không bắt buộc Bí danh của chất nhận dạng. |
| phân phối | 0 | 1 | Không bắt buộc 1 = chỉ phân phối, 0 = không được phân phối. |
| ngày_từ | YYYY-MM-DD | Không bắt buộc Lọc ngày gửi từ ngày này trở đi. |
| ngày_đến | YYYY-MM-DD | Không bắt buộc Lọc theo ngày gửi đến hôm nay. |
Ví dụ về phản hồi thành công
{ "success": true, "message": "Thông báo đã được truy xuất thành công.", "filters": { "sidentifiant": "508b004b4aadacc4", "distributed": "1", "date_from": "", "date_to": "", "limit": 200 }, "count": 1, "data": [ { "sidentifiant": "508b004b4aadacc4", "title": "Thông báo", "message": "vers miano", "distributed": "1", "distributed_status": "distributed", "distributed_date_gmt": "2026-03-18", "distributed_time_gmt": "10:18:30", "distributed_at_gmt": "2026-03-18 10:18:30", "distributed_at_unix": 1773829110, "distributed_timezone": "GMT", "sent_date_gmt": "2026-03-18", "sent_time_gmt": "10:15:03", "sent_at_gmt": "2026-03-18 10:15:03", "sent_at_unix": 1773828903, "sent_timezone": "GMT" } ] }
Gửi các trường phản hồi
| Cánh đồng | Kiểu | Sự miêu tả |
|---|---|---|
| thành công | boolean | Trạng thái yêu cầu. |
| tin nhắn | sợi dây | Thông báo kết quả dễ hiểu đối với người dùng. |
| nhận dạng | số nguyên | Đã tạo ID thông báo trong cơ sở dữ liệu. |
| con khỉ | sợi dây | Khóa API được hiển thị. |
| bên | sợi dây | Mã định danh thiết bị di động mục tiêu được sử dụng trong quá trình tạo. |
Liệt kê các trường phản hồi
| Cánh đồng | Kiểu | Sự miêu tả |
|---|---|---|
| thành công | boolean | Trạng thái yêu cầu. |
| tin nhắn | sợi dây | Thông báo kết quả dễ hiểu đối với người dùng. |
| bộ lọc | sự vật | Các bộ lọc được phản hồi sử dụng bởi yêu cầu. |
| đếm | số nguyên | Số lượng thông báo được trả lại. |
| dữ liệu | mảng | Danh sách thông báo. |
| data[].identifiant | sợi dây | Mã định danh thiết bị di động mục tiêu. |
| data[].title | sợi dây | Tiêu đề thông báo. |
| data[].message | sợi dây | Thông báo. |
| dữ liệu[].phân phối | sợi dây | Cờ phân phối thô. |
| data[].distribued_status | sợi dây | phân phối hoặc không được phân phối. |
| data[].distributed_date_gmt | sợi dây | Ngày phân phối theo giờ GMT. |
| data[].distributed_time_gmt | sợi dây | Thời gian phân phối tính theo giờ GMT. |
| data[].distributed_at_gmt | sợi dây | Thời gian phân phối đầy đủ theo múi giờ GMT. |
| data[].distributed_at_unix | int|null | Thời gian phân phối được thể hiện dưới dạng dấu thời gian Unix. |
| data[].distributed_timezone | sợi dây | Luôn luôn GMT. |
| data[].sent_date_gmt | sợi dây | Ngày gửi được tính theo múi giờ GMT. |
| data[].sent_time_gmt | sợi dây | Gửi thời gian theo múi giờ GMT. |
| data[].sent_at_gmt | sợi dây | Thời gian gửi đầy đủ theo múi giờ GMT. |
| data[].sent_at_unix | int|null | Gửi ngày giờ dưới dạng dấu thời gian Unix. |
| data[].sent_timezone | sợi dây | Luôn luôn GMT. |
