Virhekoodit
Kun käytät SMSBAT-sovellusliittymää, saatat kohdata virheitä. Käytämme tavanomaisia HTTP-vastauskoodeja ilmaisemaan API-pyynnön onnistumisen tai epäonnistumisen.
Yleisesti: - Koodit alueella "2xx" osoittavat onnistumisen. - Koodit alueella "4xx" osoittavat virheen, joka epäonnistui annettujen tietojen vuoksi (esim. pakollinen parametri jätettiin pois, viestityyppi on virheellinen jne.). - Koodit alueella "5xx" osoittavat virheen palvelimillamme.
HTTP-tilakoodit
| Koodi | Tila | Kuvaus |
|---|---|---|
| 200 | "OK" | Pyyntö onnistui. |
| 400 | "Huono pyyntö" | Pyyntöä ei voitu hyväksyä, koska usein vaadittu parametri puuttui tai JSON oli väärin muotoiltu. |
| 401 | "Luvaton" | Kelvollista API-avainta ei ole annettu tai todennus epäonnistui. |
| 403 | "Kielletty" | API-avaimella ei ole oikeuksia suorittaa pyyntöä tai tilisi on jäädytetty. |
| 404 | "Ei löydy" | Pyydettyä resurssia ei ole olemassa. |
| 415 | Ei tuettu mediatyyppi |
"Content-Type"-otsikko puuttuu tai sen arvoksi ei ole asetettu "application/json". |
| 422 | Prosessoimaton kokonaisuus |
Pyyntö oli muotoiltu oikein, mutta se sisälsi semanttisia virheitä (esim. virheellinen puhelinnumeron muoto). |
| 429 | "Liian monta pyyntöä" | Liian monta pyyntöä osui APIin liian nopeasti. Suosittelemme pyyntöjesi eksponentiaalista peruuttamista. |
| 500, 502, 503, 504 | "Palvelinvirheet" | Jotain meni vikaan SMSBAT:n päässä. |
Virhevastausmuoto
Kun API-pyyntö johtaa virheeseen, vastauksen runko sisältää JSON-objektin, jossa on lisätietoja ongelmasta.
{
"status": 400,
"error": "Bad Request",
"message": "Missing required field: 'messages'",
"code": 1001
}
Business Logic Error Codes (sisäiset koodit)
HTTP-tilakoodien lisäksi voimme palauttaa tietyn sisäisen "koodin", joka auttaa sinua tunnistamaan virheen tarkan syyn.
| Sisäinen koodi | Kuvaus | Ehdotettu toimenpide |
|----------------|----------------------------------|
| 1001 | "Virheellinen pyyntömuoto" | Varmista, että pyyntösi teksti on kelvollinen JSON. |
| 1002 | "Pakollinen kenttä puuttuu" | Tarkista vastauksen viesti-ominaisuus nähdäksesi, mikä kenttä puuttuu. |
| 1003 | "Virheellinen puhelinnumero" | Varmista, että vastaanottajan numero on E.164-muodossa (esim. "380501234567"). |
| 1004 | Rekisteröimätön alfa-nimi| "From"-parametri sisältää alfa-nimen, jota ei ole hyväksytty tilillesi. |
| 1005 | "Riittämätön saldo" | Tililläsi ei ole tarpeeksi varoja viestikampanjan käsittelemiseen. |
| 1006 | "Virheellinen viestityyppi" | Type-parametrin on oltava jokin tuetuista tyypeistä (esim. sms, viber_promo). |
| 1007 | Mallista ei löydy | Pyydetty Viber/OTP-mallin tunnus on virheellinen tai sitä ei ole hyväksytty. |
| 1008 | "Virheelliset karusellituotteet" | Viber-karusellissa on oltava 2–5 kohdetta. |
[!VINKKI] Jos kohtaat virhekoodin, jota ei ole lueteltu tässä, tai jos uskot, että virhe on palautettu vahingossa, ota yhteyttä [email protected] ja anna tarkka vastauksen hyötykuorma ja otsikot.