Đọc các yêu cầu đăng ký

Chọn quốc gia và loại số

Chọn một quốc gia đăng ký, sau đó sử dụng một tên được trả về bởi get_document_number_types. Gửi tên đó dưới dạng number_type, không phải ID loại hay một danh mục tìm số chung.

Đọc các hướng dẫn được trả về

Hãy lưu giữ các ID yêu cầu và ID quan hệ cho quy trình danh tính/tài liệu liên quan. Lệnh gọi này trả về các yêu cầu; nó không xác thực hay gửi tệp của bạn. Hãy làm theo các hướng dẫn được trả về và mọi yêu cầu riêng cho số đã chọn.

Không diễn giải lỗi là một sự miễn trừ

Lỗi về quốc gia không hợp lệ hoặc không có tài liệu đăng ký của quốc gia gộp hai điều kiện lại với nhau. Đó không phải là bằng chứng cho thấy việc đăng ký là không cần thiết. Việc tra cứu thất bại hoặc kết quả trống cũng không phê duyệt một khách hàng hay một số. Hãy liên hệ bộ phận hỗ trợ nếu kết quả không rõ ràng.

Yêu cầu

Sử dụng thông tin xác thực của tài khoản API đã được bậ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 bật; các hạn chế của tài khoản vẫn được áp dụng.

POST với application/json hoặc application/x-www-form-urlencoded.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  --request POST \
  --header "Content-Type: application/json" \
  --data '{"country":"US","number_type":"Local"}' \
  "https://api.multitel.net/v3/get_requirements"

Tham số phần thân
Tên	Kiểu	Bắt buộc	Mô tả
`country`	chuỗi	Có	Mã ISO của quốc gia từ get_document_countries.
`number_type`	chuỗi	Có	Tên loại từ get_document_number_types, chẳng hạn Local; việc so khớp không phân biệt chữ hoa chữ thường. Hãy cung cấp tên, không phải ID của nó.

Phản hồi

Kiểm tra status.code trong phần thân JSON cũng như trạng thái HTTP. response là một tài nguyên yêu cầu duy nhất với id, type và attributes, cùng với relationships khi được trả về. Các ID trong tài nguyên và dữ liệu quan hệ là giá trị không rõ nghĩa, không nên diễn giải. Văn bản restriction_message tùy chọn đã được loại bỏ các thẻ HTML; hãy xử lý văn bản còn lại như văn bản thuần, không phải HTML đáng tin cậy. Trình xử lý trả về tài nguyên yêu cầu đầu tiên, vì vậy đừng suy luận rằng phản hồi này là một danh sách đầy đủ. Sự sẵn có của thuộc tính/quan hệ phụ thuộc vào quốc gia và loại; ví dụ không phải là một lược đồ cố định hoàn chỉnh.

Hình dạng phản hồi mang tính minh họa; không phải dữ liệu tài khoản thực hay báo giá hiện tại.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "id": "REQUIREMENT_ID_FROM_RESPONSE",
    "type": "RESOURCE_TYPE_FROM_RESPONSE",
    "attributes": {
      "restriction_message": "Example country-specific instructions."
    }
  }
}

Lỗi

400: Việc xác thực quốc gia và number_type thất bại: hãy cung cấp cả hai giá trị bắt buộc. Văn bản xác thực có thể chứa định dạng.
400: Invalid country ISO or No country registration documents required.: thông báo mơ hồ này tự nó không chứng minh được sự miễn trừ đăng ký.
400: Invalid number type: hãy sử dụng một tên loại được trả về. Lỗi cũ liệt kê Global, Local, Mobile, National, Shared Cost và Toll Free.
500: Unable to load registration requirements for the specified country and number type.: các yêu cầu đã không được trả về thành công. Hãy thử lại sau hoặc liên hệ bộ phận hỗ trợ.

Tính khả dụng và tác dụng phụ

Việc tra cứu danh mục/yêu cầu này không tạo danh tính, không tải lên bằng chứng, không đăng ký số và không đặt đơn hàng.
Một phản hồi danh mục thành công không phải là sự phê duyệt tài liệu của bạn, cũng không phải là xác nhận rằng số đã chọn có thể được kích hoạt.