แสดงรายชื่อรัฐในสหรัฐอเมริกาหรือมณฑลในแคนาดาที่มีหมายเลขโทรศัพท์ในคลัง

ใช้ขั้นตอนเสริมนี้สำหรับสหรัฐอเมริกาหรือแคนาดาเพื่อจำกัดการค้นหาให้แคบลงตามรัฐหรือมณฑล ยอมรับเฉพาะ US และ CA เท่านั้น

• แต่ละรายการอธิบายเลขนำหน้าที่มีหมายเลขในคลังสำหรับรัฐนั้น ณ เวลาที่ส่งคำขอ
• ใช้ลิงก์ next_function เพื่อแสดงรายชื่อพื้นที่ของรัฐนั้น ลิงก์นี้มีตัวกรอง state อยู่แล้ว แต่ไม่มี pid.
• การค้นหาพื้นที่ใช้วิธีจับคู่ข้อมูลรัฐที่แตกต่างออกไปเล็กน้อย หากลิงก์ของรัฐ next_function ส่งคืน No areas found ให้เรียก getareas โดยไม่ระบุรัฐแทน
• ตรวจสอบ status.code ก่อนอ่าน response ประเทศที่ไม่รองรับหรือประเทศที่ไม่มีหมายเลขในคลังตรงตามเงื่อนไขจะส่งคืนรหัส 404 โดยไม่มีสถานะ HTTP ที่ตรงกัน
• รายการว่างพร้อมรหัส 200 หมายความว่ามีหมายเลขในคลัง แต่ไม่มีข้อมูลรัฐ ให้เรียก getareas โดยไม่ระบุรัฐ

คำขอ

จำเป็นต้องใช้การยืนยันตัวตนแบบ HTTP Basic หรือโทเค็น Bearer (ดูหัวข้อการยืนยันตัวตนและการตอบกลับของ API) หากยืนยันตัวตนไม่สำเร็จ ระบบจะตอบกลับด้วย HTTP 401 ก่อนดำเนินการค้นหา

ใช้ GET โดยมี isocode อยู่ในพาธ หากละส่วนนี้ของพาธ ระบบจะอ่านฟิลด์ isocode ที่เข้ารหัสแบบฟอร์มแทน ส่วน pid ซึ่งเป็นพารามิเตอร์เสริมจะส่งในสตริงการสืบค้น

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

การตอบกลับ

ใช้โครงสร้างห่อหุ้มมาตรฐาน เมื่อสำเร็จ status.code จะเป็น 200, status.msg จะว่าง และ status.results จะเป็นจำนวนรายการ response เป็นรายการที่เรียงตาม name (ไม่แยกตัวพิมพ์ใหญ่และตัวพิมพ์เล็ก) แล้วจึงเรียงตามรหัส state ฟิลด์ต่าง ๆ ได้แก่ state (รหัสรัฐหรือมณฑลที่นำมาจากข้อมูลรัฐของเลขนำหน้า โดยปกติเป็นตัวอักษรสองตัว ค่าที่ไม่พบบ่อยจะถูกส่งต่อโดยไม่เปลี่ยนแปลง); name (ชื่อในแค็ตตาล็อก หรือรหัสหากแค็ตตาล็อกไม่มีชื่อสำหรับรหัสนั้น); country_iso; available (จำนวนหมายเลขในคลังทั้งหมดของเลขนำหน้าที่นำมานับ ซึ่งมากกว่า 0 เสมอ); prefix_count (จำนวนเลขนำหน้าที่มีหมายเลขในคลังซึ่งนำมานับ); is_mobile (เป็น 1 หากมีเลขนำหน้าใดที่นำมานับรองรับโทรศัพท์มือถือ และเป็น 0 เสมอสำหรับ US เว้นแต่บัญชีของคุณจะเปิดใช้หมายเลขโทรศัพท์มือถือของสหรัฐอเมริกา); sms_coverage (เป็น 1 หากมีเลขนำหน้าใดที่นำมานับรองรับ SMS); returns_numbers (เป็น 1 หากมีเลขนำหน้าใดที่นำมานับมีแฟล็กการส่งคืนหมายเลข หรือไม่มีค่าสำหรับแฟล็กดังกล่าว); next_function ('v3/getareas/{isocode}?state={state}') หากมีเลขนำหน้าที่มีหมายเลขในคลัง แต่ไม่มีเลขนำหน้าใดมีข้อมูลรัฐ ผลลัพธ์จะมี status.code เป็น 200 พร้อมรายการว่าง และ status.results เป็น 0

โครงสร้างการตอบกลับนี้ใช้เพื่อประกอบคำอธิบาย ไม่ใช่ข้อมูลบัญชีแบบสดหรือใบเสนอราคาปัจจุบัน

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 2
  },
  "response": [
    {
      "state": "NY",
      "name": "New York",
      "country_iso": "US",
      "available": 120,
      "prefix_count": 8,
      "is_mobile": 0,
      "sms_coverage": 1,
      "returns_numbers": 1,
      "next_function": "v3/getareas/US?state=NY"
    },
    {
      "state": "TX",
      "name": "Texas",
      "country_iso": "US",
      "available": 45,
      "prefix_count": 3,
      "is_mobile": 0,
      "sms_coverage": 0,
      "returns_numbers": 1,
      "next_function": "v3/getareas/US?state=TX"
    }
  ]
}

ข้อผิดพลาด

• 500: msg 'ISO Code parameter is required': ไม่มี isocode หรือค่าว่าง นี่เป็นข้อผิดพลาดของคำขอที่แก้ไขได้ ระบบไม่ได้กำหนดสถานะ HTTP ที่ตรงกัน ให้อ่าน status.code
• 404: msg 'getstates is only available for US and CA': ใช้รหัสประเทศอื่นใดนอกเหนือจากที่รองรับ ระบบไม่ได้กำหนดสถานะ HTTP ที่ตรงกัน
• 404: msg 'No states found': ไม่มีเลขนำหน้าที่มีหมายเลขในคลังตรงกับตัวกรองประเทศและแหล่งคลัง ระบบไม่ได้กำหนดสถานะ HTTP ที่ตรงกัน
• 401: ไม่มีข้อมูลยืนยันตัวตนหรือยืนยันตัวตนไม่สำเร็จ ส่งพร้อมสถานะ HTTP 401

ความพร้อมใช้งานและผลกระทบที่เกิดขึ้น

• ใช้เพื่อค้นหาเท่านั้น ไม่มีการจอง สั่งซื้อ หรือเปลี่ยนแปลงสิ่งใด available ใช้เพื่อให้ข้อมูลและไม่ได้กันหมายเลขไว้ให้