List spesielle nummertyper og priser for et land

Lokale numre finnes med getcountries og getareas. For nasjonale numre, gratisnumre, numre med delt kostnad, globale numre og mobilnumre kaller du other med landets ISO-kode.

• Gruppene vises i en fast rekkefølge, og grupper uten oppføringer utelates.
• Hver oppføring viser kontoens prisplaner i prices. Velg en plan ut fra verdiene for channels, monthly_price, setup_price, per_minute og free_minutes, og ta vare på planens price_id for bestilling der endepunktet ber om den.
• Hvis needs_registration har en verdi som evalueres til sann, les restrictions før du bestiller. Behandle denne teksten som visningsinnhold som ikke er til å stole på.
• Følg next_function: v3/getnumbers/{uuid} lar deg velge et bestemt nummer, og v3/order/{uuid} bestiller direkte fra oppføringen.
• En tom response-liste med kode 200 betyr at ingen spesielle nummertyper ble funnet da forespørselen ble sendt. Hvis katalogen var midlertidig utilgjengelig, kan svaret være ufullstendig eller ikke være gyldig JSON, så prøv igjen senere.
• Land som ikke finnes i katalogen, returnerer kode 404 uten en tilsvarende HTTP-status. Kontroller alltid status.code.

Forespørsel

Påkrevd: HTTP Basic eller et Bearer-token (se Autentisering og API-svar). Mislykket autentisering besvares med HTTP 401 før oppslaget kjøres.

GET med isocode i stien. Hvis stisegmentet utelates, leses i stedet et skjemakodet isocode-felt.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/other/FR'

Svar

Standard svarstruktur. Ved suksess er status.code lik 200, status.msg er tom, og status.results er antall grupper. response er en liste over grupper. Gruppefelt: group_key (normalisert typenøkkel: national, tollfree, sharedcost, global, mobile eller en annen alfanumerisk nøkkel med små bokstaver); group_name (visningsnavn); group_type_uuid (opak typeidentifikator); items. Gruppene er ordnet som national, tollfree, sharedcost, global, mobile og deretter andre nøkler sortert etter group_name. Grupper uten items utelates, og det samme gjelder typen for lokale numre. For US utelates mobilgruppen med mindre kontoen din er aktivert for mobilnumre i US. Oppføringene sorteres etter name (uten å skille mellom store og små bokstaver), deretter etter prefix. Oppføringsfelt: uuid (opak oppføringsidentifikator som brukes i next_function); area_uuid (opak identifikator for kataloggruppen); country_uuid (opak landidentifikator); prefix (fullstendig prefiks som begynner med '+' og landets telefonkode); name (katalognavn; anførselstegn kan forekomme med en foranstilt omvendt skråstrek som escape-tegn); metered, overflow og needs_registration (flagg som kan være av typen boolean eller number; behandle enhver verdi som evalueres til sann, som ja); restrictions (tom når registrering ikke kreves, ellers kravtekst som kan inneholde HTML-linjeskift og en lenke, omsluttende anførselstegn og tegn med escape-sekvenser; behandle den som visningstekst som ikke er til å stole på); state (for US, CA og PR en delstatskode, eller en tom liste når ingen er kjent; for andre land landets ISO-kode); country_iso; is_mobile (1 i mobilgruppen, ellers 0); number_type (samme som group_key); available (antall av typen integer som katalogen oppgir for oppføringen, 0 når det ikke er oppgitt); sms_coverage (1 hvis en funksjon nevner SMS eller MMS); returns_numbers (1 når bestemte numre kan listes); next_function ('v3/getnumbers/{uuid}' når returns_numbers er 1, ellers 'v3/order/{uuid}'); prices; features (liste over tekststrenger som beskriver funksjoner); group_key; group_type_uuid. Hver oppføring i prices har price_id (opak planidentifikator), is_customer_custom (true når tilpassede priser for kontoen din gjelder; bare for planer uten inkluderte kanaler), per_minute og free_minutes (tekststrenger med desimaltall), setup_price og monthly_price (tekststrenger med to desimaler) og channels (antall inkluderte kanaler av typen integer). Oppføringer uten noen prisplan utelates. Høyst 1000 katalogoppføringer per nummertype vurderes per forespørsel. Hvis ingen typer har oppføringer, er response en tom liste med status.results lik 0. Hvis sanntidsoppslaget i katalogen mislykkes, kan svaret avvike fra denne svarstrukturen, eller grupper kan mangle.

Illustrasjon av svarstrukturen; dette er verken kontodata hentet i sanntid eller et gjeldende pristilbud.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "group_key": "tollfree",
      "group_name": "Toll-free",
      "group_type_uuid": "00000000-0000-4000-8000-0000000000a1",
      "items": [
        {
          "uuid": "0000000000000000000000000000b001",
          "area_uuid": "0000000000000000000000000000a001",
          "country_uuid": "0000000000000000000000000000c001",
          "prefix": "+33800",
          "name": "Example Toll-free",
          "metered": true,
          "overflow": 0,
          "needs_registration": 0,
          "restrictions": "",
          "state": "FR",
          "country_iso": "FR",
          "is_mobile": 0,
          "number_type": "tollfree",
          "available": 10,
          "sms_coverage": 0,
          "returns_numbers": 1,
          "next_function": "v3/getnumbers/0000000000000000000000000000b001",
          "prices": [
            {
              "price_id": "0000000000000000000000000000d001",
              "is_customer_custom": false,
              "per_minute": "0.05",
              "free_minutes": "0",
              "setup_price": "0.00",
              "monthly_price": "5.00",
              "channels": 2
            }
          ],
          "features": ["voice"],
          "group_key": "tollfree",
          "group_type_uuid": "00000000-0000-4000-8000-0000000000a1"
        }
      ]
    }
  ]
}

Feil

• 500: msg 'ISO Code parameter is required': isocode mangler eller er tom. Dette er en feil i forespørselen som kan rettes. Ingen tilsvarende HTTP-status settes.
• 404: msg 'Error: no such country': landet er ukjent eller ikke knyttet til katalogen over spesialnumre. Ingen tilsvarende HTTP-status settes.
• 401: Autentisering mangler eller mislyktes. Sendes med HTTP-status 401.

Tilgjengelighet og sideeffekter

• Legger ikke inn en bestilling. Koden for dette endepunktet inneholder ikke noe belastningstrinn.
• Oppdaterer katalogdetaljene og pristilbudene for kontoen din og erstatter tidligere tilbud for de samme planene. Hvordan bestillingsendepunktene bruker disse tilbudene, er dokumentert separat.
• Prisene er spesifikke for kontoen din og kan inkludere tilpassede priser. Svaret oppgir ingen valuta.
• Utfører katalogoppslag i sanntid og kan derfor være tregere enn andre kall for å finne tilgjengelige numre. Resultatene kan endre seg mellom kall.