REST API-dokumentasie
SMS- en MMS-REST-API's
Stuur goedgekeurde toepassingsboodskappe en hanteer aanvaarding, afleweringsgebeure, segmentering en kostes.
Kies die API en aanmeldbesonderhede saam
Goedgekeurde rekeninge vir Ontwikkelaar en Outomatisering, Besigheid en Kommunikasieverskaffers kan geaktiveerde dienste integreer. 'n Individuele ontwikkelaar hoef nie voor te gee om 'n maatskappy te wees nie. SMS/MMS vanaf toepassings vereis die toepaslike versendingsgoedkeuring en registrasie. Die diens vir Individue en gesinne het geen API wat kliënte kan gebruik om boodskappe te stuur nie.
| API-familie | Basis-URL | Stawing en resultaat |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Goedgekeurde Basic-aanmeldbesonderhede; toepaslike uitgereikte tokens slegs vir bewerkings wat dit ondersteun. JSON status en response. |
| Registrasie vir noodoproepe | https://api.multi.tel/emergency | Goedgekeurde Basic-aanmeldbesonderhede of spesifiek geaktiveerde bearer-toegang. JSON code, message en data. |
| Portaal-REST-integrasies | Gasheer en bewerking word in jou rekening se ontwikkelaarverwysing getoon | Gebruik daardie bewerking se gedokumenteerde aanmeldbesonderhede, toestemmingsomvang en skema. Blaaier-sessieversoeke gebruik 'n afsonderlike koppelvlak. |
Stel MULTITEL_API_USERNAME en MULTITEL_API_PASSWORD deur jou bediener se geheimekonfigurasie in voordat jy die voorbeelde gebruik. Moet dit nooit in openbare blaaier-JavaScript, URL's of bronbeheer inbed nie. Afsonderlike aanmeldbesonderhede word in API-integrasie-instellings bestuur.
Berei 'n SMS-versoek voor
Gebruik 'n goedgekeurde, SMS-geaktiveerde versendingsnommer wat aan die rekening behoort, 'n ontvanger wat tot die boodskap ingestem het, en die vereiste Brand/Campaign-registrasie of verifikasie van die tolvrye nommer. Die voorbeeld hieronder stuur 'n werklike boodskap wanneer werkende aanmeldbesonderhede en nommers ingevul word; dit is nie 'n sandbox nie.
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 die sender- en ontvangerplekhouers met internasionale telefoonnommers in syferformaat, insluitend die landkode. Vir 'n MMS, verskaf die ondersteunde openbaar opvraagbare media-URL in media en verifieer eers MMS-geskiktheid en -pryse.
Aanvaarding is nie aflewering nie
Inspekteer beide die buitenste toepassingstatus en die teruggegewe boodskapresultaat. Teken die boodskapidentifiseerder aan wat deur die diens verskaf is, en volg afleweringstatus en webhook-gebeure. 'n Suksesvolle indiening kan nie bewys dat die ontvanger se handstel die boodskap ontvang het nie.
SMS-fakturering is per segment. Enkodering en boodskaplengte kan verskeie segmente oplewer; media- en diensverskafferverwante koste kan van SMS verskil. Lees die rekening se huidige verkoopprys voordat jy stuur. Moet nooit 'n versending wat uitgetyd het blindelings weer probeer nie: inspekteer eers die aangetekende uitkoms daarvan.
Hanteer foute en herprobeerslae
- Stawing- of toestemmingsfout
- Kontroleer of die API-aanmeldbesonderhede geaktiveer is, watter diens toegelaat word en watter bron-IP-beperking geld. 'n Portaal-sessiekoekie is nie aanmeldbesonderhede vir 'n integrasie nie.
- Onvoldoende krediet of ontbrekende vereiste goedkeuring
- Los eers enige probleem met die rekeningsaldo, versendingsgoedkeuring of dokumentvereiste op voordat jy die bewerking herhaal.
- Geen resultaat nie
- Hanteer leë voorraad of 'n ontbrekende bellernaam as 'n gewone uitkoms. Moenie aanneem dat 'n sintakties geldige nommer elke diens het nie.
- Netwerktydverstreking of diensfout
- Gebruik 'n beperkte aantal herprobeerslae met wagtye tussen pogings vir leesbewerkings. Vir 'n aankoop, versending of registrasie, inspekteer eers die bewerkingstatus; om 'n aanvaarde versoek weer te probeer, kan 'n faktureerbare aksie dupliseer.
Ondersteuning vir idempotensie is spesifiek aan elke API-familie. Die Emergency-API ondersteun sleutels vir herprobeerslae; dit maak nie arbitrêre v3-versoeke idempotent nie. Behou tydstempels, teruggegewe ID's en response waarvan sensitiewe besonderhede verwyder is vir ondersteuning.
Gaan voort met jou rekening se verwysing
Die verwysingsdokumentasie wat jy ná aanmelding sien, filtreer bewerkings volgens jou toestemmings en geaktiveerde dienste. Gebruik die presiese gasheer, tipe aanmeldbesonderhede, versoekvelde en responsskema daarin. Die konsoles kan werklike bewerkings uitvoer, insluitend aankope en die stuur van boodskappe.