REST API-dokumentasjon

REST API-er for telefonnumre

Finn tilgjengelige land og numre, se hele tilbudet og administrer numrene du eier.

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-familieBasis-URLAutentisering og resultat
Communications v3https://api.multitel.net/v3Godkjente Basic-legitimasjoner; kvalifiserte, klargjorte tokener bare for operasjoner som støtter dem. JSON status og response.
Registrering for nødanrophttps://api.multi.tel/emergencyGodkjente Basic-legitimasjoner eller spesifikt klargjort bearer-tilgang. JSON code, message og data.
Portal REST-integrasjonerVert og operasjon vises i kontoens utviklerreferanseBruk 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.

Les den tilgjengelige landkatalogen

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multitel.net/v3/getcountries"

v3-responsen inneholder status og en response-matrise. Landeoppføringer inkluderer isocode, name, countrycode, funksjonsinformasjon og next_function. Tilgjengelighet avhenger av konto og lager; et land er ingen garanti for at alle prefikser eller nummertyper er på 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"
    }
  ]
}

Fra oppdagelse til aktivering

  1. Velg land, underinndeling der det kreves, område og nummertype ved hjelp av de tilhørende geografioperasjonene.
  2. Les det valgte nummerets etablerings-, måneds- og brukspriser, kanaler, kvote og registreringskrav.
  3. Send inn de nødvendige sluttbrukerdokumentene og gjennomgå statusen deres. Et nummer kan forbli ventende til godkjenning.
  4. Bestill én gang med nøyaktig lager-/prisvalg. Hvis responsen er usikker, må du undersøke lageret ditt før du sender inn en ny bestilling.
  5. Konfigurer taleruting og meldingslevering uavhengig av hverandre, og test deretter hele den tiltenkte ruten.

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.