REST API-dokumentation
REST API'er til SMS og MMS
Send godkendte applikationsbeskeder, og håndter accept, leveringshændelser, segmentering og gebyrer.
Vælg API og legitimation sammen
Godkendte konti med profilerne Udvikler og automatisering, Erhverv og Kommunikationsudbydere kan integrere aktiverede tjenester. En individuel udvikler behøver ikke give sig ud for at være en virksomhed. SMS/MMS fra applikationer kræver den relevante afsendelsesgodkendelse og registrering. Tjenesten for Privatpersoner og familier har ingen API tilgængelig for kunder til afsendelse af beskeder.
| API-familie | Basis-URL | Autentificering og resultat |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Godkendt Basic-legitimation; kvalificerede tildelte tokens kun til handlinger, der understøtter dem. JSON status og response. |
| Nødopkaldsregistrering | https://api.multi.tel/emergency | Godkendt Basic-legitimation eller specifikt tildelt bearer-adgang. JSON code, message og data. |
| Portal-REST-integrationer | Vært og handling vist i din kontos udviklerreference | Brug den pågældende handlings dokumenterede legitimation, scopes og skema. Anmodninger fra browsersessioner bruger en separat grænseflade. |
Angiv MULTITEL_API_USERNAME og MULTITEL_API_PASSWORD via din servers konfiguration af hemmeligheder, før du bruger eksemplerne. Indlejr dem aldrig i offentlig JavaScript i browseren, i URL’er eller i kildekodestyring. Dedikerede legitimationsoplysninger administreres i indstillinger for API-integration.
Forbered en SMS-anmodning
Brug et godkendt, SMS-aktiveret afsendernummer, som kontoen ejer, en modtager, der har givet samtykke til meddelelsen, og den krævede Brand/Campaign- eller gratisnummerverifikation. Eksemplet nedenfor sender en rigtig meddelelse, når det udfyldes med fungerende legitimationsoplysninger og numre; det er ikke en sandbox.
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"Erstat pladsholderne for afsender og modtager med telefonnumre i internationalt format med kun cifre, inklusive landekode. For en MMS skal du angive den understøttede, offentligt tilgængelige medie-URL i media og først kontrollere betingelserne og priserne for MMS.
Accept er ikke levering
Kontrollér både den ydre applikationsstatus og det returnerede meddelelsesresultat. Gem det meddelelses-id, som tjenesten leverer, og følg leveringsstatus og webhook-hændelser. En vellykket indsendelse beviser ikke, at modtagerens telefon har modtaget meddelelsen.
SMS faktureres pr. segment. Kodning og meddelelseslængde kan give flere segmenter; medie- og operatørrelaterede gebyrer kan afvige fra SMS. Læs kontoens aktuelle salgspris, før du sender. Gentag aldrig blindt en afsendelse, der fik timeout: kontrollér først dens registrerede udfald.
Håndtering af fejl og nye forsøg
- Fejl i autentificering eller tilladelser
- Kontrollér, om API-legitimationen er aktiveret, hvilken tjeneste den har tilladelse til, og hvilke begrænsninger der gælder for kilde-IP. En portalsessions-cookie er ikke en integrationslegitimation.
- Utilstrækkelig saldo eller manglende godkendelse
- Løs problemet med kontosaldoen, afsendelsesgodkendelsen eller dokumentkravet, før du gentager handlingen.
- Intet resultat
- Behandl et tomt lager eller et manglende opkaldsnavn som et almindeligt udfald. Antag ikke, at et syntaktisk gyldigt nummer har alle tjenester.
- Netværkstimeout eller tjenestefejl
- Brug begrænsede nye forsøg med backoff ved læsninger. Ved et køb, en afsendelse eller en registrering skal du først kontrollere handlingens tilstand; et nyt forsøg på en accepteret anmodning kan duplikere en handling, der medfører betaling.
Understøttelse af idempotens gælder for den enkelte API-familie. Emergency API’et understøtter nøgler til nye forsøg; det gør ikke vilkårlige v3-anmodninger idempotente. Gem tidsstempler, returnerede ID’er og svar, hvor følsomme oplysninger er fjernet, til support.
Fortsæt med din kontos reference
Den indloggede reference filtrerer operationer efter dine rettigheder og aktiverede tjenester. Brug dens præcise host, legitimationstype, forespørgselsfelter og svarskema. Konsollerne kan udføre live-operationer, herunder køb og beskeder.