REST API-dokumentation
REST API:er för telefonnummer
Upptäck tillgängliga länder och nummer, granska hela erbjudandet och hantera de nummer du äger.
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.
Läs den tillgängliga landskatalogen
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getcountries"v3-svaret innehåller status och en response-array. Landsposter innehåller isocode, name, countrycode, kapabilitetsinformation och next_function. Tillgänglighet beror på konto och lager; ett land är ingen garanti för att varje prefix eller nummertyp finns i lager.
{
"status": {
"code": 200,
"msg": "Results: 1"
},
"response": [
{
"countrycode": "1",
"name": "United States",
"description": "United States",
"isocode": "US",
"is_mobile": 0,
"sms_coverage": 1,
"latitude": "37.0902",
"longitude": "-95.7129",
"next_function": "v3/getareas/US"
}
]
}Från upptäckt till aktivering
- Välj land, administrativ indelning där det krävs, område och nummertyp med hjälp av motsvarande geografiska åtgärder.
- Läs det valda numrets installations-, månads- och användningspriser, kanaler, inkluderad mängd och registreringskrav.
- Skicka in de slutanvändardokument som krävs och granska deras status. Ett nummer kan förbli väntande tills det godkänns.
- Beställ en gång med exakt lager-/prisval. Om svaret är osäkert ska du granska ditt lager innan du skickar en ny beställning.
- Konfigurera röstrouting och meddelandeleverans oberoende av varandra och testa sedan hela den avsedda rutten.
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.