Chuyển tới nội dung chính

API huỷ tin nhắn Quảng cáo

Tài liệu này hướng dẫn cách sử dụng API để huỷ tin nhắn quảng cáo

  • Phương thức: PUT
  • Endpoint: https://api.yoursales.vn/api/public/sms/cancel-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 hủy tin nhắn quảng cáo


🔐 Header yêu cầu​

TênGiá trịBắt buộc
AuthorizationBasic {API_KEY}✅
Content-Typeapplication/json✅
Acceptapplication/json✅

📦 Dữ liệu gửi lên (Request Body)​

{
"campaign_code": "4b85fec5-537e-483f-b23b-3ce251bcc280"
}
TrườngLoạiMô tảBắt buộc
campaign_codestringMã chiến dịch✅

✅ Phản hồi thành công​

  • HTTP Code: 200 OK
{
"message": "Thành công",
"data": {
"code": "e7c57cd5-77f9-4a45-9b51-4dce26de2199"
}
}
  • Ý nghĩa: Chiến dịch đã được huỷ thành công.

❌ Phản hồi thất bại​

  • HTTP Code: != 200 OK
{
"message": "Chiến dịch không thể huỷ",
"error_code": "00010"
}


💻 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 '{
"campaign_code": "e7c57cd5-77f9-4a45-9b51-4dce26de2199"
}'

📌 Ghi chú​

  • Trong trường hợp tin nhắn vẫn đang được lưu trữ tại hệ thống (chưa chuyển tiếp đến nhà mạng). Nếu tin nhắn đã được xử lý hoặc đã gửi đi, việc hủy sẽ không thực hiện được. Khi đó, vui lòng liên hệ trực tiếp với chúng tôi để được hỗ trợ thêm.
  • API_KEY sẽ được cung cấp khi khởi tạo tài khoản