Tải các danh mục đăng ký nhắn tin

Tải các lựa chọn trước khi xây dựng biểu mẫu đăng ký

Sử dụng danh mục đăng ký nhắn tin hiện hành để điền các lựa chọn thay vì ghi cố định các giá trị của cơ quan đăng ký trong mã. Với biểu mẫu thương hiệu, cổng thông tin tải các danh mục loại hình doanh nghiệp, ngành nghề, loại mã định danh doanh nghiệp thay thế, quan hệ với thương hiệu, quốc gia, tiểu bang Hoa Kỳ và sàn giao dịch chứng khoán. Với biểu mẫu chiến dịch, cổng tải các mục đích sử dụng, mục đích sử dụng phụ hợp lệ và đối tác kết nối. Giữ mỗi giá trị dành cho máy được trả về cùng với nhãn hiển thị của nó; khi tạo yêu cầu sau này, hãy dùng giá trị đó, không dùng nhãn đã dịch.

Chọn danh mục

Xử lý trực tiếp phản hồi của TCR

Nội dung phản hồi đến trực tiếp từ API của TCR. Khác với nhiều điểm cuối cũ thuộc /v3, phản hồi này không được bọc thêm trong lớp status/response. Kiểm tra trạng thái HTTP trước khi diễn giải nội dung. Danh mục có thể chứa nhãn dạng chuỗi hoặc định nghĩa có cấu trúc, vì vậy đừng mặc định rằng mọi giá trị đều có các trường giống nhau. Nếu yêu cầu HTTP thành công nhưng nội dung không phải là JSON hợp lệ với cấu trúc mong đợi, hãy báo tra cứu thất bại thay vì âm thầm thay thế bằng danh sách rỗng.

Tách biệt các lựa chọn trong danh mục với việc xác định điều kiện và giá

Danh mục mục đích sử dụng chung không cho biết một thương hiệu cụ thể đủ điều kiện cho những mục đích sử dụng nào. Cổng thông tin hiện tại tra cứu điều kiện riêng của thương hiệu trước khi tạo chiến dịch và kiểm tra các yêu cầu của nhà mạng đã chọn. Tương tự, siêu dữ liệu về phí của nhà cung cấp không phải là giá bán lẻ cuối cùng áp dụng cho tài khoản. Hãy xem xét riêng mức giá áp dụng cho tài khoản và các điều khoản đăng ký. Việc tải danh mục không đồng nghĩa với việc phê duyệt thương hiệu, chiến dịch hay số nhắn tin.

Xử lý khi danh mục không khả dụng

Giữ nguyên dữ liệu khách hàng đã nhập vào biểu mẫu nếu tra cứu thất bại. Hiển thị lỗi, tuân thủ Retry-After khi giá trị này được trả về và tăng dần thời gian chờ giữa các lần thử lại. Không liên tục tải lại mọi danh mục hoặc coi lỗi giới hạn tần suất hay lỗi truyền tải là một danh mục rỗng hợp lệ. Yêu cầu GET này không cần khóa chống xử lý trùng lặp và không được phát lại từ kho chống xử lý trùng lặp dành cho các thao tác thay đổi dữ liệu.

Yêu cầu

Sử dụng tài khoản API đã được bật qua HTTPS từ địa chỉ IP nguồn được phép. Tuyến hiện tại hỗ trợ chính sách xác thực tài khoản, bao gồm xác thực Basic và các tài khoản API dùng mã thông báo mang theo đã được bật. Không sử dụng thông tin xác thực của nhà cung cấp.

Gửi yêu cầu GET với tên danh mục được hỗ trợ trong đường dẫn. Truyền các bộ lọc danh mục áp dụng trong chuỗi truy vấn. Không cần nội dung yêu cầu.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/enum/usecase?validSubUsecase=true"

Phản hồi

Tuyến TCR này trả về trực tiếp nội dung từ cơ quan đăng ký cùng trạng thái HTTP tương ứng. Tuyến không sử dụng lớp bao status.code/status.msg/response của v3 cũ. Cấu trúc danh mục khác nhau: một số ánh xạ giá trị tới các đối tượng mô tả; số khác ánh xạ giá trị tới chuỗi. Giữ nguyên các khóa máy có thể đọc khi gửi biểu mẫu sau này. Ví dụ usecase giả định được rút gọn minh họa một ánh xạ có giá trị là đối tượng, không phải danh mục trực tiếp hay lược đồ được bảo đảm đầy đủ. Kiểm tra cả trạng thái HTTP lẫn cấu trúc JSON mong đợi.

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.

{
  "2FA": {
    "displayName": "Authentication",
    "description": "Example authentication use case"
  }
}

Lỗi

• 401: Xác thực tài khoản thất bại. Kiểm tra thông tin xác thực API, trạng thái bật và các hạn chế IP nguồn áp dụng.
• 400/404 và các lỗi khác từ cơ quan đăng ký: Danh mục hoặc bộ lọc không hợp lệ hay không khả dụng. Tuyến hiện tại giữ nguyên trạng thái HTTP và nội dung phản hồi từ hệ thống phía trên; không có lớp bao lỗi v3 dùng chung.
• 429: Đã đạt giới hạn yêu cầu của tài khoản hoặc giới hạn dùng chung của nhà cung cấp. Tuân thủ Retry-After và thử lại với thời gian chờ tăng dần.
• 502: Không thể kết nối tới cơ quan đăng ký. Chưa xác định được tính khả dụng; không thay thế bằng các lựa chọn rỗng rồi coi đó là kết quả thành công.
• 503: Bộ giới hạn yêu cầu hoặc dịch vụ phía trên không khả dụng. Kiểm tra nội dung và tiêu đề Retry-After nếu có trước khi thử lại.

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

• Trong luồng đã được rà soát, yêu cầu GET lấy danh mục này không tạo thương hiệu hay chiến dịch, không gửi đăng ký, không giữ chỗ tài nguyên và không thu phí đăng ký. Yêu cầu có liên hệ với nhà cung cấp và ghi bản ghi kiểm toán yêu cầu.
• Các định nghĩa trong danh mục và mọi siêu dữ liệu về phí của nhà cung cấp không phải là báo giá bán lẻ cho khách hàng. Cổng thông tin hiện tại lấy giá bán lẻ của chiến dịch riêng biệt; không được coi hàm trợ giúp getCampaignPrice cũ và các chú thích giá cũ trong danh mục liệt kê là cam kết về giá của tuyến này.
• Một mục được hỗ trợ trong danh mục không phải là bằng chứng cho thấy một thương hiệu cụ thể đủ điều kiện cho mục đích sử dụng đó. Hoàn tất việc xác định điều kiện riêng của thương hiệu, các bản kê khai, sự chấp thuận và việc xem xét giá áp dụng cho tài khoản trước khi gửi yêu cầu đăng ký sau này.