REST API-dokumentasie
Maak jou eerste MultiTEL-API-versoek
Begin met 'n leesalleen-versoek, verstaan die antwoord en kies dan die verwysing vir die diens wat jy wil bou.
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.
Eerste versoek: lees jou saldo
Hierdie leesaksie koop nie 'n diens nie en laat nie 'n oproep of boodskap ontstaan nie.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"Die kommunikasie-v3-API gee 'n toepassingresultaat binne die JSON-liggaam terug. Kontroleer die HTTP-status en status.code voordat jy response lees; 'n verwerpte versoek het dalk geen responsobjek nie. Kodewaardes kan stringe of nommers wees.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}Dit is 'n fiktiewe voorbeeld, nie 'n rekeningsaldo nie. Behandel monetêre waardes as desimale bedrae. Behou die bediener se responsboodskap wanneer jy 'n verwerpte versoek diagnoseer, maar verwyder die aanmeldbesonderhede.
Gebruik faktuurdata korrek
Die saldorespons bevat die huidige saldo, geldeenheid en betalingsterme. Dit gee nie die koste van 'n toekomstige oproep of 'n volledige faktuur nie. Gebruik die ooreenstemmende tarief- en gebruikbewerkings vir daardie vrae. Bestaande nommers kan verskillende planne van vandag se katalogus hê.
Kies jou volgende integrasie
LRN-roeteringsopsoek-REST-API
Soek die roeteringsnommer en beskikbare diensverskafferinligting vir 'n Noord-Amerikaanse telefoonnommer teen 'n vaste prys per opsoek op.
Lees die integrasiegids →Foonnommer-REST-API's
Ontdek beskikbare lande en nommers, ondersoek die volledige aanbod en bestuur die nommers wat jy besit.
Lees die integrasiegids →SMS- en MMS-REST-API's
Stuur goedgekeurde toepassingsboodskappe en hanteer aanvaarding, afleweringsgebeure, segmentering en kostes.
Lees die integrasiegids →Noodoproep-REST-API's
Registreer 'n nommer en diensadres, volg die aktiveringstatus daarvan en hou die rekord by namate die ligging verander.
Lees die integrasiegids →Rekening- en fakturering-REST-API's
Lees die saldo en faktureringsinligting wat vir jou goedgekeurde integrasie beskikbaar is.
Lees die integrasiegids →CNAM- en roeteringsopsoeke
Lees bellername, verstaan opsoekvlakke en gebruik nommerroeteringinligting.
CNAM REST-verwysing →Gehoste PBX
Begin met die beskikbare diensplanne en die kliëntomgewing (tenant) wat jy wil opstel.
Gehoste PBX-diensplan-API →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.