Egy körzet prefixeinek listázása

Mielőtt hozzákezd

Válasszon körzetet ezzel: getareas. Másolja ki a körzetazonosítót a válaszból vagy a visszaadott next_function értékéből. Egyesült államokbeli vagy kanadai körzet esetén használja ezt: getstates, ha egy államra vagy tartományra szeretné szűkíteni az eredményeket.

Az eredmény értelmezése

Ellenőrizze ezt: status.code a JSON-törzsben, a HTTP-állapot mellett. A sikeres eredmények a response tömbben találhatók. Az alapértelmezett válasz név szerint rendezett. A available becslés, a katalógusjelzők pedig nem helyettesítik a kiválasztott szám tényleges képességeinek és regisztrációs követelményeinek ellenőrzését.

A következő lépés kiválasztása

Csoportosítás nélküli eredményt használjon. Ha a returns_numbers értéke 1, a visszaadott next_function számkeresésre mutat. Ha az érték 0, a számokat rendeléskor rendelik hozzá, és az útvonal rendelési műveletre mutat. Elküldés előtt vizsgálja meg a műveletet és annak követelményeit: egy rendelési kérés terhelést eredményezhet a fiókján. Ne küldjön automatikusan kérést minden visszaadott útvonalra.

A válasz nem tartalmaz árat. Vásárlás előtt tekintse át a vonatkozó árajánlatot, a szükséges dokumentumokat és a rendelési utasításokat. Őrizze meg a visszaadott egyedi prefix- és árajánlat-azonosítókat; ne állítsa elő őket a megjelenített telefonos prefixből.

Haladó megjelenítési beállítások

compact=1 legfeljebb 100 sorból álló, véletlenszerű sorrendű mintát ad vissza, nem egy nagyobb eredményhalmaz egyik oldalát. A csoportosítás összesítő sorokat és mesterséges azonosítókat hoz létre; egy egyedi prefix kiválasztásához szokásos, csoportosítás nélküli választ használjon. A mintavételezett vagy csoportosított eredmények alapján ne állítsa, hogy a készlet teljes körű vagy a képességek pontosan meghatározottak.

Kérés

Engedélyezett API-fiókjának hitelesítési adatait HTTPS-en keresztül használja. A Basic hitelesítés és az engedélyezett API-fiókok bearer tokenjei támogatottak; a fiók korlátozásai érvényesek.

Használjon GET kérést, és a nem kötelező paramétereket a lekérdezési karakterláncban küldje el. Ne támaszkodjon az űrlaptörzsből történő tartalék beolvasásra.

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

Válasz

A szabványos status/response JSON-válaszburkoló. A status.results a visszaadott sorokat számolja, mintavétel vagy csoportosítás esetén is. A response prefixobjektumokat tartalmaz. Ármezőket a rendszer nem ad vissza. A szokásos, csoportosítás nélküli válaszban a uuid a prefix azonosítója; az area_uuid és a country_uuid visszaadott azonosítók; a prefix és a name megjelenítési információ; az available az elérhetőség becslése, nem foglalás; a needs_registration és a restrictions regisztrációs információkat ír le; az sms_coverage, az is_mobile és a number_type katalógusbeli támpontok, nem jelentenek garanciát egy adott szám képességeire. A number_type lehet üres vagy más katalógusbeli karakterlánc, ezért ne követeljen meg rögzített felsorolástípust. A state karakterlánc, amely üres lehet, vagy katalógusbeli formázást tartalmazhat. A latitude és a longitude üres is lehet. A metered és az overflow katalógusjelzők, nem pénzösszegek. A returns_numbers számlistázási útvonalat (1) vagy rendeléskori számhozzárendelési útvonalat (0) választ. A next_function ezt a következő útvonalat azonosítja. A csoportosított válaszok ezenfelül összevont képességeket is tartalmaznak, köztük helyettesítő képességértékeket; ezeket ne értelmezze minden szám ellenőrzött képességeiként.

A válasz szerkezetét szemléltető példa; nem élő fiókadat vagy aktuális árajánlat.

{
  "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"
    }
  ]
}

Hibák

• 404: Invalid area ID: kérjen le aktuális körzetazonosítót a keresési lépések során.
• 404: State filter is only available for US and CA: más országok esetén hagyja el a state paramétert.
• 404: Invalid state: a getstates által ehhez az országhoz visszaadott államot vagy tartományt használjon.
• 404: No prefixes found: a rendszer nem adott vissza megfelelő katalógussorokat. Ez nem bizonyítja, hogy egy adott szám soha nem rendelhető meg.
• 500: Hiba: 'Failed loading prefixes': a katalógus lekérdezése sikertelen. Próbálja újra később, és ha a hiba fennmarad, forduljon az ügyfélszolgálathoz.

Elérhetőség és mellékhatások

• Ez keresési lépés, nem rendelés-visszaigazolás. Az elérhetőség további katalóguslekérdezésekkel frissülhet, ezért a válaszidő változhat.
• A rendszer nem ad vissza árakat. Rendelés előtt kérje le az adott számra vagy rendelésre vonatkozó árajánlatot, és tekintse át a regisztrációs követelményeket.
• Ne tekintse az available értékét pontos készletmennyiségnek, a nullát általános rendelési tilalomnak, a sikeres lekérdezést pedig foglalásnak. Az elérhetőség a rendelés előtt változhat.