REST API-documentatie
REST-API’s voor telefoonnummers
Ontdek beschikbare landen en nummers, bekijk het volledige aanbod en beheer de nummers die u bezit.
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.
De beschikbare landencatalogus lezen
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getcountries"Het v3-antwoord bevat status en een response-array. Landvermeldingen bevatten isocode, name, countrycode, informatie over mogelijkheden en next_function. Beschikbaarheid is afhankelijk van account en voorraad; een land is geen belofte dat elk voorvoegsel of nummertype op voorraad is.
{
"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"
}
]
}Van ontdekken tot activeren
- Kies het land, waar vereist de onderverdeling, het gebied en het nummertype met behulp van de bijbehorende geografiebewerkingen.
- Lees de installatie-, maand- en gebruikstarieven, kanalen, inbegrepen gebruik en registratievereisten van het geselecteerde nummer.
- Dien de vereiste documenten van de eindgebruiker in en controleer hun status. Een nummer kan in behandeling blijven tot het is goedgekeurd.
- Bestel één keer met exact de gekozen voorraad en prijs. Controleer bij een onzeker antwoord eerst uw voorraad voordat u een nieuwe bestelling indient.
- Configureer spraakroutering en berichtbezorging afzonderlijk en test vervolgens de volledige beoogde route.
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.