Nhà phát triển

GET/v3/getcountries

Liệt kê các quốc gia hiện có số điện thoại sẵn trong kho

Trả về các quốc gia được phép hiển thị hiện có ít nhất một đầu số còn số điện thoại trong kho. Mỗi mục bao gồm mã gọi quốc gia, mã ISO, các cờ di động và SMS ở cấp quốc gia, tọa độ và liên kết next_function đến các khu vực cung cấp dịch vụ của quốc gia đó.

Trên trang này
  1. Yêu cầu
  2. Phản hồi
  3. Lỗi
  4. Tình trạng sẵn có và tác động phụ

Bắt đầu tìm kiếm số điện thoại địa phương tại đây. Danh sách chỉ bao gồm các quốc gia hiện có số điện thoại sẵn trong kho. Thao tác này không giữ chỗ bất cứ thứ gì.

  • Truyền isocode cho getareas, cho getstates (chỉ dành cho US và CA) hoặc cho other.
  • next_function luôn trỏ đến v3/getareas/{isocode}. Đối với Hoa Kỳ và Canada, bạn có thể gọi getstates trước để thu hẹp phạm vi theo tiểu bang hoặc tỉnh.
  • is_mobile và sms_coverage là các cờ ở cấp quốc gia, không phải là sự bảo đảm cho từng số điện thoại. Đối với Hoa Kỳ, is_mobile có giá trị 0 trừ khi tài khoản của bạn đã được bật quyền sử dụng số di động Hoa Kỳ.
  • Các quốc gia chỉ cung cấp số theo đơn đặt hàng không được liệt kê. Bạn vẫn có thể gọi getareas hoặc other trực tiếp cho một quốc gia không có trong danh sách.
  • Hãy tự sắp xếp danh sách nếu bạn cần một thứ tự cụ thể.

Nếu không có quốc gia nào đáp ứng điều kiện, response có giá trị null và status.code có giá trị 200.

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.

GET không có phần thân yêu cầu. Tham số duy nhất là pid không bắt buộc, được gửi trong chuỗi truy vấn.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getcountries'
Tham số truy vấn
TênKiểuBắt buộcMô tả
pidstringKhôngĐây là tham số nâng cao và không bắt buộc. Tham số này thu hẹp danh sách xuống các quốc gia được đánh dấu cho một nguồn kho số. Chỉ sử dụng giá trị do MultiTEL cung cấp, ở dạng số hoặc dạng thập lục phân gồm 32 ký tự, và bỏ qua tham số này khi sử dụng thông thường. pid không thu hẹp phạm vi kiểm tra số có sẵn trong kho được mô tả ở phần phản hồi. Các giá trị không được nhận diện, giá trị không và các giá trị mà điểm cuối này không chấp nhận đều bị bỏ qua mà không báo lỗi; khi đó danh sách bao gồm tất cả các nguồn được hỗ trợ.

Phản hồi

Sử dụng cấu trúc bao ngoài tiêu chuẩn. Khi thành công, status.code có giá trị 200, status.msg có giá trị 'Results: N', status.results có giá trị N và response là danh sách các quốc gia không được bảo đảm về thứ tự. Các trường: countrycode (mã gọi quốc gia không có dấu '+'); name (tên quốc gia); description (có cùng giá trị với name); isocode (mã ISO 3166-1 alpha-2); is_mobile (0 hoặc 1, cờ danh mục ở cấp quốc gia, 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 US); sms_coverage (0 hoặc 1, cờ danh mục ở cấp quốc gia); latitude và longitude (tọa độ quốc gia); next_function ('v3/getareas/{isocode}'). Một quốc gia chỉ được liệt kê nếu được phép hiển thị và hiện có ít nhất một đầu số còn số điện thoại trong kho tại bất kỳ nguồn kho số nào. Các quốc gia chỉ cung cấp số hoàn toàn theo đơn đặt hàng (không có số sẵn trong kho) không được liệt kê. Phạm vi kiểm tra số có sẵn trong kho này rộng hơn các bộ lọc mà getareas áp dụng, vì vậy đôi khi một quốc gia có trong danh sách có thể nhận được kết quả 'No areas found' khi tra cứu tại đó. Nếu không có quốc gia nào đáp ứng điều kiện, status.code có giá trị 200, status.msg có giá trị 'Results: 0', không có trường status.results và response có giá trị null.

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 tại.

{
  "status": {
    "code": 200,
    "msg": "Results: 2",
    "results": 2
  },
  "response": [
    {
      "countrycode": "1",
      "name": "United States",
      "description": "United States",
      "isocode": "US",
      "is_mobile": 0,
      "sms_coverage": 1,
      "latitude": "38.0000",
      "longitude": "-97.0000",
      "next_function": "v3/getareas/US"
    },
    {
      "countrycode": "44",
      "name": "United Kingdom",
      "description": "United Kingdom",
      "isocode": "GB",
      "is_mobile": 1,
      "sms_coverage": 0,
      "latitude": "54.0000",
      "longitude": "-2.0000",
      "next_function": "v3/getareas/GB"
    }
  ]
}

Lỗi

  • 401: Thiếu thông tin xác thực hoặc xác thực thất bại. Được trả về cùng mã trạng thái HTTP 401 (xem phần Xác thực và phản hồi API).

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

  • Chỉ thực hiện tra cứu. Thao tác này không giữ chỗ, đặt hàng hay thay đổi bất cứ thứ gì.
  • Kết quả phản ánh số điện thoại có sẵn trong kho tại thời điểm gửi yêu cầu và có thể thay đổi giữa các lần gọi.