Κωδικοί σφαλμάτων
Κατά την αλληλεπίδραση με το SMSBAT API, ενδέχεται να αντιμετωπίσετε σφάλματα. Χρησιμοποιούμε συμβατικούς κωδικούς απόκρισης HTTP για να υποδείξουμε την επιτυχία ή την αποτυχία ενός αιτήματος API.
Γενικά: - Οι κωδικοί στην περιοχή «2xx» υποδεικνύουν επιτυχία. - Οι κωδικοί στο εύρος «4xx» υποδεικνύουν ένα σφάλμα που απέτυχε με βάση τις παρεχόμενες πληροφορίες (π.χ. μια απαιτούμενη παράμετρος παραλείφθηκε, ένας τύπος μηνύματος δεν είναι έγκυρος κ.λπ.). - Οι κωδικοί στην περιοχή "5xx" υποδεικνύουν σφάλμα με τους διακομιστές μας.
Κωδικοί κατάστασης HTTP
| Κωδικός | Κατάσταση | Περιγραφή |
|---|---|---|
| 200 | «ΟΚ» | Το αίτημα ήταν επιτυχές. |
| 400 | «Κακό αίτημα» | Το αίτημα ήταν απαράδεκτο, συχνά λόγω έλλειψης μιας απαιτούμενης παραμέτρου ή λανθασμένης μορφής JSON. |
| 401 | «Μη εξουσιοδοτημένο» | Δεν παρέχεται έγκυρο κλειδί API ή ο έλεγχος ταυτότητας απέτυχε. |
| 403 | «Απαγορεύεται» | Το κλειδί API δεν έχει δικαιώματα για την εκτέλεση του αιτήματος ή ο λογαριασμός σας έχει τεθεί σε αναστολή. |
| 404 | «Δεν βρέθηκε» | Ο πόρος που ζητήθηκε δεν υπάρχει. |
| 415 | "Μη υποστηριζόμενος τύπος μέσου" | Η κεφαλίδα "Content-Type" λείπει ή δεν έχει οριστεί σε "application/json". |
| 422 | "Μη επεξεργάσιμη οντότητα" | Το αίτημα μορφοποιήθηκε σωστά αλλά περιείχε σημασιολογικά σφάλματα (π.χ. μη έγκυρη μορφή αριθμού τηλεφώνου). |
| 429 | «Πάρα πολλά αιτήματα» | Πάρα πολλά αιτήματα έπληξαν το API πολύ γρήγορα. Συνιστούμε μια εκθετική υποχώρηση των αιτημάτων σας. |
| 500, 502, 503, 504 | Σφάλματα διακομιστή |
Κάτι πήγε στραβά στο τέλος του SMSBAT. |
Μορφή απόκρισης σφάλματος
Όταν ένα αίτημα API καταλήγει σε σφάλμα, το σώμα απόκρισης περιέχει ένα αντικείμενο JSON με περισσότερες λεπτομέρειες σχετικά με το πρόβλημα.
{
"status": 400,
"error": "Bad Request",
"message": "Missing required field: 'messages'",
"code": 1001
}
Κωδικοί σφαλμάτων Business Logic (εσωτερικοί κωδικοί)
Εκτός από τους κωδικούς κατάστασης HTTP, ενδέχεται να επιστρέψουμε έναν συγκεκριμένο εσωτερικό «κωδικό» για να σας βοηθήσουμε να προσδιορίσετε την ακριβή αιτία της αποτυχίας.
| Εσωτερικός Κωδικός | Περιγραφή | Προτεινόμενη Δράση |
|---|---|---|
| 1001 | Μη έγκυρη μορφή αιτήματος |
Βεβαιωθείτε ότι το σώμα του αιτήματός σας είναι έγκυρο JSON. |
| 1002 | «Απαιτούμενο πεδίο λείπει» | Ελέγξτε την ιδιότητα «μήνυμα» στην απάντηση για να δείτε ποιο πεδίο λείπει. |
| 1003 | "Μη έγκυρος αριθμός τηλεφώνου" | Βεβαιωθείτε ότι ο αριθμός παραλήπτη είναι σε μορφή E.164 (π.χ. 380501234567). |
| 1004 | Μη καταχωρημένο Alpha Name |
Η παράμετρος «από» περιέχει ένα όνομα άλφα που δεν έχει εγκριθεί για τον λογαριασμό σας. |
| 1005 | «Ανεπαρκές υπόλοιπο» | Ο λογαριασμός σας δεν έχει αρκετά χρήματα για την επεξεργασία της καμπάνιας ανταλλαγής μηνυμάτων. |
| 1006 | Μη έγκυρος τύπος μηνύματος |
Η παράμετρος «type» πρέπει να είναι ένας από τους υποστηριζόμενους τύπους (π.χ. «sms», «viber_promo»). |
| 1007 | «Το πρότυπο δεν βρέθηκε» | Το αναγνωριστικό προτύπου Viber/OTP που ζητήθηκε δεν είναι έγκυρο ή δεν έχει εγκριθεί. |
| 1008 | "Μη έγκυρα είδη καρουζέλ" | Ένα Viber Carousel πρέπει να περιέχει από 2 έως 5 αντικείμενα. |
[!ΣΥΜΒΟΥΛΗ] Εάν αντιμετωπίσετε έναν κωδικό σφάλματος που δεν αναφέρεται εδώ ή εάν πιστεύετε ότι ένα σφάλμα επιστράφηκε κατά λάθος, επικοινωνήστε με το [email protected] και δώστε το ακριβές ωφέλιμο φορτίο απόκρισης και τις κεφαλίδες.