Глоссарий
Термины определены так, как их использует API. Если у слова есть и более свободное бытовое значение, применяется значение API.
Идентификаторы и продукты
Заголовок раздела «Идентификаторы и продукты»| Термин | Значение |
|---|---|
| идентификатор | Единственное, о чём идёт проверка realtime: один телефонный номер или один email-адрес. Пакетная отправка несёт их список. |
| серия | Является ли идентификатор phone или email. Продукты, эндпоинты и запросы привязаны к серии, и запрос может смешивать серии лишь в том смысле, что не должен смешивать их вовсе. |
| продукт | Одна цель проверки — платформа плюс вид выполняемой против неё проверки. «WhatsApp Number Checker» и «WhatsApp Activity Details» — два разных продукта, хотя оба касаются WhatsApp. |
| продукт realtime | Продукт, используемый через синхронные эндпоинты. Адресуется своим числовым ID. |
| пакетный продукт | Продукт, используемый через асинхронные эндпоинты. Адресуется своим slug. |
| ID | Целое число, идентифицирующее продукт realtime, отображается в каталоге как #47. Именно ID принимает product_ids. |
| slug | Строка, идентифицирующая пакетный продукт, например waValid. Именно slug принимает поле product. |
| режим | realtime или async. Продукт принадлежит ровно одному, и режим определяет, какие эндпоинты его принимают. |
Вердикты
Заголовок раздела «Вердикты»| Термин | Значение |
|---|---|
| зарегистрирован | На что на самом деле отвечает проверка: зарегистрирован ли этот идентификатор на этой платформе. Это не утверждение о том, синтаксически ли корректен номер или адрес, достижим ли он и обслуживается ли. |
valid | Подтверждённо зарегистрирован. Списано. |
invalid | Подтверждённо не зарегистрирован. Списано — отрицательный ответ всё ещё ответ. |
unknown | Поставщик не смог его обработать. Не списано; возвращено. |
| кешированный | Вердикт отдан из сохранённого факта, а не получен запросом к поставщику. Попадание в кэш всё равно тарифицируется. |
| комбинация | Один запрос realtime, один идентификатор и от одного до десяти продуктов, по которым он проверялся. Комбинация может частично удаться — см. partial_succeeded. |
| Термин | Значение |
|---|---|
| резерв | Взять сумму заранее, до выполнения работы. Каждая отправка резервируется против баланса аккаунта. |
| расчёт | Определить окончательное списание по отдельной позиции, как только известен её вердикт. |
| возврат | Вернуть зарезервированную сумму за позицию, не давшую пригодного вердикта. |
| billing_status | Поле отдельной позиции: charged или refunded. Читайте его, а не выводите из HTTP-статуса. |
total_reserved | Зарезервировано до выполнения работы. Всегда равно total_charged + total_refunded. |
charged_amount | Итоговое списание. refunded_amount — итоговый возврат. |
Запросы и задачи
Заголовок раздела «Запросы и задачи»| Термин | Значение |
|---|---|
request_id | UUID, идентифицирующий одну отправку realtime. Указывайте его в обращениях в поддержку. |
task_id | Токен, идентифицирующий одну пакетную отправку, возвращается при отправке. Также параметр пути {token} эндпоинтов задачи — одно значение, два имени в документации. |
Idempotency-Key | Заголовок, предоставляемый вызывающей стороной, обязательный для вызовов realtime; делает повтор безопасным: тот же ключ с тем же телом возвращает сохранённый результат вместо повторного списания. |
| повтор | Ответ пришёл из сохранённого результата, а не из свежей работы. replayed в ответе realtime, idempotent_replay в пакетной отправке. Повтор никогда не двигает деньги. |
recovery_pending | Пакетная задача поставлена в очередь, но её учёт ещё сводится. |
Счётчики задачи
Заголовок раздела «Счётчики задачи»| Термин | Значение |
|---|---|
submitted | Строки, которые вы отправили. |
prefiltered | Строки, отброшенные до проверки, — например, некорректные. |
deduped | Удалённые дублирующиеся строки. |
total | Строки, фактически поставленные на проверку: submitted минус prefiltered минус deduped. |
processed | Строки, которые вышестоящий канал уже завершил. |
unknown_unprocessed | Строки, которые так и не разрешились. Именно за них возвращаются средства. |
Лимиты и хранение
Заголовок раздела «Лимиты и хранение»| Термин | Значение |
|---|---|
| лимит на ключ | Бюджет, привязанный к вашему API-ключу. Именно по нему стоит планировать. |
| лимит на IP | Более грубый потолок, общий для всех ключей за одним адресом. Не контроль доступа. |
| хранение | Как долго живёт запись. Логи realtime и результаты повторов: 30 дней. Файлы пакетных результатов: 7 дней. |
Связанное
Заголовок раздела «Связанное»- Формат ответа — конверт и то, как кодируются деньги и метки времени
- Коды ошибок — тот же словарь, применённый к сбоям