Srities numerių prefiksų sąrašas

Prieš pradėdami

Pasirinkite sritį naudodami getareas. Nukopijuokite srities ID iš atsakymo arba grąžinto lauko next_function. JAV arba Kanados sričiai naudokite getstates, jei norite apriboti rezultatus iki vienos valstijos arba provincijos.

Kaip skaityti rezultatą

Patikrinkite lauką status.code JSON turinyje ir HTTP būseną. Sėkmingi rezultatai pateikiami masyve response. Pagal numatytąsias nuostatas atsakymas surikiuojamas pagal pavadinimą. available yra apytikslis įvertis, o katalogo požymiai neatstoja pasirinkto numerio faktinių galimybių ir registracijos reikalavimų patikrinimo.

Pasirinkite kitą veiksmą

Naudokite nesugrupuotą rezultatą. Kai returns_numbers reikšmė yra 1, grąžintas laukas next_function nurodo numerių paiešką. Kai reikšmė yra 0, numeriai priskiriami užsakymo metu, o kelias nurodo užsakymo operaciją. Prieš siųsdami užklausą, peržiūrėkite operaciją ir jos reikalavimus: užsakymo užklausa gali lemti lėšų nurašymą iš jūsų paskyros. Automatiškai nesiųskite užklausų visais grąžintais keliais.

Kaina čia nepateikiama. Prieš pirkdami peržiūrėkite atitinkamą kainos pasiūlymą, reikiamus dokumentus ir užsakymo instrukcijas. Išsaugokite grąžintus atskiro prefikso ir kainos pasiūlymo ID, o ne kurkite juos pagal rodomą telefono numerio prefiksą.

Išplėstinės rodymo parinktys

compact=1 grąžina atsitiktine tvarka išdėstytą ne daugiau kaip 100 eilučių imtį, o ne didesnio rezultatų rinkinio puslapį. Grupuojant sukuriamos suvestinės eilutės ir dirbtiniai ID; norėdami pasirinkti atskirą prefiksą, naudokite įprastą nesugrupuotą atsakymą. Nesiremkite imties ar sugrupuotais rezultatais teigdami, kad pateikiamas visas turimų numerių sąrašas ar tikslios jų galimybės.

Užklausa

Naudokite savo įjungtos API paskyros prisijungimo duomenis per HTTPS. Palaikomas Basic autentifikavimas ir įjungti API paskyros bearer prieigos raktai; taikomi paskyros apribojimai.

Naudokite GET ir neprivalomus parametrus siųskite užklausos eilutėje. Nesikliaukite atsarginiu parametrų perdavimu formos turinyje.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/getprefixes/$AREA_ID?state=NY"

Atsakymas

Standartinė status/response JSON struktūra. status.results nurodo grąžintų eilučių skaičių, taip pat ir taikant imties atranką ar grupavimą. response turi prefiksų objektus. Kainų laukai negrąžinami. Įprastame nesugrupuotame atsakyme uuid yra prefikso ID; area_uuid ir country_uuid yra grąžinti identifikatoriai; prefix ir name yra rodymui skirta informacija; available yra apytikslis prieinamumo įvertis, o ne rezervacija; needs_registration ir restrictions aprašo registracijos informaciją; sms_coverage, is_mobile ir number_type yra katalogo nuorodos apie galimybes, o ne konkretaus numerio galimybių garantija. number_type gali būti tuščias arba turėti kitą katalogo eilutės reikšmę, todėl nereikalaukite fiksuoto išvardijamų reikšmių rinkinio. state yra eilutė, kuri gali būti tuščia arba turėti katalogui būdingą formatavimą. latitude ir longitude gali būti tušti. metered ir overflow yra katalogo požymiai, o ne piniginės sumos. returns_numbers parenka numerių sąrašo gavimo kelią (1) arba numerio priskyrimo užsakymo metu kelią (0). next_function nurodo tą kitą kelią. Sugrupuotuose atsakymuose papildomai pateikiamos sujungtos savybės, įskaitant atsargines savybių reikšmes; nelaikykite jų patikrintomis kiekvieno numerio galimybėmis.

Pavyzdinė atsakymo struktūra; tai nėra faktiniai paskyros duomenys ar dabartinis kainos pasiūlymas.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "uuid": "PREFIX_ID_FROM_RESPONSE",
      "area_uuid": "AREA_ID_FROM_RESPONSE",
      "country_uuid": "COUNTRY_ID_FROM_RESPONSE",
      "prefix": "+1212",
      "name": "Example area",
      "metered": 0,
      "overflow": 0,
      "needs_registration": 0,
      "restrictions": "",
      "state": "NY",
      "country_iso": "US",
      "is_mobile": 0,
      "number_type": "local",
      "latitude": "",
      "longitude": "",
      "available": 12,
      "sms_coverage": 1,
      "returns_numbers": 1,
      "next_function": "v3/getnumbers/PREFIX_ID_FROM_RESPONSE"
    }
  ]
}

Klaidos

• 404: Invalid area ID: gaukite dabartinį srities ID atlikdami katalogo paiešką.
• 404: State filter is only available for US and CA: kitoms šalims nenurodykite state parametro.
• 404: Invalid state: naudokite šiai šaliai per getstates grąžintą valstiją ar provinciją.
• 404: No prefixes found: negrąžinta nė viena atitinkama katalogo eilutė. Tai neįrodo, kad konkretaus numerio niekada nebus galima užsisakyti.
• 500: Klaida: 'Failed loading prefixes': katalogo paieška nepavyko. Bandykite vėliau ir, jei problema išlieka, susisiekite su pagalbos tarnyba.

Prieinamumas ir šalutinis poveikis

• Tai katalogo paieškos veiksmas, o ne užsakymo patvirtinimas. Prieinamumo duomenys gali būti atnaujinami atliekant papildomas katalogo paieškas, todėl atsakymo laikas gali skirtis.
• Kainos negrąžinamos. Prieš pateikdami užsakymą, gaukite atitinkamą numerio arba užsakymo kainos pasiūlymą ir peržiūrėkite registracijos reikalavimus.
• Nelaikykite available tiksliu turimų numerių skaičiumi, nulio – visais atvejais galiojančiu draudimu užsisakyti, o sėkmingos paieškos – rezervacija. Prieinamumas iki užsakymo gali pasikeisti.