Codici di errore dell'API
Ogni codice di errore dell'API Outbound con stato HTTP, significato e soluzione, perché la tua integrazione reagisca correttamente.
Se l'API Outbound rifiuta una richiesta, risponde con success: false, un codice fisso in error e una spiegazione in message. La tua integrazione decide in base a error, non al testo: i codici restano stabili, i testi possono cambiare.
{
"success": false,
"error": "invalid_to_number",
"message": "toNumber must be an international number in E.164 format …"
}
Panoramica
| Stato | Significato | Riprovare? |
|---|---|---|
| 400 | La richiesta è incompleta o non valida | solo dopo la correzione |
| 401 | L'autenticazione manca o non è valida | solo dopo la correzione |
| 402 | Manca l'abbonamento o il pagamento per questa via | solo dopo il pagamento |
| 403 | Questa azione non è ancora abilitata per il tuo account o per il numero | solo dopo l'abilitazione |
| 409 | Una richiesta con lo stesso Idempotency-Key è ancora in corso | sì, dopo Retry-After |
| 422 | La richiesta non corrisponde alla configurazione | solo dopo la correzione |
| 429 | Limite raggiunto | sì, dopo Retry-After |
| 500, 503 | Errore da parte nostra | sì, dopo una pausa e con lo stesso Idempotency-Key |
400: richiesta non valida
invalid_to_number
Il numero di destinazione non è in formato E.164. Scrivilo con il segno più e il prefisso internazionale, per esempio +491701234567. L'API rifiuta i formati nazionali come 0170 …, perché da questi non si ricava con certezza il paese.
invalid_from_number
Il numero mittente non è in formato E.164. Scrivilo come il numero di destinazione, con il segno più e il prefisso internazionale.
outbound_number_required
Manca fromNumber. Indica il tuo numero mittente: un numero importato o collegato via SIP, a cui è assegnato un agente.
platform_number_inbound_only
Il numero mittente è un numero acquistato da bhomy. Questi numeri ricevono solo chiamate. Importa il tuo numero o collegalo via SIP.
invalid_idempotency_key
L'header Idempotency-Key è vuoto, supera i 255 caratteri o contiene caratteri al di fuori dell'ASCII. Usa per esempio un UUID.
validation_error
Al momento non è stato possibile verificare il numero mittente. Riprova dopo una pausa.
Se il body manca o non è un JSON valido, l'API risponde anche in questo caso con 400, con una spiegazione in error, per esempio «Missing required field: toNumber».
401: autenticazione
Con 401 il motivo si trova in code:
code | Soluzione |
|---|---|
auth.missing_header | Invia l'header Authorization: Bearer … |
auth.invalid_type | L'header inizia con Bearer seguito da uno spazio |
auth.invalid_key | La chiave non esiste. Verifica che non contenga spazi o a capo |
auth.key_revoked | La chiave è disattivata. Riattivala in Chiave API o usane un'altra |
Maggiori informazioni in Problemi con le chiavi API.
402: pagamento
imported_number_subscription
Le chiamate da un numero importato richiedono un abbonamento attivo senza fatture aperte. Salda le fatture aperte in Fatturazione.
403: non ancora abilitato
identity_not_verified
Tramite l'API, bhomy chiama solo quando la tua identità è confermata. La risposta contiene verify_url, il link alla scheda Identità in Fatturazione. La verifica la fai una sola volta, vedi Chiamate in uscita.
sender_not_verified
Il numero mittente non è ancora confermato per le chiamate in uscita. Confermalo con la chiamata di verifica nelle sue impostazioni in Numero di telefono.
outbound_disabled
Per questo numero SIP le chiamate in uscita non sono configurate. Collegalo con l'indirizzo di terminazione e le credenziali del tuo operatore.
409: ancora in corso
idempotency_request_in_progress
Una richiesta con lo stesso Idempotency-Key è in elaborazione. Attendi i secondi indicati in Retry-After e invia di nuovo la stessa richiesta. Riceverai la risposta alla prima.
422: non corrisponde alla configurazione
idempotency_key_reused
Questo Idempotency-Key appartiene già a un'altra richiesta. Usa una nuova chiave per ogni nuova chiamata.
no_assistant_mapped
Al numero mittente non è assegnato alcun agente. Assegnagliene uno in Numero di telefono.
imported_number_destination
Un numero importato chiama numeri fissi e mobili tedeschi. Per altre destinazioni usa un numero SIP tramite il tuo operatore.
429: limite raggiunto
rate_limit_exceeded
Più di 60 richieste in 60 secondi. limit_scope indica il limite: per indirizzo IP o per chiave API. Attendi i secondi indicati in Retry-After e distribuisci le richieste.
concurrent_limit_reached
Tutte le linee sono occupate. Con limit_scope: "account" si tratta delle chiamate contemporanee del tuo piano, e la risposta indica allora current e limit. Con limit_scope: "platform" bhomy tiene libere per poco tempo alcune linee per le chiamate in entrata. In entrambi i casi attendi i secondi indicati in Retry-After.
500 e 503: errore da parte nostra
outbound_not_configured
Le chiamate in uscita al momento non sono configurate da parte nostra. Contatta il supporto.
outbound_unavailable
Il servizio per le chiamate in uscita è temporaneamente non raggiungibile. Riprova tra qualche minuto.
dispatch_failed
Non è stato possibile far partire l'agente. Riprova con lo stesso Idempotency-Key, così non si crea una chiamata doppia.
internal_error
Un errore imprevisto. Riprova. Se l'errore persiste, scrivici.
Con questi errori la risposta contiene spesso error_id. Inviacelo, vedi Segnalare un problema. Così troviamo subito l'operazione.
Se l'incarico è stato accettato ma la conversazione non è avvenuta
Una risposta 202 significa che l'incarico è stato accettato. Ciò che succede dopo compare come esito della chiamata nello storico chiamate, per esempio Nessuna risposta, Segreteria o Bloccata se il tuo account era bloccato. Gli esiti sono spiegati in Campagne.
Questa pagina ti è stata utile?