Utviklere

GET/v3/get_document_number_types/{country}

List opp nummertyper for registrering

Finn navnene på nummertypene som for øyeblikket finnes i registreringskatalogen for et land.

På denne siden
  1. Velg en type ut fra navnet som returneres
  2. Antall grupper angir ikke nummerbeholdningen
  3. Forespørsel
  4. Svar
  5. Feil
  6. Tilgjengelighet og sideeffekter

Velg en type ut fra navnet som returneres

Bruk et land fra get_document_countries. Send det returnerte typenavnet til get_requirements. En ID for en type i katalogen er ikke en prefiks-ID, nummer-ID eller ID for en dokumentasjonskategori.

Antall grupper angir ikke nummerbeholdningen

available_groups teller gruppeoppføringene som returneres av dette katalogoppslaget. Det teller ikke telefonnumre som kan kjøpes, reserverer ikke numre fra beholdningen og garanterer ikke at katalogen har hentet alle sider fra den overliggende datakilden. Søk i den aktuelle nummerbeholdningen og vurder et pristilbud separat.

Forespørsel

Bruk påloggingsopplysningene for den aktiverte API-kontoen din over HTTPS. Autentisering med Basic og aktiverte bearer-tokener for API-kontoen støttes; kontoens begrensninger gjelder.

GET med eventuelle dokumenterte parametere i URL-stien.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_document_number_types/$COUNTRY_ISO"
Stiparametere
NavnTypeObligatoriskBeskrivelse
countrystringJaISO-landkode på to bokstaver fra katalogen over registreringsland. Innledende og avsluttende blanktegn fjernes, og bokstavene konverteres til store bokstaver.

Svar

Kontroller status.code i JSON-innholdet i tillegg til HTTP-statusen. response er en liste som inneholder id, name og available_groups. Bruk name som number_type når du kaller get_requirements; ikke send id i stedet. available_groups er antallet gruppeoppføringer som returneres for den typen, ikke antallet telefonnumre i beholdningen eller et fullstendig totaltall på tvers av alle sider. Typer uten returnerte grupper utelates. Den foretrukne rekkefølgen er Local, Mobile, National, Toll Free, Shared Cost, Global, etterfulgt av andre navn fra katalogen.

Eksempel på svarstruktur; ikke faktiske kontodata eller et gjeldende pristilbud.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "NUMBER_TYPE_ID_FROM_RESPONSE",
      "name": "Local",
      "available_groups": 3
    }
  ]
}

Feil

  • 400: country is required: oppgi ISO-koden for registreringslandet.
  • 400: Invalid country ISO or no available DID registration country found: velg et land fra den gjeldende registreringskatalogen; dette fastslår ikke at det ikke kreves dokumenter.

Tilgjengelighet og sideeffekter

  • Dette oppslaget i katalogen eller kravene oppretter ikke en identitet, laster ikke opp dokumentasjon, registrerer ikke et nummer og legger ikke inn en bestilling.
  • Et vellykket katalogsvar innebærer ikke at dokumentene dine er godkjent, eller at det er bekreftet at et valgt nummer kan aktiveres.