Iegūt valsts īpašo numuru veidu un cenu sarakstu

Vietējos numurus var atrast ar getcountries un getareas. Lai atrastu nacionālos, bezmaksas, dalītas maksas, globālos un mobilos numurus, izsauciet other ar valsts ISO kodu.

• Grupas tiek parādītas noteiktā secībā, un grupas bez ierakstiem tiek izlaistas.
• Katrā ierakstā jūsu konta cenu plāni ir norādīti laukā prices. Izvēlieties plānu pēc tā lauku vērtībām: channels, monthly_price, setup_price, per_minute un free_minutes, un saglabājiet tā price_id pasūtīšanai, ja attiecīgais galapunkts to pieprasa.
• Ja needs_registration vērtība tiek novērtēta kā patiesa, izlasiet restrictions pirms pasūtīšanas. Uztveriet šo tekstu kā neuzticamu attēlojamo saturu.
• Sekojiet laukā norādītajam: next_function: v3/getnumbers/{uuid} ļauj izvēlēties konkrētu numuru, savukārt v3/order/{uuid} veic pasūtījumu tieši no ieraksta.
• Tukšs response saraksts ar kodu 200 nozīmē, ka pieprasījuma veikšanas brīdī netika atrasts neviens īpašo numuru veids. Ja katalogs īslaicīgi nebija sasniedzams, atbilde var būt nepilnīga vai nederīgā JSON formātā, tāpēc mēģiniet vēlreiz vēlāk.
• Valstīm, kuras nav katalogā, tiek atgriezts kods 404 bez atbilstoša HTTP statusa. Vienmēr pārbaudiet status.code.

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 veikšanas tiek atgriezta HTTP 401 atbilde.

GET ar isocode ceļā. Ja ceļa segments ir izlaists, tā vietā tiek nolasīts veidlapas kodējumā norādīts lauks isocode.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/other/FR'

Atbilde

Standarta atbildes ietvars. Veiksmes gadījumā status.code ir 200, status.msg ir tukšs, un status.results ir grupu skaits. response ir grupu saraksts. Grupas lauki: group_key (normalizēta veida atslēga: national, tollfree, sharedcost, global, mobile vai cita atslēga, kas sastāv no mazajiem burtiem un cipariem); group_name (attēlojamais nosaukums); group_type_uuid (veida identifikators bez interpretējamas iekšējās struktūras); items. Grupu secība ir national, tollfree, sharedcost, global, mobile, pēc tam pārējās atslēgas tiek kārtotas pēc group_name. Grupas bez items tiek izlaistas, tāpat arī vietējo numuru veids. Valstij US mobilo numuru grupa tiek izlaista, ja vien jūsu kontā nav iespējota piekļuve US mobilajiem numuriem. Ieraksti tiek kārtoti pēc name (neņemot vērā lielo un mazo burtu atšķirības), pēc tam pēc prefix. Ieraksta lauki: uuid (ieraksta identifikators bez interpretējamas iekšējās struktūras, ko izmanto laukā next_function); area_uuid (kataloga grupas identifikators bez interpretējamas iekšējās struktūras); country_uuid (valsts identifikators bez interpretējamas iekšējās struktūras); prefix (pilns prefikss, kas sākas ar '+' un valsts tālruņa kodu); name (nosaukums katalogā; pēdiņas var būt ekranētas ar atpakaļvērsto slīpsvītru); metered, overflow un needs_registration (karodziņi, kuru tips var būt boolean vai number; jebkuru vērtību, kas tiek novērtēta kā patiesa, uzskatiet par jā); restrictions (tukšs, ja reģistrācija nav nepieciešama, pretējā gadījumā prasību teksts, kas var ietvert HTML rindiņu pārtraukumus un saiti, aptverošās pēdiņas un ekranētas rakstzīmes; uztveriet to kā neuzticamu attēlojamo tekstu); state (valstīm US, CA un PR — štata vai provinces kods vai tukšs saraksts, ja tas nav zināms; pārējām valstīm — valsts ISO kods); country_iso; is_mobile (1 mobilo numuru grupā, citādi 0); number_type (tāds pats kā group_key); available (katalogā norādītais attiecīgā ieraksta skaits ar tipu integer, 0, ja tas nav norādīts); sms_coverage (1, ja kādā iespējā ir pieminēts SMS vai MMS); returns_numbers (1, ja var iegūt konkrētu numuru sarakstu); next_function ('v3/getnumbers/{uuid}', ja returns_numbers ir 1, citādi 'v3/order/{uuid}'); prices; features (iespēju aprakstu virkņu saraksts); group_key; group_type_uuid. Katrā prices ierakstā ir price_id (plāna identifikators bez interpretējamas iekšējās struktūras), is_customer_custom (true, ja tiek piemērotas jūsu kontam individuāli noteiktas cenas; tikai plāniem bez iekļautiem kanāliem), per_minute un free_minutes (decimālskaitļu virknes), setup_price un monthly_price (virknes ar divām zīmēm aiz komata), kā arī channels (iekļauto kanālu skaits ar tipu integer). Ieraksti, kuriem nav neviena cenu plāna, tiek izlaisti. Katrā pieprasījumā tiek aplūkoti ne vairāk kā 1000 kataloga ieraksti katram numuru veidam. Ja nevienam veidam nav ierakstu, response ir tukšs saraksts, un status.results ir 0. Ja meklēšana reāllaika katalogā neizdodas, atbilde var neatbilst šim ietvaram vai tajā var trūkt grupu.

Ilustratīva atbildes struktūra; tie nav reāllaika konta dati vai aktuāls cenu piedāvājums.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "group_key": "tollfree",
      "group_name": "Toll-free",
      "group_type_uuid": "00000000-0000-4000-8000-0000000000a1",
      "items": [
        {
          "uuid": "0000000000000000000000000000b001",
          "area_uuid": "0000000000000000000000000000a001",
          "country_uuid": "0000000000000000000000000000c001",
          "prefix": "+33800",
          "name": "Example Toll-free",
          "metered": true,
          "overflow": 0,
          "needs_registration": 0,
          "restrictions": "",
          "state": "FR",
          "country_iso": "FR",
          "is_mobile": 0,
          "number_type": "tollfree",
          "available": 10,
          "sms_coverage": 0,
          "returns_numbers": 1,
          "next_function": "v3/getnumbers/0000000000000000000000000000b001",
          "prices": [
            {
              "price_id": "0000000000000000000000000000d001",
              "is_customer_custom": false,
              "per_minute": "0.05",
              "free_minutes": "0",
              "setup_price": "0.00",
              "monthly_price": "5.00",
              "channels": 2
            }
          ],
          "features": ["voice"],
          "group_key": "tollfree",
          "group_type_uuid": "00000000-0000-4000-8000-0000000000a1"
        }
      ]
    }
  ]
}

Kļūdas

• 500: msg 'ISO Code parameter is required': isocode nav norādīts vai ir tukšs. Tā ir labojama pieprasījuma kļūda. Atbilstošs HTTP statuss netiek iestatīts.
• 404: msg 'Error: no such country': valsts nav zināma vai nav piesaistīta īpašo numuru katalogam. Atbilstošs HTTP statuss netiek iestatīts.
• 401: autentifikācija nav nodrošināta vai nav izdevusies. Tiek nosūtīts ar HTTP statusu 401.

Pieejamība un blakusefekti

• Neveic pasūtījumu. Šī galapunkta kodā nav maksas iekasēšanas darbības.
• Atjaunina kataloga informāciju un jūsu konta cenu piedāvājumus, aizstājot iepriekšējos piedāvājumus tiem pašiem plāniem. Tas, kā pasūtīšanas galapunkti izmanto šos piedāvājumus, ir dokumentēts atsevišķi.
• Cenas ir noteiktas jūsu kontam un var ietvert individuāli pielāgotas cenas. Atbildē nav norādīta valūta.
• Veic meklēšanu reāllaika katalogā, tāpēc var būt lēnāks par citiem numuru meklēšanas izsaukumiem. Rezultāti dažādos izsaukumos var mainīties.