นักพัฒนา

GET/v3/inventory/{number}

แสดงรายการหมายเลขโทรศัพท์ที่ซื้อไว้

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

ในหน้านี้
  1. คำขอ
  2. การตอบกลับ
  3. การกรองและการแบ่งหน้า
  4. ไม่พบหมายเลขโทรศัพท์ที่ตรงกัน
  5. ขั้นตอนถัดไป

แสดงรายการหมายเลขโทรศัพท์ที่ซื้อไว้ซึ่งข้อมูลเจ้าของที่จัดเก็บไว้ตรงกับบัญชีที่ข้อมูลรับรอง API ของคุณใช้ยืนยันตัวตน การมีรายการอยู่ไม่ได้หมายความว่าผ่านการทดสอบโทรจริงแล้ว

คำขอ

ใช้ข้อมูลรับรอง API ฝั่งเซิร์ฟเวอร์ผ่าน HTTPS ตัวอย่างอ่านข้อมูลรับรองจากตัวแปรสภาพแวดล้อม และไม่มีข้อมูลรับรองที่ใช้งานได้จริง ให้ตรวจสอบ status.code ในเนื้อหา JSON ควบคู่กับสถานะ HTTP ตัวจัดการรุ่นเก่าเหล่านี้ไม่ได้กำหนดสถานะข้อผิดพลาด HTTP สำหรับข้อผิดพลาดระดับแอปพลิเคชันอย่างสม่ำเสมอ

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/inventory"

หากต้องการกรองตามหมายเลขโทรศัพท์ที่จัดเก็บไว้เพียงหมายเลขเดียว ให้ใช้รูปแบบพาธทางเลือกดังนี้:

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/inventory/12025550100"

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

การตอบกลับ

สมาชิก response จะเป็นอาร์เรย์เสมอเมื่อสำเร็จ รวมถึงเมื่อใช้รูปแบบพาธสำหรับหมายเลขเดียวด้วย ส่วน status.results คือความยาวของอาร์เรย์

นี่คือตัวอย่างโครงสร้างการตอบกลับ ไม่ใช่ข้อมูลบัญชีหรือใบเสนอราคาปัจจุบัน

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "number": "12025550100",
      "uuid": "NUMBER_UUID",
      "description": "Main reception",
      "isocode": "US",
      "config": {
        "uri": "sip:reception@example.com",
        "uri2": "",
        "uri3": "",
        "forward_destination": "",
        "sms_uri": "",
        "sms_forward_destination": ""
      },
      "features": {
        "voice": "1",
        "sms": "1",
        "mms": "0"
      },
      "status": {
        "capacity": {
          "assigned_channels": "2",
          "used_channels": "0",
          "overflow": "0",
          "overage_charge": "0.01"
        },
        "origination": {
          "origination_trunk_id": "ORIGINATION_ID",
          "origination_trunk_name": "ORIGINATION_NAME",
          "origination_country_iso": "US",
          "origination_continent_iso": "NA",
          "origination_continent_name": "North America"
        },
        "service_active": "1",
        "force_codec": "",
        "force_dtmf": ""
      },
      "billing": {
        "cnam": "0",
        "overflow": "0",
        "autorenew": "1",
        "persistent": "0",
        "date_created": "2026-01-01 00:00:00"
      },
      "price": {
        "setup_price": "0.00",
        "monthly_price": "1.00",
        "per_minute": "0.01",
        "free_minutes": "0",
        "remaining_minutes": "0"
      }
    }
  ]
}
ฟิลด์ข้อมูลหมายเลขโทรศัพท์ที่ส่งกลับ
ฟิลด์ความหมาย
number, uuid, description, isocodeหมายเลขโทรศัพท์ ตัวระบุหมายเลขโทรศัพท์ที่ไม่ควรตีความโครงสร้างภายใน คำอธิบาย และรหัสประเทศที่จัดเก็บไว้
configฟิลด์ปลายทางการโทรด้วยเสียง การโอนสายไปภายนอก ปลายทาง SMS และการส่งต่อ SMS ที่จัดเก็บไว้ จุดปลาย API นี้ไม่ได้แก้ไขฟิลด์เหล่านี้
featuresแฟล็กความสามารถในการโทรด้วยเสียง SMS และ MMS ที่จัดเก็บไว้ ไม่รับประกันว่าแฟล็กที่จัดเก็บไว้ในระบบรุ่นเก่าจะเป็นค่าบูลีนของ JSON
status.capacityค่าจำนวนช่องสัญญาณที่จัดสรรและที่ใช้งาน การตั้งค่าการรองรับส่วนเกิน และค่าบริการส่วนเกินที่จัดเก็บไว้ ข้อมูลนี้เป็นข้อมูลเมตาที่จัดเก็บไว้ ไม่ใช่ใบเสนอราคาความจุที่จัดทำขึ้นใหม่หรือผลการทดสอบโทรจริง
status.originationข้อมูลเมตาต้นทางการโทรที่จัดเก็บไว้ ให้ใช้ตัวระบุโดยไม่ตีความโครงสร้างภายใน และอย่าใช้ชื่อภายในเป็นพื้นฐานในการกำหนดตรรกะของแอปพลิเคชัน
status.service_active, force_codec, force_dtmfฟิลด์การเปิดใช้งานและการตั้งค่าสื่อที่จัดเก็บไว้ แฟล็กเพียงอย่างเดียวไม่ได้ยืนยันว่าการส่งสายเข้าถึงปลายทางสำเร็จ
billingค่า CNAM การรองรับส่วนเกิน การต่ออายุ การคงอยู่ และการสร้างที่จัดเก็บไว้ การอ่านค่าเหล่านี้ไม่เปลี่ยนการตั้งค่าการต่ออายุหรือการเรียกเก็บเงินอื่น ๆ
priceค่าบริการเริ่มต้น ค่าบริการรายเดือน ค่าบริการต่อนาที และสิทธิจำนวนนาทีที่จัดเก็บไว้ ตัวจัดการไม่ได้ให้ฟิลด์สกุลเงินหรือใบเสนอราคาที่จัดทำขึ้นใหม่ อย่าอนุมานสกุลเงินจากค่าตัวอย่างหรือใช้ค่าเหล่านี้เป็นใบเสนอราคาสำหรับการซื้อในปัจจุบัน

การกรองและการแบ่งหน้า

ตัวจัดการนี้ไม่มีการแบ่งหน้า ขีดจำกัดจำนวนรายการต่อหน้า หรือลำดับการเรียงที่กำหนดไว้อย่างชัดเจน โดยส่งกลับทุกรายการที่ไม่ได้ถูกยกเลิกและถูกเลือกโดยคำสั่งค้นหา ไม่มีตัวกรองเฉพาะหมายเลขที่บริการเปิดใช้งานอยู่ หรือมุมมองแยกสำหรับหมายเลขที่เก็บถาวร อย่าสันนิษฐานว่าลำดับของรายการที่ส่งกลับจะคงเดิมเสมอ

ไม่พบหมายเลขโทรศัพท์ที่ตรงกัน

หากบัญชีไม่มีรายการที่ตรงกันซึ่งไม่ได้ถูกยกเลิก เนื้อหา JSON จะมี status.code เป็น 404 และมีข้อความที่ประกอบด้วย no numbers found โดยไม่ได้ส่งกลับอาร์เรย์ว่างพร้อมสถานะสำเร็จ ข้อความมีส่วนต่อท้ายที่อ้างอิงตำแหน่งในซอร์สโค้ด ซึ่งไคลเอนต์ไม่ควรแยกวิเคราะห์เพื่อนำไปใช้เป็นตัวระบุที่คงที่

ขั้นตอนถัดไป

ใช้ numberinfo เมื่อต้องการฟิลด์การลงทะเบียนและฟิลด์อ้างอิงหมายเลขเพิ่มเติมของระบบรุ่นเก่าสำหรับหมายเลขเดียว ตรวจสอบปลายทางการโทรด้วยเสียงและการรับส่งข้อความก่อนเปลี่ยนเส้นทางใด ๆ ผ่านการดำเนินการตั้งค่าที่แยกต่างหาก