Kiểm tra các trường hợp sử dụng chiến dịch dành cho một thương hiệu

Chọn một thương hiệu hiện có trong tài khoản của bạn

Bắt đầu bằng mã định danh thương hiệu trên hệ thống đăng ký đã được liên kết với tài khoản MultiTEL của bạn. Thao tác tra cứu này không tạo thương hiệu hoặc liên kết thương hiệu của người khác với tài khoản của bạn. Quy trình dành cho khách hàng hiện tại kiểm tra quyền sở hữu trước khi yêu cầu thông tin về điều kiện đủ. Nếu kết quả tra cứu trả về 404, hãy kiểm tra lại tài khoản và thương hiệu đã chọn thay vì thay bằng mã định danh của một dòng dữ liệu cục bộ.

Tạo các lựa chọn trường hợp sử dụng từ kết quả này

Danh mục trường hợp sử dụng chung mô tả các lựa chọn của hệ thống đăng ký. Thao tác tra cứu riêng cho thương hiệu này cung cấp các lựa chọn cho thương hiệu đã chọn. Giữ nguyên từng giá trị của trường usecase được trả về và kết hợp giá trị đó với nhãn hiển thị cùng mô tả trong danh mục. Không đưa ra mọi mục trong danh mục chung như thể thương hiệu đều đủ điều kiện sử dụng các mục đó.

Cổng thông tin yêu cầu phản hồi này là một danh sách JSON. Nếu phản hồi bị thiếu, sai định dạng hoặc là lỗi, hãy giữ nguyên biểu mẫu của khách hàng và thông báo rằng không thể tải thông tin về điều kiện đủ. Không được âm thầm coi phản hồi đó là sự chấp thuận cho một trường hợp sử dụng mặc định. Hệ thống đăng ký có thể trả về các trường khác ngoài những trường trong ví dụ rút gọn.

Tải các yêu cầu cho trường hợp sử dụng đã chọn

Sau khi khách hàng chọn một giá trị trường hợp sử dụng được trả về, hãy gửi yêu cầu đến /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} cho cùng thương hiệu đó. Phản hồi này cung cấp các giới hạn đối với trường hợp sử dụng con và các yêu cầu riêng của từng nhà mạng. Dùng phản hồi đó để thu thập tin nhắn mẫu, sự đồng ý và các khai báo bắt buộc khác. Chỉ riêng danh sách điều kiện đủ là chưa đủ để lập một hồ sơ đăng ký chiến dịch hoàn chỉnh.

Xem xét riêng mức giá của tài khoản

Các trường của nhà cung cấp như monthlyFee, quarterlyFee hoặc annualFee, khi được trả về, mô tả siêu dữ liệu về phí của nhà cung cấp. Chúng không thay thế mức giá áp dụng cho tài khoản của khách hàng hoặc các điều khoản đăng ký. Cổng thông tin hiện tại đọc riêng giá bán lẻ của chiến dịch rồi kết hợp với dữ liệu về điều kiện đủ trên màn hình xem xét. Không suy ra khoản phí phải thu của khách hàng từ các mức giá được ghi cố định trong mã của hàm hỗ trợ kiểu liệt kê cũ.

Làm mới khi thương hiệu hoặc trường hợp sử dụng thay đổi

Khi chuyển thương hiệu, hãy loại bỏ các lựa chọn của thương hiệu trước đó và tải thông tin về điều kiện đủ cho lựa chọn mới. Làm mới các yêu cầu của trường hợp sử dụng đã chọn trước khi gửi đăng ký. Các yêu cầu GET này không gửi đăng ký, kích hoạt chiến dịch hoặc gán số điện thoại.

Yêu cầu

Sử dụng tài khoản API đã được bật qua HTTPS từ địa chỉ IP nguồn được cho 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 quyền truy cập đã được bật. Không sử dụng thông tin xác thực của nhà cung cấp.

Gửi GET với mã định danh thương hiệu trong đường dẫn URL. Không cần phần thân yêu cầu.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"

Tham số đường dẫn
Tên	Kiểu	Bắt buộc	Mô tả
`brand_id`	chuỗi	Có	Mã định danh thương hiệu trên hệ thống đăng ký được liên kết với tài khoản MultiTEL đã xác thực của bạn. Sử dụng mã định danh thương hiệu, không dùng mã định danh dòng trong cơ sở dữ liệu cục bộ, mã định danh chiến dịch hoặc mã số thuế doanh nghiệp. Mã hóa giá trị này thành một đoạn duy nhất trong đường dẫn URL.

Phản hồi

Tuyến TCR hiện tại trả về trực tiếp phần thân JSON của hệ thống đăng ký và giữ nguyên trạng thái HTTP của phản hồi đó. Tuyến này không thêm lớp bao status/response của v3 cũ. Ví dụ giả định rút gọn không phải là kết quả tra cứu điều kiện đủ trực tiếp. Kiểm tra trạng thái HTTP và cấu trúc JSON dự kiến trước khi sử dụng. Cổng thông tin hiện tại yêu cầu một danh sách bản ghi về điều kiện đủ, trong đó mỗi bản ghi xác định một usecase. Cổng kết hợp các bản ghi đó với danh mục usecase để lấy nhãn hiển thị và đọc riêng giá bán lẻ. Phản hồi có thể chứa thêm các trường của nhà cung cấp.

Cấu trúc phản hồi minh họa; không phải dữ liệu trực tiếp của tài khoản hoặc báo giá hiện tại.

[
  {
    "usecase": "2FA"
  }
]

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 của tài khoản và các hạn chế IP nguồn được áp dụng.
404: Thương hiệu không được liên kết với tài khoản đã xác thực, hoặc nhà cung cấp không tìm thấy thương hiệu hay lựa chọn được yêu cầu. Hệ thống cục bộ trả về từ chối do không có quyền sở hữu trước khi gửi yêu cầu đến nhà cung cấp.
Các lỗi khác của hệ thống đăng ký: Giữ nguyên trạng thái HTTP và phần thân từ hệ thống thượng nguồn. Một trường hợp sử dụng không hợp lệ hoặc không khả dụng không được coi là kết quả thành công với tập yêu cầu rỗng.
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.
502/503: Lỗi truyền tải hoặc nhà cung cấp hay bộ giới hạn tốc độ không khả dụng. Giữ nguyên biểu mẫu và thử lại với thời gian chờ tăng dần.

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

Yêu cầu GET đã được rà soát kiểm tra quyền sở hữu thương hiệu hiện có, liên hệ với hệ thống đăng ký và ghi các bản ghi kiểm toán yêu cầu. Yêu cầu này không tạo thương hiệu hoặc chiến dịch và không thu phí đăng ký.
Siêu dữ liệu về phí của nhà cung cấp không phải là báo giá bán lẻ dành cho khách hàng MultiTEL. Cổng thông tin xem xét riêng mức giá của tài khoản trước khi gửi yêu cầu đăng ký ở bước sau.
Điều kiện đủ và các yêu cầu có thể thay đổi. Làm mới chúng cho thương hiệu và trường hợp sử dụng đã chọn trước khi gửi đăng ký. Tra cứu thành công không đồng nghĩa với việc chiến dịch được phê duyệt, số điện thoại được gán hoặc được phép bắt đầu gửi tin nhắn.