Dokument

Skicka ditt första meddelande på en eftermiddag

Ett enkelt REST-API för att skicka, spåra och ta emot SMS — token-auth, realtidswebhooks och SDK:er, utan något exotiskt att lära sig.

Snabbstart

Tre drag, börjar levereras

Varje integration är samma korta båge – autentisera, skicka och spåra sedan.

01 · AutentiseraToken: sk_live_9f2a7c10Content-Type: application/json ✓

Skicka din åtkomstnyckel som ett Token-huvud, med Content-Type: application/json, på varje begäran.

02 · SkickaPOST /extern/sms{ msgstr: "9f2a7c10", felkod: 0 }

LÄGGA upp ett från, till och innehåll. Svaret kommer tillbaka med ett msgid och en felkod omedelbart.

03 · SpåraGET /report?status=Delivrd200 okej

Vi POST eller HEM en statusrapport till din återuppringnings-URL i samma ögonblick som ett meddelande når sitt slutliga tillstånd.

Skicka

En begäran, på det språk du redan använder

POSTA din avsändare, mottagare och innehåll med ett Token-huvud. Svaret kommer tillbaka när vi accepterar det.

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 · Godkänd

msgid "9f2a7c10-4b2e-..."

riktning "mt"

felkod 0

Spara msgid – det är hur du spårar det här meddelandet härifrån.

Meddelandeobjektet

Läs ett meddelande uppifrån och ned

Skicka, status och inkommande händelser returnerar alla samma form – lär dig det en gång.

01Meddelande-ID

Meddelande-ID

msgstr — skrivs i samma ögonblick som ett meddelande skapas. Detta är handtaget du använder för att kontrollera dess status senare.

02Avsändare

Avsändare

från — ett telefonnummer eller ett alfanumeriskt ID upp till 11 tecken, vilken identitet dina mottagare än ser.

03Mottagare

Mottagare

till — numret som meddelandet går till, inklusive landskod.

04Kodning

Kodning

datakodning — GSM7 rymmer 160 tecken per del; byta till Unicode och det sjunker till 70. Gå över, och det sammanfogas till extra fakturerade delar.

05Riktning

Riktning

riktning — varje meddelande är mt (du skickade det) eller mo (du fick det), samma form åt båda hållen.

06Felkod

Felkod

felkod — returneras på sändningssvaret och varje statusrapport. 0 betyder accepterad; allt annat säger dig exakt vad som gick fel.

Hänvisning

En slutpunkt, två verb

POST för att skicka, GET för att kontrollera status — samma URL och samma Token-rubrik oavsett.

POSTA

Skicka

Skicka ett meddelande och få tillbaka ett msgid och en felkod omedelbart.

Returnerar msgid + felkod

Spåra

Slå upp ett meddelande som du redan har skickat för att kontrollera dess aktuella status.

Returnerar meddelande + status
Webhooks

Statusrapporter, i det ögonblick de inträffar

Ange en återuppringnings-URL och varje leverans, misslyckande och inkommande svar hamnar där som en GET eller POST – ingen polling krävs.

levererasmsgstr 9f2a7c10 · status Delivrd
inkommandesvar mottaget · riktning mo
misslyckadesmsgstr 4c81e2 · status Misslyckades
Din slutpunkt200 okej
Kom igång

Få din API-nyckel

Börja integrera på några minuter med vårt REST API.

Svar på dina frågor

Utvecklardokument – ​​vanliga frågor

Skicka din åtkomstnyckel i ett Token-huvud på varje begäran — Token: {accessKey} — tillsammans med Content-Type: application/json.

Varje sändning returnerar ett msgid. Rikta oss på en återuppringnings-URL och vi POSTAR eller HÄMTAR en statusrapport till den så fort meddelandet når sitt slutliga tillstånd - underdatum, färdigdatum och den resulterande statuskoden ingår.

mt (mobil terminated) är ett meddelande du skickat; mo (mobil ursprung) är ett svar du fått. Båda använder samma meddelandeobjektform.

Leveransen görs om enligt policyn om försök igen – ingenting släpps tyst, men en slutpunkt som aldrig erkänner kommer att fortsätta att ta emot återförsök.

160 tecken på GSM7-kodning, eller 70 på Unicode. Gå förbi gränsen och meddelandet sammanfogas i flera delar, var och en faktureras separat.