Listați prefixele pentru o zonă

Înainte de a începe

Alegeți o zonă folosind getareas. Copiați ID-ul zonei din răspunsul acesteia sau din valoarea returnată pentru next_function. Pentru o zonă din SUA sau Canada, folosiți getstates dacă doriți să restrângeți rezultatele la un singur stat sau la o singură provincie.

Interpretați rezultatul

Verificați status.code în corpul JSON, precum și codul de stare HTTP. Rezultatele reușite se află în lista response. Răspunsul implicit este sortat după nume. available este o estimare, iar indicatorii din catalog nu înlocuiesc verificarea funcționalităților efective ale numărului selectat și a cerințelor de înregistrare.

Selectați pasul următor

Folosiți un rezultat negrupat. Când returns_numbers are valoarea 1, valoarea returnată pentru next_function indică o căutare de numere. Când valoarea este 0, numerele sunt alocate la plasarea comenzii, iar calea indică o operațiune de comandă. Verificați operațiunea și cerințele acesteia înainte de a trimite cererea: o cerere de comandă poate genera costuri în contul dumneavoastră. Nu trimiteți automat cereri către fiecare cale returnată.

Aici nu este inclus niciun preț. Consultați oferta de preț relevantă, documentele necesare și instrucțiunile de comandă înainte de a cumpăra. Păstrați ID-urile returnate pentru prefixul individual și pentru oferta de preț, în loc să le construiți pornind de la un prefix telefonic afișat.

Opțiuni avansate de afișare

compact=1 returnează un eșantion cu cel mult 100 de rânduri, în ordine aleatorie, nu o pagină dintr-un set mai mare de rezultate. Gruparea creează rânduri de sinteză și ID-uri sintetice; folosiți un răspuns obișnuit, negrupat, pentru a selecta un prefix individual. Nu folosiți rezultate eșantionate sau grupate pentru a afirma că inventarul este complet sau că funcționalitățile sunt exacte.

Cerere

Folosiți datele de autentificare ale contului API activat prin HTTPS. Sunt acceptate autentificarea Basic și tokenurile bearer activate pentru contul API; se aplică restricțiile contului.

Folosiți GET și trimiteți parametrii opționali în șirul de interogare. Nu vă bazați pe preluarea alternativă a parametrilor din corpul unui formular.

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

Răspuns

Structura JSON standard cu status/response. status.results indică numărul rândurilor returnate, inclusiv în cazul eșantionării sau grupării. response conține obiecte de prefix. Nu sunt returnate câmpuri de preț. În răspunsul obișnuit, negrupat, uuid este ID-ul prefixului; area_uuid și country_uuid sunt identificatori returnați; prefix și name sunt informații pentru afișare; available este o estimare a disponibilității, nu o rezervare; needs_registration și restrictions descriu informații privind înregistrarea; sms_coverage, is_mobile și number_type sunt indicii din catalog, nu o garanție a unei anumite funcționalități a numărului. number_type poate fi gol sau poate conține un alt șir de caractere din catalog, așadar nu impuneți un set fix de valori enumerate. state este un șir de caractere și poate fi gol sau poate conține formatare specifică catalogului. latitude și longitude pot fi goale. metered și overflow sunt indicatori din catalog, nu sume de bani. returns_numbers selectează o rută de listare a numerelor (1) sau o rută de alocare la plasarea comenzii (0). next_function identifică ruta respectivă pentru pasul următor. Răspunsurile grupate conțin în plus caracteristici combinate, inclusiv valori de rezervă pentru caracteristici; nu le interpretați ca funcționalități verificate ale fiecărui număr.

Structură de răspuns cu rol ilustrativ; nu reprezintă date în timp real ale contului sau o ofertă de preț actuală.

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

Erori

• 404: Invalid area ID: obțineți un ID de zonă actual din explorarea catalogului.
• 404: State filter is only available for US and CA: omiteți state pentru alte țări.
• 404: Invalid state: folosiți un stat sau o provincie returnată de getstates pentru această țară.
• 404: No prefixes found: nu au fost returnate rânduri corespunzătoare din catalog. Acest lucru nu dovedește că un anumit număr nu va putea fi comandat niciodată.
• 500: Eroare: 'Failed loading prefixes': căutarea în catalog a eșuat. Încercați din nou mai târziu și contactați serviciul de asistență dacă problema persistă.

Disponibilitate și efecte secundare

• Acesta este un pas de explorare a catalogului, nu o confirmare a comenzii. Disponibilitatea poate fi actualizată prin căutări suplimentare în catalog, astfel încât timpul de răspuns poate varia.
• Prețurile nu sunt returnate. Obțineți oferta de preț aplicabilă numărului sau comenzii și verificați cerințele de înregistrare înainte de a plasa o comandă.
• Nu interpretați available ca pe o cantitate exactă în stoc, valoarea zero ca pe o interdicție universală de a comanda sau o căutare reușită ca pe o rezervare. Disponibilitatea se poate schimba înainte de plasarea comenzii.