Thuật ngữ

Các thuật ngữ được định nghĩa theo cách API dùng chúng. Khi một từ còn có một nghĩa thông thường rộng hơn, nghĩa của API là nghĩa được áp dụng.

Định danh và sản phẩm

Thuật ngữ	Ý nghĩa
định danh	Thứ duy nhất mà một lần kiểm tra thời gian thực hướng tới: một số điện thoại hoặc một địa chỉ email. Một lần gửi hàng loạt mang theo một danh sách các định danh.
chuỗi	Cho biết một định danh là `phone` hay `email`. Sản phẩm, endpoint và request đều thuộc riêng một chuỗi, và một request chỉ có thể trộn chuỗi theo nghĩa nó tuyệt đối không được trộn chúng.
sản phẩm	Một mục tiêu phát hiện — một nền tảng, cộng với kiểu kiểm tra được thực hiện trên đó. “WhatsApp Number Checker” và “WhatsApp Activity Details” là hai sản phẩm khác nhau, dù cả hai đều liên quan đến WhatsApp.
sản phẩm thời gian thực	Một sản phẩm được dùng qua các endpoint đồng bộ. Được định danh bằng ID dạng số của nó.
sản phẩm hàng loạt	Một sản phẩm được dùng qua các endpoint bất đồng bộ. Được định danh bằng slug của nó.
ID	Số nguyên định danh một sản phẩm thời gian thực, được in là `#47` trong danh mục. ID là thứ mà `product_ids` nhận.
slug	Chuỗi định danh một sản phẩm hàng loạt, ví dụ `waValid`. Slug là thứ mà trường `product` nhận.
chế độ	`realtime` hoặc `async`. Một sản phẩm chỉ thuộc đúng một chế độ, và chế độ quyết định endpoint nào chấp nhận nó.

Một ID thời gian thực không bao giờ phân giải được trên một endpoint hàng loạt, và một slug hàng loạt không bao giờ phân giải được trên một endpoint thời gian thực. Trộn chúng là lỗi tích hợp phổ biến nhất, và cả hai bên đều không xử lý nó một cách âm thầm — nhưng chúng thất bại khác nhau, vì hai bên kiểm tra khác nhau:

product_ids được kiểm tra như một mảng số nguyên, nên một slug dạng chuỗi bị từ chối với 400 invalid_realtime_request trước khi bất kỳ tra cứu sản phẩm nào diễn ra.
Trường product của hàng loạt được tra cứu theo slug, nên slug của một sản phẩm thời gian thực được tìm thấy — rồi bị từ chối với 422 product_mode_not_supported, vì các endpoint bất đồng bộ chỉ chấp nhận sản phẩm bất đồng bộ.

Kết luận

Thuật ngữ	Ý nghĩa
đã đăng ký	Điều mà phát hiện thực sự trả lời: định danh này có đăng ký trên nền tảng này không? Đây không phải một khẳng định về việc số hay địa chỉ có hợp lệ về mặt cú pháp, có thể liên lạc được, hay đang hoạt động hay không.
`valid`	Được xác nhận là đã đăng ký. Bị tính phí.
`invalid`	Được xác nhận là chưa đăng ký. Bị tính phí — một câu trả lời phủ định vẫn là một câu trả lời.
`unknown`	Nhà cung cấp không thể phân giải nó. Không bị tính phí; được hoàn tiền.
đã lưu trong cache	Kết luận được phục vụ từ một dữ kiện đã lưu thay vì hỏi nhà cung cấp. Một lượt trúng cache vẫn bị tính phí.
tổ hợp	Một request thời gian thực, một định danh, và một đến mười sản phẩm mà nó được kiểm tra cùng. Một tổ hợp có thể thành công một phần — xem `partial_succeeded`.

Tiền

Thuật ngữ	Ý nghĩa
tạm giữ	Lấy trước số tiền trước khi công việc chạy. Mọi lần gửi đều được tạm giữ trên số dư tài khoản.
quyết toán	Quyết định khoản thu cuối cùng của từng mục một khi kết luận của nó đã được biết.
hoàn tiền	Trả lại khoản tạm giữ cho một mục không tạo ra kết luận nào dùng được.
billing_status	Trường theo từng mục: `charged` hoặc `refunded`. Hãy đọc trường này thay vì suy ra từ trạng thái HTTP.
`total_reserved`	Khoản tạm giữ trước khi công việc chạy. Luôn bằng `total_charged + total_refunded`.
`charged_amount`	Khoản thu ròng. `refunded_amount` là khoản hoàn ròng.

Request và tác vụ

Thuật ngữ	Ý nghĩa
`request_id`	UUID định danh một lần gửi thời gian thực. Hãy cung cấp nó trong yêu cầu hỗ trợ.
`task_id`	Token định danh một lần gửi hàng loạt, được trả về khi gửi. Cũng là tham số đường dẫn `{token}` của các endpoint tác vụ — một giá trị, hai tên trong tài liệu.
`Idempotency-Key`	Một header do bên gọi cung cấp, bắt buộc trên các lệnh gọi thời gian thực, giúp việc thử lại an toàn: cùng khóa với cùng body sẽ trả về kết quả đã lưu thay vì tính phí lần nữa.
được phát lại	Phản hồi đến từ một kết quả đã lưu thay vì công việc mới. `replayed` trên một phản hồi thời gian thực, `idempotent_replay` trên một lần gửi hàng loạt. Một lần phát lại không bao giờ di chuyển tiền.
`recovery_pending`	Tác vụ hàng loạt đã vào hàng đợi, nhưng phần hạch toán của nó vẫn đang được đối soát.

Bộ đếm tác vụ

Thuật ngữ	Ý nghĩa
`submitted`	Số dòng bạn đã gửi.
`prefiltered`	Số dòng bị loại trước khi phát hiện — ví dụ các dòng sai định dạng.
`deduped`	Số dòng trùng lặp đã bị loại bỏ.
`total`	Số dòng thực sự được kiểm tra: `submitted` trừ `prefiltered` trừ `deduped`.
`processed`	Số dòng mà kênh thượng nguồn đã xử lý xong tính đến nay.
`unknown_unprocessed`	Những dòng không bao giờ được phân giải. Đây là những dòng được hoàn tiền.

Giới hạn và thời gian lưu giữ

Thuật ngữ	Ý nghĩa
giới hạn theo khóa	Hạn mức gắn với khóa API của bạn. Đây là mức bạn cần tính toán dựa vào.
giới hạn theo IP	Một mức trần thô hơn, được chia sẻ cho mọi khóa phía sau một địa chỉ. Không phải là một kiểm soát truy cập.
thời gian lưu giữ	Một bản ghi tồn tại được bao lâu. Log thời gian thực và kết quả phát lại: 30 ngày. Tệp kết quả hàng loạt: 7 ngày.

Liên quan

Định dạng phản hồi — cấu trúc bao ngoài, và cách tiền và mốc thời gian được mã hóa
Mã lỗi — cùng bộ từ vựng được áp dụng cho các lỗi