Izstrādātājiem

GET/v3/getcountries

To valstu saraksts, kurās ir krājumā pieejami numuri

Atgriež redzamās valstis, kurās pašlaik ir krājumā pieejami numuri ar vismaz vienu prefiksu. Katrs ieraksts ietver valsts tālruņa kodu, ISO kodu, valsts līmeņa mobilo numuru un SMS pazīmes, koordinātas un next_function saiti uz valsts pārklājuma apgabaliem.

Šajā lapā
  1. Pieprasījums
  2. Atbilde
  3. Kļūdas
  4. Pieejamība un blakusefekti

Sāciet vietējo numuru meklēšanu šeit. Sarakstā ir tikai tās valstis, kurās pašlaik ir krājumā pieejami numuri. Nekas netiek rezervēts.

  • Nododiet isocode funkcijai getareas, funkcijai getstates (tikai US un CA) vai funkcijai other.
  • next_function vienmēr norāda uz v3/getareas/{isocode}. Amerikas Savienotajām Valstīm un Kanādai vispirms varat izsaukt getstates, lai sašaurinātu atlasi pēc štata vai provinces.
  • is_mobile un sms_coverage ir valsts līmeņa pazīmes, kas negarantē attiecīgās iespējas katram numuram. Amerikas Savienotajām Valstīm is_mobile vērtība ir 0, ja vien jūsu kontā nav iespējota ASV mobilo numuru izmantošana.
  • Valstis, kurās pārklājums ir pieejams tikai pēc pasūtījuma, sarakstā netiek iekļautas. Tomēr varat izsaukt getareas vai other tieši arī valstij, kas nav iekļauta sarakstā.
  • Ja nepieciešama noteikta secība, sakārtojiet sarakstu paši.

Ja neviena valsts neatbilst nosacījumiem, response vērtība ir null un status.code vērtība ir 200.

Pieprasījums

Nepieciešama HTTP Basic autentifikācija vai Bearer pilnvara (skatiet sadaļu «Autentifikācija un API atbildes»). Ja autentifikācija neizdodas, pirms meklēšanas izpildes tiek atgriezta atbilde ar HTTP statusu 401.

GET bez pieprasījuma satura. Vienīgais parametrs ir neobligātais pid, ko nosūta vaicājuma virknē.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getcountries'
Vaicājuma parametri
NosaukumsTipsObligātsApraksts
pidstringNēPapildu iestatījums, kas nav obligāts. Sašaurina sarakstu līdz valstīm, kas atzīmētas vienam numuru krājumu avotam. Izmantojiet tikai MultiTEL sniegtu vērtību skaitliskā vai 32 rakstzīmju heksadecimālā formā; parastai lietošanai šo parametru nenorādiet. pid nesašaurina atbildes aprakstā minēto krājumu pārbaudi. Neatpazītas vērtības, nulle un vērtības, ko šis galapunkts nepieņem, tiek ignorētas bez kļūdas paziņojuma; tādā gadījumā saraksts aptver visus atbalstītos avotus.

Atbilde

Standarta atbildes ietvars. Veiksmīgas izpildes gadījumā status.code vērtība ir 200, status.msg vērtība ir 'Results: N', status.results vērtība ir N, un response ir valstu saraksts, kura secība netiek garantēta. Lauki: countrycode (valsts tālruņa kods bez '+'); name (valsts nosaukums); description (tāda pati vērtība kā laukam name); isocode (ISO 3166-1 alpha-2 kods); is_mobile (0 vai 1, valsts līmeņa kataloga pazīme; valstij US vienmēr 0, ja vien jūsu kontā nav iespējota US mobilo numuru izmantošana); sms_coverage (0 vai 1, valsts līmeņa kataloga pazīme); latitude un longitude (valsts koordinātas); next_function ('v3/getareas/{isocode}'). Valsts sarakstā tiek iekļauta tikai tad, ja tā ir redzama un vismaz ar vienu tās prefiksu pašlaik ir pieejami numuri krājumā kādā no numuru krājumu avotiem. Valstis, kurās viss pārklājums ir pieejams tikai pēc pasūtījuma (krājumā numuru nav), sarakstā netiek iekļautas. Šī krājumu pārbaude ir plašāka par funkcijas getareas lietotajiem filtriem, tāpēc sarakstā iekļautai valstij šī funkcija reizēm var atgriezt 'No areas found'. Ja neviena valsts neatbilst nosacījumiem, status.code vērtība ir 200, status.msg vērtība ir 'Results: 0', lauka status.results nav, un response vērtība ir null.

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

{
  "status": {
    "code": 200,
    "msg": "Results: 2",
    "results": 2
  },
  "response": [
    {
      "countrycode": "1",
      "name": "United States",
      "description": "United States",
      "isocode": "US",
      "is_mobile": 0,
      "sms_coverage": 1,
      "latitude": "38.0000",
      "longitude": "-97.0000",
      "next_function": "v3/getareas/US"
    },
    {
      "countrycode": "44",
      "name": "United Kingdom",
      "description": "United Kingdom",
      "isocode": "GB",
      "is_mobile": 1,
      "sms_coverage": 0,
      "latitude": "54.0000",
      "longitude": "-2.0000",
      "next_function": "v3/getareas/GB"
    }
  ]
}

Kļūdas

  • 401: autentifikācija nav norādīta vai ir neizdevusies. Tiek nosūtīts ar HTTP statusu 401 (skatiet sadaļu «Autentifikācija un API atbildes»).

Pieejamība un blakusefekti

  • Tikai informācijas meklēšana. Nekas netiek rezervēts, pasūtīts vai mainīts.
  • Rezultāti atspoguļo krājumu stāvokli pieprasījuma brīdī un starp izsaukumiem var mainīties.