Apgabalam piedāvāto prefiksu saraksts

Pirms sākat

Izvēlieties apgabalu, izmantojot getareas. Nokopējiet apgabala ID no atbildes vai atgrieztā lauka next_function. ASV vai Kanādas apgabalam izmantojiet getstates, ja vēlaties ierobežot rezultātus līdz vienam štatam vai vienai provincei.

Rezultāta interpretēšana

Pārbaudiet status.code JSON saturā, kā arī HTTP statusu. Veiksmīga pieprasījuma rezultāti ir masīvā response. Pēc noklusējuma atbilde ir sakārtota pēc nosaukuma. available ir aptuvens novērtējums, un kataloga pazīmes neaizstāj izvēlētā numura faktisko iespēju un reģistrācijas prasību pārbaudi.

Nākamās darbības izvēle

Izmantojiet negrupētu rezultātu. Ja returns_numbers vērtība ir 1, atgrieztais lauks next_function norāda uz numuru meklēšanu. Ja vērtība ir 0, numuri tiek piešķirti pasūtīšanas brīdī un ceļš norāda uz pasūtīšanas operāciju. Pirms pieprasījuma nosūtīšanas izpētiet operāciju un tās prasības: pasūtīšanas pieprasījums var izraisīt naudas līdzekļu atskaitīšanu no jūsu konta. Automātiski nesūtiet pieprasījumus uz visiem atgrieztajiem ceļiem.

Cena šeit nav iekļauta. Pirms iegādes izskatiet attiecīgo cenas piedāvājumu, nepieciešamos dokumentus un pasūtīšanas norādījumus. Saglabājiet atgrieztos atsevišķā prefiksa un cenas piedāvājuma ID, nevis veidojiet tos no attēlotā tālruņa prefiksa.

Papildu attēlošanas iespējas

compact=1 atgriež nejaušā secībā sakārtotu izlasi ar ne vairāk kā 100 rindām, nevis lielākas rezultātu kopas lapu. Grupēšana izveido kopsavilkuma rindas un mākslīgus ID; lai izvēlētos atsevišķu prefiksu, izmantojiet parastu negrupētu atbildi. Neizmantojiet izlases vai grupētus rezultātus, lai apgalvotu, ka ir apzināts viss pieejamo numuru klāsts vai precīzas iespējas.

Pieprasījums

Izmantojiet sava iespējotā API konta piekļuves datus, savienojoties ar HTTPS. Tiek atbalstīta Basic autentifikācija un iespējotie API konta bearer pilnvarojumi; ir spēkā konta ierobežojumi.

Izmantojiet GET un sūtiet neobligātos parametrus vaicājuma virknē. Nepaļaujieties uz rezerves iespēju nodot tos veidlapas datos pieprasījuma saturā.

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

Atbilde

Standarta JSON ietvars ar status/response. status.results norāda atgriezto rindu skaitu, arī tad, ja izmantota izlase vai grupēšana. response satur prefiksu objektus. Cenu lauki netiek atgriezti. Parastā negrupētā atbildē uuid ir prefiksa ID; area_uuid un country_uuid ir atgrieztie identifikatori; prefix un name ir attēlošanai paredzēta informācija; available ir pieejamības novērtējums, nevis rezervācija; needs_registration un restrictions sniedz reģistrācijas informāciju; sms_coverage, is_mobile un number_type ir kataloga norādes, kas negarantē konkrēta numura iespējas. number_type var būt tukšs vai saturēt citu kataloga virkni, tāpēc nepieprasiet fiksētu uzskaitījuma tipu. state ir virkne, kas var būt tukša vai saturēt kataloga formatējumu. latitude un longitude var būt tukši. metered un overflow ir kataloga pazīmes, nevis naudas summas. returns_numbers izvēlas numuru saraksta iegūšanas maršrutu (1) vai maršrutu numura piešķiršanai pasūtīšanas brīdī (0). next_function identificē šo nākamo maršrutu. Grupētās atbildes papildus satur apvienotas īpašības, tostarp īpašību rezerves vērtības; neinterpretējiet tās kā katra numura pārbaudītas iespējas.

Ilustratīvs atbildes struktūras piemērs; tie nav aktuāli konta dati vai pašreizējs cenas piedāvājums.

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

Kļūdas

• 404: Invalid area ID: iegūstiet aktuālu apgabala ID, veicot piedāvājuma izpēti.
• 404: State filter is only available for US and CA: citām valstīm nenorādiet state.
• 404: Invalid state: izmantojiet šai valstij ar getstates atgriezto štatu vai provinci.
• 404: No prefixes found: netika atgriezta neviena atbilstoša kataloga rinda. Tas nepierāda, ka konkrētu numuru nekad nevarēs pasūtīt.
• 500: Kļūda: 'Failed loading prefixes': meklēšana katalogā neizdevās. Mēģiniet vēlreiz vēlāk un sazinieties ar atbalsta dienestu, ja problēma saglabājas.

Pieejamība un blakusefekti

• Šī ir piedāvājuma izpētes darbība, nevis pasūtījuma apstiprinājums. Pieejamība var tikt atjaunināta, veicot papildu meklēšanu katalogā, tāpēc atbildes gaidīšanas laiks var atšķirties.
• Cenas netiek atgrieztas. Pirms pasūtījuma veikšanas iegūstiet attiecīgo numura vai pasūtījuma cenas piedāvājumu un izskatiet reģistrācijas prasības.
• Neuzskatiet available par precīzu pieejamo numuru skaitu, nulli par vispārēju pasūtīšanas aizliegumu vai veiksmīgu meklēšanu par rezervāciju. Pieejamība pirms pasūtīšanas var mainīties.