REST API-dokumentation
Gör din första API-förfrågan till MultiTEL
Börja med en förfrågan som endast läser data, förstå svaret och välj sedan referensen för den tjänst du vill bygga.
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örsta begäran: läs av ditt saldo
Denna läsning köper ingen tjänst och initierar varken samtal eller meddelande.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"Kommunikations-API:et v3 returnerar ett applikationsresultat inuti JSON-svaret. Kontrollera HTTP-statusen och status.code innan du läser response; en avvisad begäran kan sakna svarsobjekt. Kodvärden kan vara strängar eller tal.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}Detta är ett fiktivt exempel, inte ett kontosaldo. Behandla penningvärden som decimalbelopp. Behåll serverns svarsmeddelande vid felsökning av en avvisad begäran, med autentiseringsuppgifter borttagna.
Använd debiteringsdata korrekt
Saldosvaret innehåller aktuellt saldo, valuta och betalningsvillkor. Det anger inte kostnaden för ett framtida samtal eller en fullständig faktura. Använd matchande taxa- och användningsåtgärder för dessa frågor. Befintliga nummer kan ha andra planer än dagens katalog.
Välj din nästa integration
REST API för LRN-routingsökning
Slå upp routingnumret och tillgänglig operatörsinformation för ett nordamerikanskt telefonnummer till ett fast pris.
Läs integrationsguiden →REST API:er för telefonnummer
Upptäck tillgängliga länder och nummer, granska hela erbjudandet och hantera de nummer du äger.
Läs integrationsguiden →REST API:er för SMS och MMS
Skicka godkända applikationsmeddelanden och hantera acceptans, leveranshändelser, segmentering och avgifter.
Läs integrationsguiden →REST API:er för nödsamtal
Registrera ett nummer och en tjänsteadress, följ aktiveringsstatusen och håll posten uppdaterad när platsen ändras.
Läs integrationsguiden →REST API:er för konto och fakturering
Läs saldot och den faktureringsinformation som är tillgänglig för din godkända integration.
Läs integrationsguiden →CNAM- och routingsökningar
Läs uppringarnamn, förstå sökningsnivåerna och använd information om nummerroutning.
CNAM REST-referens →Hosted PBX
Börja med tillgängliga serviceplaner och den tenant du tänker konfigurera.
API för Hosted PBX-serviceplaner →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.