Vis særlige nummertyper og priser for et land

Lokale numre findes med getcountries og getareas. For nationale numre, frikaldsnumre, numre med delt taksering, globale numre og mobilnumre skal du kalde other med landets ISO-kode.

• Grupperne vises i en fast rækkefølge, og grupper uden poster udelades.
• Hver post angiver din kontos prisplaner i prices. Vælg en plan ud fra dens channels, monthly_price, setup_price, per_minute og free_minutes, og gem dens price_id til bestilling, når det pågældende endepunkt kræver den.
• Hvis needs_registration har en værdi, der evalueres som sand, skal du læse restrictions før bestilling. Behandl teksten som visningsindhold, der ikke er tillid til.
• Følg next_function: v3/getnumbers/{uuid} giver dig mulighed for at vælge et bestemt nummer, og v3/order/{uuid} bestiller direkte fra posten.
• En tom response-liste med koden 200 betyder, at der ikke blev fundet nogen særlige nummertyper på tidspunktet for anmodningen. Hvis kataloget midlertidigt ikke kunne nås, kan svaret være ufuldstændigt eller ikke være gyldig JSON, så prøv igen senere.
• Lande uden for kataloget returnerer koden 404 uden en tilsvarende HTTP-status. Kontrollér altid status.code.

Anmodning

Påkrævet: HTTP Basic eller et Bearer-token (se Godkendelse og API-svar). Mislykket godkendelse besvares med HTTP 401, før opslaget udføres.

GET med isocode i stien. Hvis stisegmentet udelades, læses et formularkodet isocode-felt i stedet.

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

Svar

Standardstruktur for svar. Ved succes er status.code 200, status.msg er tom, og status.results er antallet af grupper. response er en liste over grupper. Gruppefelter: group_key (normaliseret typenøgle: national, tollfree, sharedcost, global, mobile eller en anden alfanumerisk nøgle med små bogstaver); group_name (visningsnavn); group_type_uuid (uigennemsigtig typeidentifikator); items. Grupperne vises i rækkefølgen national, tollfree, sharedcost, global, mobile og derefter andre nøgler sorteret efter group_name. Grupper uden items udelades, og det samme gælder den lokale type. For US udelades mobilgruppen, medmindre din konto er aktiveret til mobilnumre i US. Poster sorteres efter name (uden skelnen mellem store og små bogstaver) og derefter efter prefix. Postfelter: uuid (uigennemsigtig postidentifikator, der bruges i next_function); area_uuid (uigennemsigtig identifikator for kataloggruppen); country_uuid (uigennemsigtig landeidentifikator); prefix (fuldt præfiks, der begynder med '+' og landets telefonkode); name (katalognavn; anførselstegn kan være escapet med omvendt skråstreg); metered, overflow og needs_registration (flag, der kan være boolean eller number; behandl enhver værdi, der evalueres som sand, som ja); restrictions (tom, når registrering ikke er nødvendig, ellers tekst om krav, som kan indeholde HTML-linjeskift og et link, omgivende anførselstegn og escapede tegn; behandl den som visningstekst, der ikke er tillid til); state (for US, CA og PR en delstatskode eller en tom liste, når ingen er kendt; for andre lande landets ISO-kode); country_iso; is_mobile (1 i mobilgruppen, ellers 0); number_type (samme som group_key); available (antal af typen integer, som kataloget angiver for posten, 0 hvis det ikke er angivet); sms_coverage (1 hvis en funktion nævner SMS eller MMS); returns_numbers (1 når bestemte numre kan vises på en liste); next_function ('v3/getnumbers/{uuid}' når returns_numbers er 1, ellers 'v3/order/{uuid}'); prices; features (liste over strenge, der beskriver funktioner); group_key; group_type_uuid. Hver post i prices har price_id (uigennemsigtig planidentifikator), is_customer_custom (true når der gælder særlige priser for din konto; kun for planer uden inkluderede kanaler), per_minute og free_minutes (strenge med decimaltal), setup_price og monthly_price (strenge med to decimaler) samt channels (antal inkluderede kanaler af typen integer). Poster uden nogen prisplan udelades. Der tages højst 1000 katalogposter pr. nummertype i betragtning pr. anmodning. Hvis ingen type har poster, er response en tom liste med status.results 0. Hvis liveopslaget i kataloget mislykkes, bruger svaret muligvis ikke denne struktur, eller der kan mangle grupper.

Illustration af svarstrukturen; ikke aktuelle kontodata eller et gældende 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"
        }
      ]
    }
  ]
}

Fejl

• 500: msg 'ISO Code parameter is required': isocode mangler eller er tom. Dette er en fejl i anmodningen, som kan rettes. Der sættes ingen tilsvarende HTTP-status.
• 404: msg 'Error: no such country': landet er ukendt eller ikke knyttet til kataloget over særlige numre. Der sættes ingen tilsvarende HTTP-status.
• 401: Godkendelse mangler eller er mislykket. Sendes med HTTP-status 401.

Tilgængelighed og sideeffekter

• Afgiver ikke en bestilling. Der er intet opkrævningstrin i dette endepunkts kode.
• Opdaterer katalogoplysningerne og pristilbuddene for din konto og erstatter tidligere tilbud for de samme planer. Det er dokumenteret særskilt, hvordan bestillingsendepunkterne bruger disse tilbud.
• Priserne er specifikke for din konto og kan omfatte særlige priser. Svaret angiver ikke en valuta.
• Udfører liveopslag i kataloget og kan derfor være langsommere end andre kald til at finde numre. Resultaterne kan ændre sig mellem kald.