Dokumente

Versenden Sie Ihre erste Nachricht an einem Nachmittag

Eine einfache REST-API zum Senden, Verfolgen und Empfangen von SMS – Token-Authentifizierung, Echtzeit-Webhooks und SDKs, ohne dass es etwas Exotisches zu lernen gibt.

Schnellstart

Drei Züge, Start bis Lieferung

Jede Integration ist der gleiche kurze Bogen: Authentifizieren, Senden und dann Verfolgen.

01 · AuthentifizierenToken: sk_live_9f2a7c10Inhaltstyp: application/json ✓

Senden Sie Ihren Zugriffsschlüssel bei jeder Anfrage als Token-Header mit Content-Type: application/json.

02 · SchickenPOST /external/sms{ msgstr: "9f2a7c10", Fehlercode: 0 }

POSTEN Sie ein Von, An und einen Inhalt. Die Antwort kommt sofort mit einer msgid und einem Fehlercode zurück.

03 · SchieneGET /report?status=Delivrd200 OK

Sobald eine Nachricht ihren endgültigen Status erreicht, posten oder erhalten wir einen Statusbericht an Ihre Rückruf-URL.

Schicken

Eine Anfrage, in der Sprache, die Sie bereits verwenden

POSTEN Sie Ihren Absender, Empfänger und Inhalt mit einem Token-Header. Die Antwort kommt in dem Moment zurück, in dem wir sie akzeptieren.

01curl -X POST https://secure.smslocal.com/api/service/enterprise-service/external/sms \02  -H "Token: $SMSLOCAL_TOKEN" \03  -H "Content-Type: application/json" \04  -d '{05    "from": "SMSLOCAL",06    "to": "14155550123",07    "content": "Your code is 481920."08  }'
201 · Akzeptiert

msgstr „9f2a7c10-4b2e-…“

Richtung „mt“

Fehlercode 0

Speichern Sie die msgstr – Auf diese Weise können Sie diese Nachricht von hier aus verfolgen.

Das Nachrichtenobjekt

Lesen Sie eine Nachricht von oben nach unten

Sende-, Status- und eingehende Ereignisse geben alle die gleiche Form zurück – lernen Sie es einmal.

01Nachrichten-ID

Nachrichten-ID

msgstr – wird in dem Moment erstellt, in dem eine Nachricht erstellt wird. Dies ist das Handle, mit dem Sie später den Status überprüfen können.

02Absender

Absender

von – eine Telefonnummer oder eine alphanumerische ID mit bis zu 11 Zeichen, je nachdem, welche Identität Ihre Empfänger sehen.

03Empfänger

Empfänger

an – die Nummer, an die die Nachricht geht, einschließlich Ländervorwahl.

04Codierung

Codierung

Datenkodierung – GSM7 fasst 160 Zeichen pro Teil; Wechseln Sie zu Unicode, und der Wert sinkt auf 70. Gehen Sie weiter, und es verkettet sich in zusätzlich berechnete Teile.

05Richtung

Richtung

Richtung – jede Nachricht hat die Form mt (Sie haben sie gesendet) oder mo (Sie haben sie erhalten), in beiden Fällen die gleiche Form.

06Fehlercode

Fehlercode

Fehlercode – wird bei der Sendeantwort und jedem Statusbericht zurückgegeben. 0 bedeutet akzeptiert; Alles andere sagt Ihnen genau, was schief gelaufen ist.

Referenz

Ein Endpunkt, zwei Verben

POST zum Senden, GET zum Überprüfen des Status – in beiden Fällen dieselbe URL und derselbe Token-Header.

POST

Schicken

Senden Sie eine Nachricht und erhalten Sie sofort eine Msgid und einen Fehlercode zurück.

Rückgaben msgid + Fehlercode
ERHALTEN

Schiene

Suchen Sie nach einer bereits gesendeten Nachricht, um deren aktuellen Status zu überprüfen.

Rückgaben Nachricht + Status
Webhooks

Statusberichte, sobald sie eintreten

Legen Sie eine Rückruf-URL fest und jede Zustellung, jeder Fehler und jede eingehende Antwort landet dort als GET oder POST – keine Abfrage erforderlich.

geliefertmsgstr 9f2a7c10 · Status geliefert
eingehendAntwort erhalten · Richtung Mo
fehlgeschlagenmsgstr 4c81e2 · Status fehlgeschlagen
Ihr Endpunkt200 OK
Legen Sie los

Holen Sie sich Ihren API-Schlüssel

Beginnen Sie in wenigen Minuten mit der Integration mit unserer REST-API.

Antworten auf Ihre Fragen

Entwicklerdokumente – häufig gestellte Fragen

Übergeben Sie Ihren Zugriffsschlüssel in einem Token-Header bei jeder Anfrage – Token: {accessKey} – zusammen mit Content-Type: application/json.

Jeder Versand gibt eine msgid zurück. Zeigen Sie uns auf eine Rückruf-URL und wir posten oder erhalten einen Statusbericht, sobald die Nachricht ihren endgültigen Status erreicht – Unterdatum, Fertigdatum und der resultierende Statuscode enthalten.

mt (mobile terminiert) ist eine von Ihnen gesendete Nachricht; mo (vom Mobilgerät stammend) ist eine Antwort, die Sie erhalten haben. Beide verwenden dieselbe Nachrichtenobjektform.

Die Zustellung wird gemäß der Wiederholungsrichtlinie wiederholt – nichts wird stillschweigend verworfen, aber ein Endpunkt, der nie bestätigt, erhält weiterhin Wiederholungsversuche.

160 Zeichen bei GSM7-Kodierung oder 70 bei Unicode. Wenn das Limit überschritten wird, wird die Nachricht in mehrere Teile verkettet, die jeweils separat abgerechnet werden.