Kom i gang
Svar og feil
Alle svar har feltet
ok. Når det er true, ligger resultatet i data. Når det er false, forteller svaret om vi avviste kallet eller om noe gikk galt hos oss.Når det går bra
HTTP-status 200, ok: true og resultatet i data. Feltene i data for hver operasjon står i API-referansen.
{ "ok": true, "data": { "…": "…" }}Når vi avviser kallet
En avvisning er et svar vi har bestemt på forhånd: saldoen er for lav, nummeret er meldt av, nøkkelen mangler en tilgang. Svaret har ok: false og en kode i refused.code, og HTTP-statusen passer til koden. Ingenting er sendt, og ingenting er trukket.
{ "ok": false, "refused": { "code": "insufficient_credits" }}Les koden, ikke teksten eller statusen alene. Kodene endrer seg ikke, og API-referansen lister kodene hver operasjon kan svare. Noen avvisninger har også:
| Felt | Betyr |
|---|---|
refused.retryable | true når samme kall kan gå senere uten endringer. |
refused.meta | Detaljer om avvisningen. limit_reached sier for eksempel hvilken grense som er nådd. rate_limited sier hvor lenge du skal vente. |
Koder du møter ofte
| Kode | Betyr |
|---|---|
invalid_input (400) | Et felt mangler eller har feil form. |
idempotency_key_required (400) | Kallet krever Idempotency-Key. Se Idempotens. |
unauthenticated (401) | Nøkkelen mangler, er feil eller er trukket tilbake. |
insufficient_credits (402) | Saldoen dekker ikke kallet. Fyll på i dashbordet. |
profile_limit_reached (402) | Profilens månedsgrense er nådd. |
scope_missing (403) | Nøkkelen mangler tilgangen kallet krever. Se Tilganger. |
limit_reached (403) | En av bedriftens grenser er nådd. Se Grenser. |
recipient_opted_out (422) | Mottakeren har meldt seg av SMS fra profilen. |
idempotency_key_reuse (422) | Samme Idempotency-Key ble brukt med et annet innhold. |
rate_limited (429) | For mange kall på kort tid. Vent så lenge Retry-After sier. |
service_unavailable (503) | Tjenesten er ikke tilgjengelig akkurat nå. Prøv igjen senere. |
Når noe går galt hos oss
En feil vi ikke har planlagt, har ok: false og error i stedet for refused, med HTTP-status 500 eller 503. Ta med error.requestId når du kontakter oss.
{ "ok": false, "error": { "kind": "unavailable", "requestId": "…" }}HTTP-statuser
200: utført. Gjelder også kall som starter noe som fortsetter, som en SMS i kø. Følg resten med hendelser eller ved å lese objektet.4xx: avvist. Rett kallet, eller vent når koden sier det.5xx: feil hos oss eller hos en leverandør. Prøv igjen med sammeIdempotency-Key.