REST API-documentatie
Doe uw eerste MultiTEL API-aanvraag
Begin met een alleen-lezen aanvraag, begrijp de respons en kies daarna de referentie voor de dienst die u wilt bouwen.
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.
Eerste verzoek: uw saldo opvragen
Deze leesopdracht koopt geen dienst en initieert geen gesprek of bericht.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"De communications v3 API geeft een applicatieresultaat terug in de JSON-body. Controleer de HTTP-status en status.code voordat u response leest; een afgewezen verzoek heeft mogelijk geen response-object. Codewaarden kunnen strings of getallen zijn.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}Dit is een fictief voorbeeld, geen accountsaldo. Behandel geldbedragen als decimale bedragen. Bewaar het responsebericht van de server bij het analyseren van een afgewezen verzoek, met verwijderde inloggegevens.
Factureringsgegevens correct gebruiken
Het saldoantwoord bevat het actuele saldo, de valuta en de betalingsvoorwaarden. Het geeft niet de kosten van een toekomstig gesprek of een volledige factuur. Gebruik voor die vragen de bijbehorende tarief- en gebruiksbewerkingen. Bestaande nummers kunnen andere abonnementen hebben dan de huidige catalogus.
Kies uw volgende integratie
LRN-routeringsopzoek-REST-API
Zoek tegen een vaste prijs het routeringsnummer en de beschikbare carrierinformatie op voor een Noord-Amerikaans telefoonnummer.
Lees de integratiegids →REST-API’s voor telefoonnummers
Ontdek beschikbare landen en nummers, bekijk het volledige aanbod en beheer de nummers die u bezit.
Lees de integratiegids →REST-API’s voor SMS en MMS
Verstuur goedgekeurde applicatieberichten en verwerk acceptatie, afleveringsgebeurtenissen, segmentering en kosten.
Lees de integratiegids →REST-API’s voor noodoproepen
Registreer een nummer en dienstadres, volg de activeringsstatus en houd het record bij wanneer de locatie verandert.
Lees de integratiegids →REST-API’s voor account en facturatie
Lees het saldo en de factureringsgegevens die beschikbaar zijn voor uw goedgekeurde integratie.
Lees de integratiegids →CNAM- en routeringsopzoekingen
Lees bellernamen uit, begrijp de opzoekniveaus en gebruik informatie over nummerroutering.
CNAM REST-referentie →Hosted PBX
Begin met de beschikbare serviceplannen en de tenant die u wilt configureren.
Hosted PBX service-plan-API →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.