นักพัฒนา

GET/v3/numberinfo/{number}

อ่านข้อมูลหมายเลขที่ซื้อไว้หนึ่งหมายเลข

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

ในหน้านี้
  1. คำขอ
  2. การตอบกลับ
  3. ไม่พบหมายเลขที่ตรงกัน
  4. การใช้ผลลัพธ์

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

คำขอ

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

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

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

การตอบกลับ

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

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "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",
      "perminute_charges": "0"
    },
    "needs_registration": "0",
    "vrating": "",
    "country_id": "COUNTRY_REFERENCE",
    "area_id": "AREA_REFERENCE",
    "provider_id": "OPAQUE_LEGACY_REFERENCE"
  }
}
ฟิลด์ข้อมูลหมายเลขที่ส่งคืน
ฟิลด์ความหมาย
number, uuid, description, isocodeหมายเลขโทรศัพท์ ตัวระบุหมายเลขที่ไม่ควรตีความโครงสร้างภายใน คำอธิบาย และรหัสประเทศที่จัดเก็บไว้
configฟิลด์ปลายทางการโทรด้วยเสียง การโอนสายไปยังภายนอก ปลายทาง SMS และการส่งต่อ SMS ที่จัดเก็บไว้ เอนด์พอยต์นี้ไม่แก้ไขฟิลด์เหล่านี้
featuresแฟล็กความสามารถด้านการโทรด้วยเสียง SMS และ MMS ที่จัดเก็บไว้ ไม่รับประกันว่าแฟล็กแบบเดิมที่จัดเก็บไว้จะเป็นค่าบูลีนของ JSON
status.capacityค่าจำนวนช่องสัญญาณที่จัดสรรและใช้งานอยู่ การตั้งค่าการรองรับส่วนเกิน และค่าบริการส่วนเกินที่จัดเก็บไว้ ข้อมูลนี้เป็นเมทาดาทาที่จัดเก็บไว้ ไม่ใช่ใบเสนอราคาความจุที่จัดทำขึ้นใหม่หรือการทดสอบการโทรจริง
status.originationเมทาดาทาด้านต้นทางการโทรที่จัดเก็บไว้ ให้ใช้ตัวระบุโดยไม่ตีความโครงสร้างภายใน และอย่าใช้ชื่อภายในเป็นพื้นฐานในการกำหนดตรรกะของแอปพลิเคชัน
status.service_active, force_codec, force_dtmfฟิลด์การเปิดใช้งานและการกำหนดค่าสื่อที่จัดเก็บไว้ แฟล็กเพียงอย่างเดียวไม่ยืนยันว่าการรับสายหรือข้อมูลขาเข้าจะสำเร็จ
billingค่า CNAM การรองรับส่วนเกิน การต่ออายุ การคงสถานะ และการสร้างที่จัดเก็บไว้ การอ่านค่าเหล่านี้ไม่เปลี่ยนการตั้งค่าการต่ออายุหรือการเรียกเก็บเงินอื่น ๆ
priceราคาเริ่มต้นใช้งาน ราคารายเดือน ราคาต่อนาที และจำนวนนาทีที่ให้ใช้ได้ซึ่งจัดเก็บไว้ ตัวจัดการนี้ไม่ส่งคืนฟิลด์สกุลเงินหรือใบเสนอราคาที่จัดทำขึ้นใหม่ อย่าอนุมานสกุลเงินจากค่าตัวอย่างหรือใช้ค่าเหล่านี้เป็นใบเสนอราคาซื้อปัจจุบัน

เมื่อเทียบกับ inventory, เอนด์พอยต์นี้ยังส่งคืน needs_registration, vrating, country_id, area_id, provider_id และ price.perminute_charges ค่าเหล่านี้เป็นค่าแบบเดิมที่จัดเก็บไว้ ไม่ใช่การตอบกลับการอนุมัติยืนยันตัวตนแยกต่างหาก ควรใช้รหัสอ้างอิงโดยไม่ตีความโครงสร้างภายใน อย่าสร้าง URL สำหรับการค้นหาข้อมูลหรืออนุมานความสัมพันธ์กับผู้ให้บริการจากรหัสเหล่านี้โดยไม่มีการตอบกลับจากการค้นหาข้อมูลที่เหมาะสม

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

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

การใช้ผลลัพธ์

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