Codici di errore
Quando interagisci con l'API SMSBAT, potresti riscontrare errori. Utilizziamo codici di risposta HTTP convenzionali per indicare il successo o il fallimento di una richiesta API.
In generale: - I codici nell'intervallo "2xx" indicano il successo. - I codici nell'intervallo "4xx" indicano un errore che non è riuscito in base alle informazioni fornite (ad esempio, un parametro obbligatorio è stato omesso, un tipo di messaggio non è valido, ecc.). - I codici nell'intervallo "5xx" indicano un errore con i nostri server.
Codici di stato HTTP
| Codice | Stato | Descrizione |
|---|---|---|
| 200 | "Va bene" | La richiesta ha avuto successo. |
| 400 | "Richiesta errata" | La richiesta era inaccettabile, spesso a causa della mancanza di un parametro obbligatorio o di un formato JSON non valido. |
| 401 | "Non autorizzato" | Nessuna chiave API valida fornita oppure autenticazione non riuscita. |
| 403 | Proibito |
La chiave API non dispone delle autorizzazioni per eseguire la richiesta oppure il tuo account è sospeso. |
| 404 | "Non trovato" | La risorsa richiesta non esiste. |
| 415 | "Tipo multimediale non supportato" | L'intestazione "Content-Type" manca o non è impostata su "application/json". |
| 422 | Entità non elaborabile |
La richiesta era formattata correttamente ma conteneva errori semantici (ad esempio formato del numero di telefono non valido). |
| 429 | "Troppe richieste" | Troppe richieste raggiungono l'API troppo rapidamente. Consigliamo un backoff esponenziale delle vostre richieste. |
| 500, 502, 503, 504 | "Errori del server" | Qualcosa è andato storto da parte di SMSBAT. |
Formato della risposta all'errore
Quando una richiesta API genera un errore, il corpo della risposta contiene un oggetto JSON con maggiori dettagli sul problema.
{
"status": 400,
"error": "Bad Request",
"message": "Missing required field: 'messages'",
"code": 1001
}
Codici di errore di logica aziendale (codici interni)
Oltre ai codici di stato HTTP, potremmo restituire uno specifico "codice" interno per aiutarti a identificare il motivo esatto dell'errore.
| Codice interno | Descrizione | Azione consigliata |
|------||-------------|------------|
| 1001 | "Formato richiesta non valido" | Assicurati che il corpo della richiesta sia un JSON valido. |
| 1002 | "Campo obbligatorio mancante" | Controlla la proprietà "message" nella risposta per vedere quale campo manca. |
| 1003 | "Numero di telefono non valido" | Assicurati che il numero del destinatario sia nel formato E.164 (ad esempio, "380501234567"). |
| 1004 | Nome alfa non registrato| Il parametro "from" contiene un nome alfa che non è stato approvato per il tuo account. |
| 1005 | "Saldo insufficiente" | Il tuo account non dispone di fondi sufficienti per elaborare la campagna di messaggistica. |
| 1006 | "Tipo di messaggio non valido" | Il parametro "type" deve essere uno dei tipi supportati (ad esempio, "sms", "viber_promo"). |
| 1007 | "Modello non trovato" | L'ID del modello Viber/OTP richiesto non è valido o non è approvato. |
| 1008 | "Elementi carosello non validi" | Un carosello Viber deve contenere da 2 a 5 articoli. |
[!CONSIGLIO] Se riscontri un codice di errore non elencato qui o se ritieni che un errore sia stato restituito per errore, contatta [email protected] e fornisci il payload e le intestazioni esatte della risposta.