REST API-dokumentation
REST API:er för SMS och MMS
Skicka godkända applikationsmeddelanden och hantera acceptans, leveranshändelser, segmentering och avgifter.
Välj API och autentiseringsuppgift tillsammans
Godkända konton av typen Utvecklare & Automation, Företag och Kommunikationsleverantörer kan integrera aktiverade tjänster. En enskild utvecklare behöver inte utge sig för att vara ett företag. SMS/MMS för applikationer kräver tillämpligt sändningsgodkännande och tillämplig registrering. Tjänsten Privat & Familj har inget kundtillgängligt API för att initiera meddelandesändning.
| API-familj | Bas-URL | Autentisering och resultat |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Godkända Basic-autentiseringsuppgifter; berättigade provisionerade token endast för åtgärder som stöder dem. JSON status och response. |
| Nödsamtalsregistrering | https://api.multi.tel/emergency | Godkända Basic-autentiseringsuppgifter eller specifikt provisionerad bearer-åtkomst. JSON code, message och data. |
| Portal-REST-integrationer | Värd och åtgärd visas i ditt kontos utvecklarreferens | Använd åtgärdens dokumenterade autentiseringsuppgift, behörighetsomfattning och schema. Begäranden från webbläsarsessioner använder ett separat gränssnitt. |
Ange MULTITEL_API_USERNAME och MULTITEL_API_PASSWORD via din servers konfiguration för hemligheter innan du använder exemplen. Bädda aldrig in dem i offentlig webbläsar-JavaScript, URL:er eller källkodshantering. Dedikerade autentiseringsuppgifter hanteras i inställningarna för API-integration.
Förbered en SMS-begäran
Använd ett godkänt, SMS-aktiverat sändningsnummer som ägs av kontot och en mottagare som har samtyckt till meddelandet. Slutför nödvändig Brand/Campaign-registrering eller verifiering av numret som är avgiftsfritt för den som ringer. Exemplet nedan skickar ett verkligt meddelande när det fylls i med fungerande autentiseringsuppgifter och nummer; det är ingen sandlåda.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
--request POST \
--header "Content-Type: application/json" \
--data '{"from":"YOUR_APPROVED_NUMBER","to":"YOUR_CONSENTED_RECIPIENT","text":"Your requested update is ready."}' \
"https://api.multitel.net/v3/sendsms"Ersätt platshållarna för avsändare och mottagare med telefonnummer i internationellt format, med endast siffror och inklusive landskod. För MMS ska du ange den stödda, offentligt hämtbara media-URL:en i media och först verifiera MMS-behörighet och prissättning.
Acceptans är inte leverans
Granska både den yttre applikationsstatusen och det returnerade meddelanderesultatet. Anteckna den meddelandeidentifierare som tjänsten tillhandahåller och följ leveransstatus och webhook-händelser. En lyckad inlämning bevisar inte att mottagarens telefon tog emot meddelandet.
SMS-debitering sker per segment. Kodning och meddelandelängd kan ge flera segment; media- och operatörsrelaterade avgifter kan skilja sig från SMS. Läs kontots aktuella försäljningspris innan du skickar. Gör aldrig ett blint återförsök av en sändning med tidsgränsöverskridning: granska först dess registrerade utfall.
Hantera fel och återförsök
- Autentiserings- eller behörighetsfel
- Kontrollera API-autentiseringsuppgiftens aktiveringsstatus, tillåtna tjänst och käll-IP-begränsning. En portalsessionskaka är inte en integrationsautentiseringsuppgift.
- Otillräckligt saldo eller saknat godkännande
- Åtgärda kontosaldot, sändningsgodkännandet eller dokumentkravet innan du upprepar åtgärden.
- Inget resultat
- Hantera tomt lager eller ett saknat uppringarnamn som ett normalt utfall. Anta inte att ett syntaktiskt giltigt nummer har alla tjänster.
- Nätverkstimeout eller tjänstefel
- Använd begränsade återförsök med backoff för läsningar. Vid köp, sändning eller registrering ska du först granska åtgärdens tillstånd; ett återförsök av en accepterad begäran kan duplicera en debiterbar åtgärd.
Idempotensstöd tillhör varje API-familj. Emergency API stöder återförsöksnycklar; det gör inte godtyckliga v3-begäranden idempotenta. Behåll tidsstämplar, returnerade ID:n och maskade svar för supporten.
Fortsätt med ditt kontos referens
Den inloggade referensen filtrerar operationer utifrån dina behörigheter och aktiverade tjänster. Använd dess exakta värd, typ av autentiseringsuppgift, förfrågningsfält och svarsschema. Konsolerna kan utföra skarpa operationer, inklusive köp och meddelanden.