Documenten

Verzend uw eerste bericht op een middag

Een eenvoudige REST API voor het verzenden, volgen en ontvangen van sms-berichten: tokenauthenticatie, realtime webhooks en SDK's, zonder iets exotisch te leren.

Snelstart

Drie zetten, begin met leveren

Elke integratie is hetzelfde korte traject: authenticeren, verzenden en vervolgens volgen.

01 · AuthenticerenToken: sk_live_9f2a7c10Inhoudstype: application/json ✓

Stuur uw toegangssleutel bij elk verzoek als een Token-header, met Content-Type: application/json.

02 · VersturenPOST /extern/sms{ msgid: "9f2a7c10", foutcode: 0 }

POST een van, naar en inhoud. Het antwoord komt onmiddellijk terug met een msgid en een foutcode.

03 · SpoorGET /report?status=Bezorgd200 Oké

We POST of ONTVANGEN een statusrapport op uw callback-URL zodra een bericht de definitieve status bereikt.

Versturen

Eén verzoek, in de taal die u al gebruikt

POST uw afzender, ontvanger en inhoud met een Token-header. Het antwoord komt terug op het moment dat we het accepteren.

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 · Geaccepteerd

msgstr "9f2a7c10-4b2e-…"

richting "mt"

foutcode 0

Bewaar de msgstr – het is hoe je dit bericht vanaf hier kunt volgen.

Het berichtobject

Lees een bericht van boven naar beneden

Verzend-, status- en inkomende gebeurtenissen retourneren allemaal dezelfde vorm: leer het één keer.

01Bericht-ID

Bericht-ID

msgid — wordt aangemaakt op het moment dat een bericht wordt aangemaakt. Dit is het handvat dat u gebruikt om later de status ervan te controleren.

02Afzender

Afzender

van: een telefoonnummer of een alfanumerieke ID van maximaal 11 tekens, ongeacht de identiteit die uw ontvangers zien.

03Ontvanger

Ontvanger

naar — het nummer waar het bericht naartoe gaat, inclusief landcode.

04Codering

Codering

datacodering — GSM7 past 160 tekens per onderdeel; schakel over naar Unicode en dat daalt naar 70. Ga erheen en het wordt samengevoegd in extra gefactureerde delen.

05Richting

Richting

richting — elk bericht is mt (je hebt het verzonden) of mo (je hebt het ontvangen), hoe dan ook dezelfde vorm.

06Foutcode

Foutcode

foutcode — geretourneerd bij het verzendantwoord en bij elk statusrapport. 0 betekent geaccepteerd; al het andere vertelt u precies wat er mis is gegaan.

Referentie

Eén eindpunt, twee werkwoorden

POST om te verzenden, GET om de status te controleren – hoe dan ook dezelfde URL en dezelfde Token-header.

NA

Versturen

Stuur een bericht en ontvang onmiddellijk een msgid en een foutcode.

Retouren msgid + foutcode
KRIJGEN

Spoor

Zoek een bericht op dat u al hebt verzonden om de huidige status ervan te controleren.

Retouren bericht + status
Webhaken

Statusrapporten, op het moment dat ze plaatsvinden

Stel een terugbel-URL in en elke bezorging, mislukking en binnenkomend antwoord komt daar terecht als een GET of POST - geen polling vereist.

afgeleverdmsgstr 9f2a7c10 · status Bezorgd
inkomendantwoord ontvangen · richting ma
misluktmsgstr 4c81e2 · status Mislukt
Uw eindpunt200 Oké
Aan de slag

Haal uw API-sleutel op

Begin binnen enkele minuten met integreren met onze REST API.

Antwoorden op uw vragen

Documenten voor ontwikkelaars: veelgestelde vragen

Geef uw toegangssleutel bij elk verzoek door in een Token-header (Token: {accessKey}), samen met Content-Type: application/json.

Elke verzending retourneert een msgid. Wijs ons op een callback-URL en wij POST of ONTVANGEN er een statusrapport op zodra het bericht zijn definitieve status bereikt - subdatum, donedate en de resulterende statuscode inbegrepen.

mt (mobiel beëindigd) is een bericht dat u hebt verzonden; mo (mobiel afkomstig) is een antwoord dat u heeft ontvangen. Beide gebruiken dezelfde berichtobjectvorm.

De levering wordt opnieuw geprobeerd volgens het beleid voor opnieuw proberen. Er wordt niets stilzwijgend verwijderd, maar een eindpunt dat nooit bevestigt, blijft nieuwe pogingen ontvangen.

160 tekens bij GSM7-codering, of 70 bij Unicode. Ga voorbij de limiet en het bericht wordt samengevoegd in meerdere delen, die elk afzonderlijk worden gefactureerd.