Nhà phát triển

GET/v3/get_document_number_types/{country}

Liệt kê các loại số đăng ký

Tìm tên các loại số hiện có trong danh mục đăng ký của một quốc gia.

Trên trang này
  1. Chọn loại theo tên được trả về
  2. Số lượng nhóm không phải là lượng số điện thoại trong kho
  3. Yêu cầu
  4. Phản hồi
  5. Lỗi
  6. Khả năng cung cấp và các tác động phát sinh

Chọn loại theo tên được trả về

Sử dụng một quốc gia từ get_document_countries. Truyền tên loại được trả về cho get_requirements. ID của loại trong danh mục không phải là ID tiền tố, ID số điện thoại hay ID loại giấy tờ chứng minh.

Số lượng nhóm không phải là lượng số điện thoại trong kho

available_groups đếm các bản ghi nhóm được trả về từ lần tra cứu danh mục này. Giá trị này không đếm các số điện thoại có thể mua, không giữ chỗ số trong kho và không bảo đảm rằng danh mục đã lấy hết các trang từ nguồn dữ liệu phía trên. Hãy tìm kiếm trong kho số điện thoại phù hợp và xem xét báo giá riê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à 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 áp dụng.

Gửi yêu cầu GET với mọi tham số được mô tả trong tài liệu nằm trong đường dẫn URL.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_document_number_types/$COUNTRY_ISO"
Tham số đường dẫn
TênKiểuBắt buộcMô tả
countrystringCóMã ISO quốc gia gồm hai chữ cái lấy từ danh mục quốc gia đăng ký. Khoảng trắng ở đầu và cuối mã được loại bỏ, và mã được chuyển thành chữ hoa.

Phản hồi

Kiểm tra status.code trong phần nội dung JSON cũng như trạng thái HTTP. response là một mảng chứa id, name và available_groups. Sử dụng name làm number_type khi gọi get_requirements; không gửi id thay cho giá trị đó. available_groups là số bản ghi nhóm được trả về cho loại đó, không phải số lượng số điện thoại trong kho hay tổng số đầy đủ trên tất cả các trang. Các loại không có nhóm nào được trả về sẽ bị lược bỏ. Thứ tự ưu tiên là Local, Mobile, National, Toll Free, Shared Cost, Global, tiếp theo là các tên khác trong danh mục.

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "NUMBER_TYPE_ID_FROM_RESPONSE",
      "name": "Local",
      "available_groups": 3
    }
  ]
}

Lỗi

  • 400: country is required: cung cấp mã ISO của quốc gia đăng ký.
  • 400: Invalid country ISO or no available DID registration country found: chọn một quốc gia từ danh mục đăng ký hiện tại; điều này không có nghĩa là không cần giấy tờ.

Khả năng cung cấp và các tác động phát sinh

  • Việc tra cứu danh mục hoặc yêu cầu này không tạo hồ sơ danh tính, tải lên giấy tờ chứng minh, đăng ký số điện thoại hay đặt hàng.
  • Phản hồi danh mục thành công không có nghĩa là giấy tờ của bạn đã được phê duyệt hoặc số điện thoại đã chọn được xác nhận là có thể kích hoạt.