Liệt kê các mẫu tài liệu bổ trợ

Duyệt danh mục mẫu

Bỏ đoạn đường dẫn ISO tùy chọn để liệt kê các mẫu do dịch vụ trả về. Cung cấp mã ISO quốc gia để lọc danh sách. Bộ lọc đối chiếu với thông tin gợi ý về quốc gia của mẫu; thông tin này có thể được suy ra từ tên và có thể để trống.

Chọn mẫu dựa trên các yêu cầu

Việc một mẫu có trong danh sách không có nghĩa là mẫu đó bắt buộc hoặc được chấp nhận cho mọi số điện thoại tại quốc gia đó. Đối chiếu ID mẫu với các yêu cầu về tài liệu bổ trợ được áp dụng. Danh sách này không tạo, ký, tải lên hay phê duyệt tài liệu đã hoàn thiện.

Nếu không có mẫu nào được trả về

Danh sách đã lọc trống có thể có nghĩa là không tìm thấy thông tin gợi ý về quốc gia phù hợp. Danh sách chưa lọc trống cũng có thể phản ánh việc dữ liệu từ nguồn thượng nguồn không khả dụng. Không coi bất kỳ kết quả nào trong hai trường hợp này là bằng chứng cho thấy không cần tài liệu bổ trợ.

Xem xét bản sao đã tải xuống trước khi sử dụng

Liên kết tải xuống trong danh mục có thể trả về bản sao đã được thay đổi định dạng hoặc nhận diện thương hiệu. Không mặc định rằng đó là thỏa thuận gốc chưa bị thay đổi hoặc việc tải xuống đã đáp ứng một yêu cầu đăng ký. Xem xét nội dung trước khi điền hoặc ký bất kỳ tài liệu nào.

Khi trình hướng dẫn tài liệu trên cổng thông tin có chức năng chuẩn bị thỏa thuận, hãy sử dụng chức năng xem trước và quy trình gửi có bước xác nhận rõ ràng của công cụ đó. Đối với các biểu mẫu bắt buộc khác, hãy xác nhận biểu mẫu hiện hành với MultiTEL trước khi điền. Mẫu đã tải xuống không phải là tệp đính kèm đã ký, giấy tờ chứng minh đã tải lên hay sự phê duyệt cho một số điện thoại.

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ế đối với tài khoản vẫn áp dụng.

Sử dụng GET với bất kỳ tham số nào được mô tả trong tài liệu, đặt trong đường dẫn URL.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_supporting_document_templates/$COUNTRY_ISO"

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 mảng các đối tượng có các trường id, name, permanent, iso và url. permanent có kiểu boolean; iso có thể để trống và có thể đã được suy ra từ tên mẫu. Hãy coi thông tin quốc gia là thông tin gợi ý, không phải quyết định về việc đáp ứng điều kiện. Danh mục trống là một phản hồi thành công 200 và cũng có thể xuất hiện khi việc tra cứu ở nguồn thượng nguồn không trả về dữ liệu. URL do dịch vụ tạo ra; tên máy chủ của URL có thể khác với ví dụ minh họa.

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": 1
  },
  "response": [
    {
      "id": "TEMPLATE_ID_FROM_RESPONSE",
      "name": "Example supporting-document template",
      "permanent": false,
      "iso": "US",
      "url": "https://api.multitel.net/v3/supporting_document/TEMPLATE_ID_FROM_RESPONSE"
    }
  ]
}

Lỗi

• Kiểm tra status.code và status.msg để biết lỗi xác thực hoặc lỗi dịch vụ. Danh mục trống được trả về thành công không phải là sự phê duyệt tài liệu hay miễn trừ yêu cầu đăng ký.

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

• Việc tra cứu danh mục/yêu cầu này không tạo danh tính, tải lên giấy tờ chứng minh, đăng ký số điện thoại hay đặt đơn hàng.
• 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 hay xác nhận rằng số điện thoại đã chọn có thể được kích hoạt.