Liệt kê các bang của Hoa Kỳ hoặc các tỉnh của Canada có số điện thoại còn trong kho

Sử dụng bước tùy chọn này cho Hoa Kỳ hoặc Canada để thu hẹp phạm vi tìm kiếm theo bang hoặc tỉnh. Chỉ chấp nhận US và CA.

• Mỗi mục mô tả các đầu số còn trong kho của bang đó tại thời điểm gửi yêu cầu.
• Truy cập next_function để liệt kê các khu vực của bang. Liên kết này đã bao gồm bộ lọc state nhưng chưa bao gồm pid.
• Chức năng tra cứu khu vực đối chiếu thông tin bang theo cách hơi khác. Nếu liên kết của bang next_function trả về No areas found, hãy gọi getareas mà không chỉ định bang để thay thế.
• Kiểm tra status.code trước khi đọc response. Quốc gia không được hỗ trợ hoặc quốc gia không có số lượng trong kho phù hợp sẽ trả về mã 404 mà không có trạng thái HTTP tương ứng.
• Danh sách rỗng kèm mã 200 có nghĩa là có số trong kho nhưng không có thông tin bang. Hãy gọi getareas mà không chỉ định bang.

Yêu cầu

Bắt buộc: xác thực HTTP Basic hoặc mã thông báo Bearer (xem phần Xác thực và phản hồi API). Nếu xác thực thất bại, hệ thống trả về HTTP 401 trước khi thực hiện tra cứu.

Dùng GET với isocode trong đường dẫn. Nếu bỏ qua đoạn đường dẫn này, hệ thống sẽ đọc trường isocode được mã hóa theo dạng biểu mẫu để thay thế. Tham số tùy chọn pid được gửi trong chuỗi truy vấn.

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

Phản hồi

Cấu trúc bao ngoài tiêu chuẩn. Khi thành công, status.code là 200, status.msg rỗng và status.results là số lượng mục. response là danh sách được sắp xếp theo name (không phân biệt chữ hoa, chữ thường), sau đó theo mã state. Các trường: state (mã bang hoặc tỉnh lấy từ dữ liệu bang của các đầu số, thường gồm hai chữ cái; các giá trị ít gặp được giữ nguyên khi trả về); name (tên trong danh mục, hoặc mã nếu danh mục không có tên cho mã đó); country_iso; available (tổng số lượng trong kho của các đầu số được tính, luôn lớn hơn 0); prefix_count (số lượng đầu số còn trong kho được tính); is_mobile (1 nếu có bất kỳ đầu số nào được tính hỗ trợ di động; luôn là 0 đối với US trừ khi tài khoản của bạn được bật quyền sử dụng số di động Hoa Kỳ); sms_coverage (1 nếu có bất kỳ đầu số nào được tính có hỗ trợ SMS); returns_numbers (1 nếu có bất kỳ đầu số nào được tính có cờ trả về số điện thoại hoặc không có giá trị cho cờ này); next_function ('v3/getareas/{isocode}?state={state}'). Nếu có đầu số còn trong kho nhưng không đầu số nào có thông tin bang, kết quả là status.code bằng 200 với danh sách rỗng và status.results bằng 0.

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

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

Lỗi

• 500: msg 'ISO Code parameter is required': isocode bị thiếu hoặc để trống. Đây là lỗi yêu cầu có thể sửa được. Không đặt trạng thái HTTP tương ứng; hãy đọc status.code.
• 404: msg 'getstates is only available for US and CA': mã quốc gia bất kỳ khác. Không đặt trạng thái HTTP tương ứng.
• 404: msg 'No states found': không có đầu số còn trong kho nào khớp với các bộ lọc quốc gia và nguồn. Không đặt trạng thái HTTP tương ứng.
• 401: Thiếu thông tin xác thực hoặc xác thực thất bại. Được gửi kèm trạng thái HTTP 401.

Tình trạng khả dụng và tác động phát sinh

• Chỉ dùng để tra cứu. Không giữ chỗ, đặt mua hay thay đổi bất kỳ điều gì. available chỉ cung cấp thông tin và không giữ số điện thoại.