Overview
L'API REST BroadNet segnala gli errori con un codice di stato HTTP standard e un corpo JSON chiamato ExceptionResponse, con cinque campi: status, error, message, errorCode e requestUri. La corrispondenza avviene prima sullo stato HTTP, poi su errorCode. Un'eccezione: un token Bearer mancante o non valido viene rifiutato prima, al gateway API, con un codice 401 il cui corpo contiene solo error e message.
Codici di stato
400 indica un errore di convalida o un campo obbligatorio mancante: correggere la richiesta. 401 indica che il token Bearer è mancante o non valido, e 403 che non è consentito chiamare l'operazione: correggere il token. 500 indica un errore imprevisto del server e 502 indica che un provider a monte ha rifiutato la chiamata: riprovare con backoff esponenziale. I bind SMPP restituiscono invece i codici standard command_status SMPP.
Esempi
Copia, incolla, sostituisci i segnaposto: questi esempi chiamano l'API di produzione così come sono.
{
"status": 400,
"error": "Bad Request",
"message": "…",
"errorCode": "…",
"requestUri": "/sms/sendSms"
}{
"error": "Unauthorized",
"message": "Missing Authorization token"
}