Nhà phát triển

GET/v3/inventory/{number}

Liệt kê danh sách số điện thoại đã mua

Đọc cấu hình và trạng thái đã lưu của các số điện thoại đã mua, có thể lọc theo số điện thoại.

Trên trang này
  1. Yêu cầu
  2. Phản hồi
  3. Lọc và phân trang
  4. Không có số điện thoại phù hợp
  5. Các bước tiếp theo

Liệt kê các bản ghi số điện thoại đã mua có chủ sở hữu đã lưu khớp với tài khoản tương ứng với thông tin xác thực API của bạn. Sự hiện diện của một bản ghi không đồng nghĩa với việc thử nghiệm cuộc gọi thực tế đã thành công.

Yêu cầu

Sử dụng thông tin xác thực API ở phía máy chủ qua HTTPS. Các ví dụ đọc thông tin xác thực từ biến môi trường; chúng không chứa thông tin xác thực có thể sử dụng thực tế. Kiểm tra status.code trong nội dung JSON cũng như trạng thái HTTP. Các trình xử lý cũ này không phải lúc nào cũng đặt trạng thái lỗi HTTP khi xảy ra lỗi ứng dụng.

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

Để lọc theo một số điện thoại đã lưu, hãy sử dụng dạng đường dẫn tùy chọn:

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

Sử dụng số điện thoại quốc tế đã lưu dưới dạng các chữ số, bao gồm mã quốc gia. Không truyền số máy lẻ PBX, UUID của số điện thoại, ID khu vực hoặc ID tiền tố để thay thế. Số điện thoại được cung cấp dùng để chọn một bản ghi hiện có; thao tác này không mua hay cấu hình số điện thoại.

Phản hồi

Thành phần response luôn là một mảng khi yêu cầu thành công, kể cả khi sử dụng dạng đường dẫn cho một số điện thoại. status.results là độ dài của mảng.

Đây là cấu trúc phản hồi minh họa, không phải dữ liệu tài khoản hay báo giá hiện hành.

{
  "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"
      }
    }
  ]
}
Các trường của số điện thoại được trả về
TrườngÝ nghĩa
number, uuid, description, isocodeSố điện thoại đã lưu, mã định danh số điện thoại không mang ý nghĩa để diễn giải, mô tả và mã quốc gia.
configCác trường đã lưu về đích cuộc gọi thoại, chuyển tiếp ra bên ngoài, đích SMS và chuyển tiếp SMS. Điểm cuối này không chỉnh sửa các trường đó.
featuresCác cờ khả năng hỗ trợ thoại, SMS và MMS đã lưu. Các cờ được lưu theo cơ chế cũ không được đảm bảo là giá trị boolean JSON.
status.capacityCác giá trị về kênh đã cấp và đang sử dụng, cài đặt xử lý vượt số kênh và phí vượt mức đã lưu. Đây là siêu dữ liệu đã lưu, không phải báo giá dung lượng mới hay kết quả thử nghiệm cuộc gọi thực tế.
status.originationSiêu dữ liệu về nguồn khởi phát cuộc gọi đã lưu. Hãy coi các mã định danh là những giá trị không mang ý nghĩa để diễn giải; không suy ra logic ứng dụng từ các tên nội bộ.
status.service_active, force_codec, force_dtmfCác trường kích hoạt và cấu hình phương tiện đã lưu. Chỉ riêng một cờ không chứng minh rằng cuộc gọi đến được chuyển tới đích thành công.
billingCác giá trị đã lưu về CNAM, xử lý vượt số kênh, gia hạn, duy trì và tạo bản ghi. Việc đọc các giá trị này không thay đổi cài đặt gia hạn hay các cài đặt thanh toán khác.
priceCác mức giá thiết lập/hằng tháng/theo phút và hạn mức phút đã lưu. Trình xử lý không cung cấp trường đơn vị tiền tệ hay báo giá mới. Không suy ra đơn vị tiền tệ từ các giá trị mẫu hoặc dùng chúng làm báo giá mua hiện hành.

Lọc và phân trang

Trình xử lý này không có chức năng phân trang, giới hạn kích thước trang hay thứ tự sắp xếp được quy định rõ. Nó trả về tất cả các bản ghi chưa bị hủy được truy vấn của nó chọn ra. Nó không cung cấp bộ lọc chỉ lấy các số có dịch vụ đang hoạt động hay chế độ xem riêng cho các số đã lưu trữ. Không giả định rằng thứ tự các bản ghi được trả về là ổn định.

Không có số điện thoại phù hợp

Nếu tài khoản không có bản ghi nào phù hợp và chưa bị hủy, nội dung JSON có status.code 404 và một thông báo chứa no numbers found. Trình xử lý không trả về một mảng rỗng với trạng thái thành công. Thông báo có hậu tố tham chiếu đến mã nguồn mà ứng dụng khách không nên phân tích để dùng làm mã định danh ổn định.

Các bước tiếp theo

Sử dụng numberinfo khi bạn cần các trường bổ sung về đăng ký theo cơ chế cũ và tham chiếu số điện thoại cho một số điện thoại. Kiểm tra các đích cuộc gọi thoại và tin nhắn trước khi thay đổi bất kỳ tuyến nào thông qua một thao tác cấu hình riêng biệt.