API gửi tin nhắn Quảng Cáo
Tài liệu này hướng dẫn cách sử dụng API để gửi tin nhắn quảng cáo hàng loạt
- Phương thức:
POST - Endpoint:
https://api.yoursales.vn/api/public/sms/send-ads - Yêu cầu xác thực:
Authorization: Basic {API_KEY} - Content-Type:
application/json
📝 Mô tả
API này cho phép gửi tin nhắn quảng cáo đến nhiều số điện thoại thông qua chiến dịch với một brandname đã được cấu hình sẵn.
🔐 Header yêu cầu
| Tên | Giá trị | Bắt buộc |
|---|---|---|
| Authorization | Basic {API_KEY} | ✅ |
| Content-Type | application/json | ✅ |
| Accept | application/json | ✅ |
📦 Dữ liệu gửi lên (Request Body)
{
"brand": "ABC_CORP",
"campaign_name": "KM_Thang4",
"msg": "Ưu đãi tháng 4: Giảm 50% toàn bộ sản phẩm!",
"list_phone": ["84901234567", "84907654321"],
"sent_time": "2024-04-26 10:00:00",
"client_campaign_id": "KM_T4_001"
}
| Trường | Loại | Mô tả | Bắt buộc |
|---|---|---|---|
| brand | string | Tên brandname đã được đăng ký và kích hoạt | ✅ |
| campaign_name | string | Tên chiến dịch quảng cáo | ✅ |
| msg | string | Nội dung tin nhắn quảng cáo | ✅ |
| list_phone | array | Danh sách số điện thoại người nhận. Giới hạn 1.000.000 số điện thoại | ✅ |
| sent_time | datetime | Thời gian gửi tin (định dạng Y-m-d H:i:s) | ✅ |
| client_campaign_id | string | Mã chiến dịch từ phía khách hàng | ❌ |
✅ Phản hồi thành công
- HTTP Code:
201 Created
{
"message": "Thành công",
"data": {
"code": "e7c57cd5-77f9-4a45-9b51-4dce26de2199"
}
}
- Ý nghĩa: Chiến dịch đã được tạo và đưa vào hàng đợi xử lý.
❌ Phản hồi thất bại
- HTTP Code:
!= 201 Created
{
"message": "Brandname không tồn tại",
"error_code": "00010"
}
- Danh sách mã lỗi: Tại đây
💻 Ví dụ CURL
curl -X POST https://your-domain.com/api/v1/sms/ads/send \
-H "Authorization: Basic YOUR_API_KEY" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"brand": "ABC_CORP",
"campaign_name": "KM_Thang4",
"msg": "Ưu đãi tháng 4: Giảm 50% toàn bộ sản phẩm!",
"list_phone": ["84901234567", "84907654321"],
"sent_time": "2024-04-26 10:00:00",
"client_campaign_id": "KM_T4_001"
}'
📌 Ghi chú
- Số điện thoại phải chuẩn định dạng Việt Nam, bắt đầu bằng
84xhoặc0xxvà có đúng 11 chữ số. - Brandname phải là brand đã được kích hoạt và có liên kết với khách hàng của API Key.
- Chiến dịch sẽ được kiểm duyệt bởi nhà mạng
API_KEYsẽ được cung cấp khi khởi tạo tài khoản