แสดงรายการเลขนำหน้าหมายเลขโทรศัพท์สำหรับพื้นที่

ก่อนเริ่มต้น

เลือกพื้นที่โดยใช้ getareas คัดลอก ID พื้นที่จากผลตอบกลับหรือจากค่าที่ส่งกลับใน next_function สำหรับพื้นที่ในสหรัฐอเมริกาหรือแคนาดา ให้ใช้ getstates หากต้องการจำกัดผลลัพธ์ให้เหลือเพียงรัฐหรือมณฑลเดียว

อ่านผลลัพธ์

ตรวจสอบ status.code ในเนื้อหา JSON ควบคู่กับสถานะ HTTP ผลลัพธ์ที่สำเร็จจะอยู่ในอาร์เรย์ response โดยค่าเริ่มต้น ผลตอบกลับจะเรียงตามชื่อ ค่า available เป็นค่าประมาณ และตัวบ่งชี้ในแค็ตตาล็อกไม่อาจใช้แทนการตรวจสอบความสามารถที่แท้จริงและข้อกำหนดการลงทะเบียนของหมายเลขที่เลือกได้

เลือกขั้นตอนถัดไป

ใช้ผลลัพธ์ที่ไม่ได้จัดกลุ่ม เมื่อ returns_numbers มีค่าเป็น 1 ค่า next_function ที่ส่งกลับจะชี้ไปยังการค้นหาหมายเลข เมื่อมีค่าเป็น 0 ระบบจะจัดสรรหมายเลขในขณะสั่งซื้อ และเส้นทางจะชี้ไปยังการดำเนินการสั่งซื้อ ตรวจสอบการดำเนินการและข้อกำหนดก่อนส่งคำขอ เนื่องจากคำขอสั่งซื้ออาจทำให้บัญชีของคุณถูกเรียกเก็บเงิน อย่าส่งคำขอไปยังทุกเส้นทางที่ส่งกลับโดยอัตโนมัติ

ไม่มีข้อมูลราคาในผลลัพธ์นี้ ตรวจสอบใบเสนอราคาที่เกี่ยวข้อง เอกสารที่จำเป็น และคำแนะนำในการสั่งซื้อก่อนซื้อ เก็บ ID ของเลขนำหน้าแต่ละรายการและ ID ใบเสนอราคาที่ส่งกลับไว้ แทนการสร้าง ID เหล่านี้จากเลขนำหน้าหมายเลขโทรศัพท์ที่แสดง

ตัวเลือกการแสดงผลขั้นสูง

compact=1 จะส่งกลับตัวอย่างที่สลับลำดับแล้วไม่เกิน 100 แถว ไม่ใช่หน้าหนึ่งของชุดผลลัพธ์ที่ใหญ่กว่า การจัดกลุ่มจะสร้างแถวสรุปและ ID ที่สร้างขึ้นเฉพาะสำหรับกลุ่ม ให้ใช้ผลตอบกลับปกติที่ไม่ได้จัดกลุ่มเพื่อเลือกเลขนำหน้าแต่ละรายการ อย่าใช้ผลลัพธ์แบบสุ่มตัวอย่างหรือแบบจัดกลุ่มเพื่ออ้างว่าเป็นรายการหมายเลขที่มีอยู่ทั้งหมดหรือระบุความสามารถได้อย่างแน่นอน

คำขอ

ใช้ข้อมูลรับรองของบัญชี API ที่เปิดใช้งานแล้วผ่าน HTTPS รองรับการยืนยันตัวตนแบบ Basic และโทเค็น bearer ของบัญชี API ที่เปิดใช้งานแล้ว โดยยังอยู่ภายใต้ข้อจำกัดของบัญชี

ใช้ GET และส่งพารามิเตอร์ทางเลือกในสตริงการสืบค้น อย่าพึ่งพาการใช้ข้อมูลฟอร์มในเนื้อหาคำขอเป็นทางเลือกสำรอง

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

ผลตอบกลับ

ใช้โครงสร้าง JSON มาตรฐานที่ครอบด้วย status/response ค่า 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 เป็นจำนวนหมายเลขคงเหลือที่แน่นอน ค่าศูนย์เป็นข้อห้ามสั่งซื้อในทุกกรณี หรือการค้นหาที่สำเร็จเป็นการจอง ความพร้อมใช้งานอาจเปลี่ยนแปลงก่อนสั่งซื้อ