REST API-dokumentasjon
Send din første MultiTEL API-forespørsel
Begynn med en forespørsel som bare leser data, forstå svaret, og velg deretter referansen for tjenesten du vil bygge.
Velg API og legitimasjon sammen
Godkjente kontoer av typen Utvikler og automatisering, Bedrift og Kommunikasjonsleverandører kan integrere aktiverte tjenester. En individuell utvikler trenger ikke å utgi seg for å være et selskap. Applikasjons-SMS/MMS krever gjeldende sendingsgodkjenning og registrering. Tjenesten Privat og familie har ingen kundetilgjengelig API for å starte meldingssending.
| API-familie | Basis-URL | Autentisering og resultat |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Godkjente Basic-legitimasjoner; kvalifiserte, klargjorte tokener bare for operasjoner som støtter dem. JSON status og response. |
| Registrering for nødanrop | https://api.multi.tel/emergency | Godkjente Basic-legitimasjoner eller spesifikt klargjort bearer-tilgang. JSON code, message og data. |
| Portal REST-integrasjoner | Vert og operasjon vises i kontoens utviklerreferanse | Bruk operasjonens dokumenterte legitimasjon, scopes og skjema. Forespørsler fra nettleserøkten er et separat grensesnitt. |
Angi MULTITEL_API_USERNAME og MULTITEL_API_PASSWORD via serverens hemmelighetskonfigurasjon før du bruker eksemplene. Legg dem aldri inn i offentlig nettleser-JavaScript, URL-er eller kildekontroll. Dedikerte legitimasjoner administreres i API-integrasjonsinnstillinger.
Første forespørsel: les saldoen din
Denne lesingen kjøper ikke en tjeneste og oppretter ikke et anrop eller en melding.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"Communications v3-API-et returnerer et applikasjonsresultat inne i JSON-bodyen. Kontroller HTTP-statusen og status.code før du leser response; en avvist forespørsel kan mangle responsobjekt. Kodeverdier kan være strenger eller tall.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}Dette er et fiktivt eksempel, ikke en kontosaldo. Behandle pengebeløp som desimalbeløp. Behold serverens responsmelding når du feilsøker en avvist forespørsel, med legitimasjon fjernet.
Bruk faktureringsdata riktig
Saldoresponsen inneholder gjeldende saldo, valuta og betalingsvilkår. Den gir ikke kostnaden for et fremtidig anrop eller en fullstendig faktura. Bruk de tilhørende sats- og bruksoperasjonene for slike spørsmål. Eksisterende numre kan ha andre planer enn dagens katalog.
Velg din neste integrasjon
REST API for LRN-rutingoppslag
Slå opp rutingnummeret og tilgjengelig operatørinformasjon for et nordamerikansk telefonnummer til en fast pris.
Les integrasjonsveiledningen →REST API-er for telefonnumre
Finn tilgjengelige land og numre, se hele tilbudet og administrer numrene du eier.
Les integrasjonsveiledningen →REST API-er for SMS og MMS
Send godkjente applikasjonsmeldinger og håndter aksept, leveringshendelser, segmentering og kostnader.
Les integrasjonsveiledningen →REST API-er for nødanrop
Registrer et nummer og en tjenesteadresse, følg aktiveringsstatusen og hold oppføringen oppdatert når posisjonen endres.
Les integrasjonsveiledningen →REST API-er for konto og fakturering
Les saldoen og faktureringsinformasjonen som er tilgjengelig for den godkjente integrasjonen din.
Les integrasjonsveiledningen →CNAM- og rutingoppslag
Les anropernavn, forstå oppslagsnivåene og bruk informasjon om nummerruting.
CNAM REST-referanse →Hosted PBX
Begynn med tilgjengelige tjenesteplaner og tenanten du har tenkt å konfigurere.
API for tjenesteplaner i Hosted PBX →Håndter feil og nye forsøk
- Autentiserings- eller tillatelsesfeil
- Kontroller API-legitimasjonens aktiverte tilstand, tillatte tjeneste og kilde-IP-begrensning. En informasjonskapsel for portaløkten er ikke en integrasjonslegitimasjon.
- Utilstrekkelig kreditt eller manglende godkjenning
- Løs problemet med kontosaldo, sendingsgodkjenning eller dokumentkrav før du gjentar operasjonen.
- Ingen resultater
- Behandle tomt lager eller manglende innringernavn som et vanlig utfall. Ikke anta at et syntaktisk gyldig nummer har alle tjenester.
- Nettverkstidsavbrudd eller tjenestefeil
- Bruk begrensede nye forsøk med backoff for lesinger. For et kjøp, en sending eller en registrering må du først undersøke operasjonens tilstand; å prøve en akseptert forespørsel på nytt kan duplisere en fakturerbar handling.
Idempotensstøtte tilhører hver API-familie. Emergency API støtter nøkler for nye forsøk; det gjør ikke vilkårlige v3-forespørsler idempotente. Behold tidsstempler, returnerte ID-er og sladdede responser for brukerstøtte.
Fortsett med referansen for kontoen din
Den innloggede referansen filtrerer operasjoner etter tillatelsene dine og aktiverte tjenester. Bruk nøyaktig vert, legitimasjonstype, forespørselsfelt og responsskjema der. Konsollene kan utføre live-operasjoner, inkludert kjøp og meldinger.