Mã lỗi

Khi tương tác với API SMSBAT, bạn có thể gặp lỗi. Chúng tôi sử dụng mã phản hồi HTTP thông thường để cho biết sự thành công hay thất bại của yêu cầu API.

Nói chung:

• Các mã trong phạm vi 2xx biểu thị thành công.
• Các mã trong phạm vi 4xx biểu thị lỗi không thành công dựa trên thông tin được cung cấp (ví dụ: tham số bắt buộc bị bỏ qua, loại thông báo không hợp lệ, v.v.).
• Các mã trong phạm vi 5xx cho biết có lỗi với máy chủ của chúng tôi.

Mã trạng thái HTTP

Mã	Trạng thái	Mô tả
200	Được	Yêu cầu đã thành công.
400	Yêu cầu Xấu	Yêu cầu này không được chấp nhận, thường là do thiếu tham số bắt buộc hoặc JSON không đúng định dạng.
401	Trái phép	Không có khóa API hợp lệ nào được cung cấp hoặc xác thực không thành công.
403	Cấm	Khóa API không có quyền thực hiện yêu cầu hoặc tài khoản của bạn bị tạm ngưng.
404	Không tìm thấy	Tài nguyên được yêu cầu không tồn tại.
415	Loại phương tiện không được hỗ trợ	Tiêu đề Content-Type bị thiếu hoặc không được đặt thành application/json.
422	Thực thể không thể xử lý	Yêu cầu được định dạng chính xác nhưng có lỗi ngữ nghĩa (ví dụ: định dạng số điện thoại không hợp lệ).
429	Quá nhiều yêu cầu	Quá nhiều yêu cầu truy cập API quá nhanh. Chúng tôi khuyên bạn nên lùi lại theo cấp số nhân đối với các yêu cầu của bạn.
500, 502, 503, 504	Lỗi Máy Chủ	Đã xảy ra lỗi ở phía SMSBAT.

Định dạng phản hồi lỗi

Khi một yêu cầu API dẫn đến lỗi, nội dung phản hồi sẽ chứa một đối tượng JSON cung cấp thêm thông tin chi tiết về sự cố.

{
  "status": 400,
  "error": "Bad Request",
  "message": "Missing required field: 'messages'",
  "code": 1001
}

Mã lỗi logic nghiệp vụ (Mã nội bộ)

Ngoài mã trạng thái HTTP, chúng tôi có thể trả về một mã nội bộ cụ thể để giúp bạn xác định lý do chính xác dẫn đến lỗi.

Mã nội bộ	Mô tả	Hành động được đề xuất
1001	Định dạng yêu cầu không hợp lệ	Đảm bảo nội dung yêu cầu của bạn là JSON hợp lệ.
1002	Thiếu trường bắt buộc	Kiểm tra thuộc tính message trong phản hồi để xem trường nào bị thiếu.
1003	Số điện thoại không hợp lệ	Đảm bảo số người nhận ở định dạng E.164 (ví dụ: 380501234567).
1004	Tên Alpha chưa đăng ký	Thông số from chứa tên alpha chưa được phê duyệt cho tài khoản của bạn.
1005	Số dư không đủ	Tài khoản của bạn không có đủ tiền để xử lý chiến dịch nhắn tin.
1006	Loại tin nhắn không hợp lệ	Tham số type phải là một trong các loại được hỗ trợ (ví dụ: sms, viber_promo).
1007	Không tìm thấy mẫu	ID mẫu Viber/OTP được yêu cầu không hợp lệ hoặc không được phê duyệt.
1008	Mục băng chuyền không hợp lệ	Một băng chuyền Viber phải chứa từ 2 đến 5 mục.

[!MẸO] Nếu bạn gặp mã lỗi không được liệt kê ở đây hoặc nếu bạn cho rằng lỗi được trả về do nhầm lẫn, vui lòng liên hệ với [email protected] và cung cấp tiêu đề cũng như trọng tải phản hồi chính xác.