REST API-documentatie
REST-API’s voor SMS en MMS
Verstuur goedgekeurde applicatieberichten en verwerk acceptatie, afleveringsgebeurtenissen, segmentering en kosten.
Kies de API en de inloggegevens samen
Goedgekeurde accounts met het profiel Ontwikkelaars en automatisering, Zakelijk of Communicatieaanbieders kunnen ingeschakelde diensten integreren. Een individuele ontwikkelaar hoeft zich niet als bedrijf voor te doen. Applicatie-SMS/MMS vereist de toepasselijke verzendgoedkeuring en registratie. De dienst voor Particulieren en gezinnen heeft geen voor klanten toegankelijke API voor het verzenden van berichten.
| API-familie | Basis-URL | Authenticatie en resultaat |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Goedgekeurde Basic-inloggegevens; in aanmerking komende geprovisioneerde tokens alleen voor bewerkingen die deze ondersteunen. JSON status en response. |
| Noodregistratie | https://api.multi.tel/emergency | Goedgekeurde Basic-inloggegevens of specifiek geprovisioneerde bearer-toegang. JSON code, message en data. |
| REST-integraties van de portal | Host en bewerking zoals getoond in de ontwikkelaarsreferentie van uw account | Gebruik de gedocumenteerde inloggegevens, scopes en het schema van die bewerking. Verzoeken vanuit een browsersessie vormen een afzonderlijke interface. |
Stel MULTITEL_API_USERNAME en MULTITEL_API_PASSWORD in via de geheime configuratie van uw server voordat u de voorbeelden gebruikt. Sluit ze nooit in in openbaar browser-JavaScript, URL’s of broncodebeheer. Specifieke inloggegevens beheert u in de instellingen voor API-integratie.
Een SMS-verzoek voorbereiden
Gebruik een goedgekeurd, SMS-geschikt verzendnummer dat eigendom is van het account, een ontvanger die met het bericht heeft ingestemd en de vereiste Brand/Campaign- of toll-free-verificatie. Het onderstaande voorbeeld verstuurt een echt bericht wanneer het wordt ingevuld met werkende inloggegevens en nummers; het is geen 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"Vervang de plaatsaanduidingen voor afzender en ontvanger door telefoonnummers in internationaal formaat, met alleen cijfers en inclusief de landcode. Geef voor een MMS de ondersteunde, openbaar op te halen media-URL op in media en controleer eerst de voorwaarden en prijzen voor MMS.
Acceptatie is geen bezorging
Controleer zowel de buitenste applicatiestatus als het geretourneerde berichtresultaat. Registreer de berichtidentificatie die de dienst levert en volg de bezorgstatus en webhook-gebeurtenissen. Een geslaagde indiening is geen bewijs dat het toestel van de ontvanger het bericht heeft ontvangen.
SMS wordt per segment gefactureerd. Codering en berichtlengte kunnen meerdere segmenten opleveren; media en providergerelateerde kosten kunnen van SMS verschillen. Lees de actuele verkoopprijs van het account voordat u verzendt. Probeer een verzending met time-out nooit blindelings opnieuw: controleer eerst de vastgelegde uitkomst.
Fouten en nieuwe pogingen afhandelen
- Fout in authenticatie of machtiging
- Controleer of de API-inloggegevens zijn ingeschakeld, welke dienst is toegestaan en welke beperking voor het bron-IP-adres geldt. Een sessiecookie van het portaal is geen inloggegeven voor integratie.
- Onvoldoende tegoed of niet voldaan aan goedkeuring
- Los het accountsaldo, de verzendgoedkeuring of de documentvereiste op voordat u de handeling herhaalt.
- Geen resultaat
- Behandel een lege voorraad of een ontbrekende naam van de beller als een gewone uitkomst. Ga er niet van uit dat een syntactisch geldig nummer alle diensten heeft.
- Netwerktime-out of storing van de dienst
- Gebruik begrensde nieuwe pogingen met backoff voor leesopdrachten. Controleer bij een aankoop, verzending of registratie eerst de status van de bewerking; een geaccepteerd verzoek opnieuw proberen kan een factureerbare handeling dupliceren.
Ondersteuning voor idempotentie verschilt per API-familie. De Emergency API ondersteunt sleutels voor herhaalde pogingen; dat maakt willekeurige v3-verzoeken niet idempotent. Bewaar tijdstempels, geretourneerde ID’s en antwoorden waaruit gevoelige gegevens zijn verwijderd voor ondersteuning.
Ga verder met de referentie van uw account
De referentie voor ingelogde gebruikers filtert bewerkingen op basis van uw rechten en ingeschakelde diensten. Gebruik de exacte host, het credentialtype, de aanvraagvelden en het responsschema die daarin staan. De consoles kunnen live bewerkingen uitvoeren, waaronder aankopen en berichten.