დეველოპერებისთვის

GET/v3/getprefixes/{area_id}

დაფარვის არეალისთვის პრეფიქსების ჩამონათვალის მიღება

მიიღეთ დაფარვის არეალისთვის შემოთავაზებული ნომრების პრეფიქსების ჩამონათვალი, შეამოწმეთ ხელმისაწვდომობისა და რეგისტრაციის ნიშნულები და განსაზღვრეთ მოძიების ან შეკვეთის შემდეგი ნაბიჯი. ფასები მოცემული არ არის.

ამ გვერდზე
  1. დაწყებამდე
  2. შედეგის წაკითხვა
  3. შემდეგი ნაბიჯის არჩევა
  4. ჩვენების დამატებითი პარამეტრები
  5. მოთხოვნა
  6. პასუხი
  7. შეცდომები
  8. ხელმისაწვდომობა და თანმდევი მოქმედებები

დაწყებამდე

აირჩიეთ დაფარვის არეალი შემდეგი საშუალებით: getareas. დააკოპირეთ არეალის ID მისი პასუხიდან ან დაბრუნებული ველიდან next_function. აშშ-ის ან კანადის არეალისთვის გამოიყენეთ getstates იმ შემთხვევაში, თუ გსურთ შედეგების ერთი შტატით ან პროვინციით შეზღუდვა.

შედეგის წაკითხვა

შეამოწმეთ status.code JSON-ის სხეულში და ასევე HTTP-ის სტატუსი. წარმატებული შედეგები მოთავსებულია response მასივში. ნაგულისხმევი პასუხი სახელის მიხედვით არის დალაგებული. available შეფასებითი მნიშვნელობაა, ხოლო კატალოგის ნიშნულები ვერ ჩაანაცვლებს არჩეული ნომრის რეალური შესაძლებლობებისა და რეგისტრაციის მოთხოვნების შემოწმებას.

შემდეგი ნაბიჯის არჩევა

გამოიყენეთ დაუჯგუფებელი შედეგი. როდესაც returns_numbers არის 1, დაბრუნებული next_function ნომრების ძიებაზე მიუთითებს. როდესაც მისი მნიშვნელობაა 0, ნომრები შეკვეთის დროს ენიჭება და გზა შეკვეთის ოპერაციაზე მიუთითებს. მოთხოვნის გაგზავნამდე შეისწავლეთ ოპერაცია და მისი მოთხოვნები: შეკვეთის მოთხოვნამ შესაძლოა თქვენი ანგარიშიდან თანხა ჩამოჭრას. ნუ გაგზავნით ავტომატურად მოთხოვნას ყველა დაბრუნებულ გზაზე.

აქ ფასი მოცემული არ არის. შეძენამდე გაეცანით შესაბამის საფასო შეთავაზებას, საჭირო დოკუმენტებსა და შეკვეთის ინსტრუქციებს. შეინახეთ დაბრუნებული ინდივიდუალური პრეფიქსისა და საფასო შეთავაზების ID-ები; ნუ შექმნით მათ ეკრანზე ნაჩვენები სატელეფონო პრეფიქსის საფუძველზე.

ჩვენების დამატებითი პარამეტრები

compact=1 აბრუნებს შემთხვევითი თანმიმდევრობით დალაგებულ შერჩევას, მაქსიმუმ 100 სტრიქონით, და არა უფრო დიდი შედეგების ნაკრების ერთ გვერდს. დაჯგუფება ქმნის შემაჯამებელ სტრიქონებსა და ხელოვნურ ID-ებს; ინდივიდუალური პრეფიქსის ასარჩევად გამოიყენეთ ჩვეულებრივი დაუჯგუფებელი პასუხი. შერჩეული ან დაჯგუფებული შედეგების საფუძველზე ნუ ამტკიცებთ, რომ ჩამონათვალი სრულ მარაგს ან ზუსტ შესაძლებლობებს ასახავს.

მოთხოვნა

გამოიყენეთ თქვენი ჩართული API ანგარიშის ავტორიზაციის მონაცემები HTTPS-ის მეშვეობით. მხარდაჭერილია Basic ავთენტიფიკაცია და ჩართული API ანგარიშის bearer ტოკენები; მოქმედებს ანგარიშის შეზღუდვები.

გამოიყენეთ GET და არასავალდებულო პარამეტრები გაგზავნეთ მოთხოვნის სტრიქონში. ნუ დაეყრდნობით პარამეტრების ფორმის სხეულიდან ალტერნატიულად მიღებას.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/getprefixes/$AREA_ID?state=NY"
გზის პარამეტრები
სახელიტიპისავალდებულოაღწერა
area_idstringდიახდააკოპირეთ არეალის იდენტიფიკატორი getareas-ის პასუხიდან ან მისი next_function ველიდან. მოეპყარით მას როგორც გაუშიფრავ მნიშვნელობას; ნუ შექმნით მას და ნუ გამოთვლით მის ჰეშს თავად.
მოთხოვნის სტრიქონის პარამეტრები
სახელიტიპისავალდებულოაღწერა
statestringარამხოლოდ US და CA ქვეყნების არეალებისთვის. გამოიყენეთ getstates-იდან მიღებული შტატის/პროვინციის კოდი ან მისი სრული სახელი. კოდებში ასოების რეგისტრს მნიშვნელობა არ აქვს; სახელებში უგულებელყოფილია ასოების რეგისტრი და გამეორებული გამოტოვებები. სხვა ქვეყნის ან ამოუცნობი არაცარიელი მნიშვნელობის მითითება API-ის შეცდომას აბრუნებს.
compactstringარაშერჩევის არასავალდებულო რეჟიმი: 1, true ან on. შედეგები შემთხვევითი თანმიმდევრობითაა დალაგებული და მოიცავს მაქსიმუმ 100 სტრიქონს. სრული შედეგების სიის მისაღებად გამოტოვეთ ეს პარამეტრი; ამ ენდპოინტს გვერდის/კურსორის მექანიზმი არ აქვს.
groupintegerარაჩვენების დამატებითი შეჯამებები: მნიშვნელობები 1-დან 6-მდე აერთიანებს სტრიქონებს და აბრუნებს საჩვენებელ პრეფიქსებს, რომელთა ნაწილიც დაფარულია. ჯგუფების UUID-ები ხელოვნურია და ინდივიდუალური პრეფიქსების ID-ების ნაცვლად ვერ გამოიყენება. ნომრის ძიებისთვის ან შეკვეთისთვის პრეფიქსის არჩევამდე გაგზავნეთ დაუჯგუფებელი მოთხოვნა. ჩვეულებრივი სამუშაო პროცესისთვის გამოტოვეთ ეს პარამეტრი.
pidstringარაMultiTEL-ის მიერ მოწოდებული მარაგის არასავალდებულო ამრჩევი, რიცხვითი ან მხარდაჭერილი 32-სიმბოლოიანი თექვსმეტობითი ფორმით. ჩვეულებრივი გამოყენებისას გამოტოვეთ იგი. ამოუცნობი მნიშვნელობები შეტყობინების გარეშე უგულებელყოფილია. ეს მნიშვნელობა არც სატელეფონო პრეფიქსია და არც სატარიფო გეგმის ID.

პასუხი

სტანდარტული status/response JSON გარსი. status.results ითვლის დაბრუნებულ სტრიქონებს, მათ შორის შერჩევის ან დაჯგუფების შემთხვევაშიც. response შეიცავს პრეფიქსების ობიექტებს. ფასის ველები არ ბრუნდება. ჩვეულებრივ დაუჯგუფებელ პასუხში uuid არის პრეფიქსის ID; area_uuid და country_uuid დაბრუნებული იდენტიფიკატორებია; prefix და name საჩვენებელი ინფორმაციაა; available ხელმისაწვდომობის შეფასებაა და არა დაჯავშნა; needs_registration და restrictions აღწერს რეგისტრაციის შესახებ ინფორმაციას; sms_coverage, is_mobile და number_type კატალოგის მინიშნებებია და არ იძლევა კონკრეტული ნომრის რომელიმე შესაძლებლობის გარანტიას. number_type შეიძლება ცარიელი იყოს ან კატალოგის სხვა ტექსტურ მნიშვნელობას შეიცავდეს, ამიტომ ნუ მოითხოვთ მნიშვნელობების ფიქსირებულ ჩამონათვალს. state ტექსტური სტრიქონია და შეიძლება ცარიელი იყოს ან კატალოგისთვის დამახასიათებელ ფორმატირებას შეიცავდეს. latitude და longitude შეიძლება ცარიელი იყოს. metered და overflow კატალოგის ნიშნულებია და არა ფულადი თანხები. returns_numbers ირჩევს ნომრების ჩამონათვალის მიღების გზას (1) ან შეკვეთის დროს მინიჭების გზას (0). next_function განსაზღვრავს ამ შემდეგ გზას. დაჯგუფებული პასუხები დამატებით შეიცავს გაერთიანებულ მახასიათებლებს, მათ შორის მახასიათებლების სათადარიგო მნიშვნელობებს; ნუ მიიჩნევთ მათ თითოეული ნომრის დადასტურებულ შესაძლებლობებად.

პასუხის სტრუქტურის საილუსტრაციო მაგალითი; ეს არ არის ანგარიშის რეალური მიმდინარე მონაცემები ან მოქმედი საფასო შეთავაზება.

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

შეცდომები

  • 404: Invalid area ID: მოძიების ეტაპზე მიიღეთ არეალის მოქმედი ID.
  • 404: State filter is only available for US and CA: სხვა ქვეყნებისთვის გამოტოვეთ state.
  • 404: Invalid state: გამოიყენეთ ამ ქვეყნისთვის getstates-ის მიერ დაბრუნებული შტატი/პროვინცია.
  • 404: No prefixes found: კატალოგის შესაბამისი სტრიქონები არ დაბრუნებულა. ეს არ ამტკიცებს, რომ კონკრეტული ნომრის შეკვეთა არასოდეს იქნება შესაძლებელი.
  • 500: შეცდომა: 'Failed loading prefixes': კატალოგში ძიება ვერ შესრულდა. მოგვიანებით სცადეთ ხელახლა და, თუ პრობლემა გაგრძელდება, დაუკავშირდით მხარდაჭერის სამსახურს.

ხელმისაწვდომობა და თანმდევი მოქმედებები

  • ეს მოძიების ეტაპია და არა შეკვეთის დადასტურება. ხელმისაწვდომობა შესაძლოა კატალოგში დამატებითი ძიებებით განახლდეს, ამიტომ პასუხის მიღების დრო შეიძლება განსხვავდებოდეს.
  • ფასები არ ბრუნდება. შეკვეთის განთავსებამდე მიიღეთ შესაბამისი ნომრის ან შეკვეთის საფასო შეთავაზება და გაეცანით რეგისტრაციის მოთხოვნებს.
  • ნუ მიიჩნევთ available-ს მარაგის ზუსტ რაოდენობად, ნულს — შეკვეთის საყოველთაო აკრძალვად, ხოლო წარმატებულ ძიებას — დაჯავშნად. შეკვეთამდე ხელმისაწვდომობა შეიძლება შეიცვალოს.