Liệt kê các tiền tố số điện thoại cho một khu vực

Trước khi bắt đầu

Chọn một khu vực bằng getareas. Sao chép ID khu vực từ phản hồi của thao tác đó hoặc từ giá trị được trả về trong next_function. Với khu vực thuộc Hoa Kỳ hoặc Canada, hãy dùng getstates nếu bạn muốn giới hạn kết quả trong một bang hoặc tỉnh.

Đọc kết quả

Kiểm tra status.code trong phần thân JSON cũng như mã trạng thái HTTP. Các kết quả thành công nằm trong mảng response. Theo mặc định, phản hồi được sắp xếp theo tên. available là giá trị ước tính, và các cờ trong danh mục không thay thế việc kiểm tra các khả năng thực tế và yêu cầu đăng ký của số điện thoại đã chọn.

Chọn bước tiếp theo

Sử dụng kết quả không phân nhóm. Khi returns_numbers bằng 1, next_function được trả về trỏ đến thao tác tìm kiếm số điện thoại. Khi giá trị đó bằng 0, số điện thoại được cấp khi đặt mua và đường dẫn trỏ đến một thao tác đặt mua. Hãy xem xét thao tác và các yêu cầu của thao tác đó trước khi gửi yêu cầu: yêu cầu đặt mua có thể khiến tài khoản của bạn bị tính phí. Không tự động gửi yêu cầu đến mọi đường dẫn được trả về.

Không có giá nào được cung cấp ở đây. Hãy xem báo giá liên quan, giấy tờ bắt buộc và hướng dẫn đặt mua trước khi mua. Giữ nguyên các ID của từng tiền tố và báo giá được trả về thay vì tự tạo chúng từ tiền tố điện thoại hiển thị.

Tùy chọn hiển thị nâng cao

compact=1 trả về một mẫu gồm tối đa 100 dòng với thứ tự được xáo trộn, không phải một trang của tập kết quả lớn hơn. Việc phân nhóm tạo ra các dòng tổng hợp và ID được tạo riêng cho nhóm; hãy dùng phản hồi thông thường không phân nhóm để chọn một tiền tố riêng lẻ. Không dùng kết quả lấy mẫu hoặc phân nhóm để khẳng định đã liệt kê toàn bộ kho số hoặc xác định chính xác các khả năng.

Yêu cầu

Sử dụng thông tin xác thực của tài khoản API đã được kích hoạt qua HTTPS. Hỗ trợ xác thực Basic và các mã thông báo bearer của tài khoản API đã được kích hoạt; các hạn chế của tài khoản vẫn được áp dụng.

Dùng GET và gửi các tham số tùy chọn trong chuỗi truy vấn. Không dựa vào cơ chế dự phòng nhận tham số từ phần thân biểu mẫu.

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

Phản hồi

Cấu trúc bao JSON status/response tiêu chuẩn. status.results đếm số dòng được trả về, kể cả khi lấy mẫu hoặc phân nhóm. response chứa các đối tượng tiền tố. Không có trường giá nào được trả về. Trong phản hồi thông thường không phân nhóm, uuid là ID tiền tố; area_uuid và country_uuid là các mã định danh được trả về; prefix và name là thông tin hiển thị; available là ước tính về tình trạng sẵn có, không phải việc giữ chỗ; needs_registration và restrictions mô tả thông tin đăng ký; sms_coverage, is_mobile và number_type là các thông tin gợi ý từ danh mục, không bảo đảm khả năng của một số điện thoại cụ thể. number_type có thể rỗng hoặc là một chuỗi khác trong danh mục, vì vậy không bắt buộc giá trị phải thuộc một tập giá trị liệt kê cố định. state là chuỗi và có thể rỗng hoặc chứa định dạng của danh mục. latitude và longitude có thể rỗng. metered và overflow là các cờ trong danh mục, không phải số tiền. returns_numbers chọn tuyến liệt kê số điện thoại (1) hoặc tuyến cấp số khi đặt mua (0). next_function xác định tuyến tiếp theo đó. Phản hồi phân nhóm còn chứa các tính năng đã được gộp, bao gồm các giá trị tính năng dự phòng; không diễn giải chúng là các khả năng đã được xác minh của mọi số điện thoại.

Cấu trúc phản hồi minh họa; không phải dữ liệu tài khoản thực tế theo thời gian thực hay báo giá hiện hành.

{
  "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"
    }
  ]
}

Lỗi

• 404: Invalid area ID: lấy ID khu vực hiện hành từ bước tra cứu.
• 404: State filter is only available for US and CA: bỏ qua state đối với các quốc gia khác.
• 404: Invalid state: dùng bang/tỉnh do getstates trả về cho quốc gia này.
• 404: No prefixes found: không có dòng danh mục phù hợp nào được trả về. Điều này không chứng minh rằng một số điện thoại cụ thể sẽ không bao giờ có thể được đặt mua.
• 500: Lỗi: 'Failed loading prefixes': tra cứu danh mục không thành công. Hãy thử lại sau và liên hệ bộ phận hỗ trợ nếu lỗi vẫn tiếp diễn.

Tình trạng sẵn có và tác động phát sinh

• Đây là bước tra cứu, không phải xác nhận đơn hàng. Tình trạng sẵn có có thể được cập nhật thông qua các lần tra cứu danh mục bổ sung, vì vậy độ trễ phản hồi có thể thay đổi.
• Giá không được trả về. Hãy lấy báo giá áp dụng cho số điện thoại hoặc đơn hàng và xem xét các yêu cầu đăng ký trước khi đặt mua.
• Không coi available là số lượng tồn kho chính xác, giá trị không là lệnh cấm đặt mua trong mọi trường hợp, hay việc tra cứu thành công là đã giữ chỗ. Tình trạng sẵn có có thể thay đổi trước khi đặt mua.