Перейти к содержимому

Проверка в реальном времени

Проверка в реальном времени отвечает на один вопрос об одном идентификаторе сразу: зарегистрирован ли этот номер телефона — или этот адрес электронной почты — на заданной платформе?

Движок тот же, что использует консоль. Он принимает номер телефона или адрес электронной почты, проверяет его по одному — десяти продуктам реального времени и возвращает вердикт по каждому продукту.

У вас естьИспользуйте
Один идентификатор или несколько, и ответ нужен сейчасПроверку в реальном времени
Тысячи идентификаторов, и вы можете подождатьМассовая проверка

Типичные случаи реального времени — валидация формы при регистрации или оформлении заказа, разовые проверки внутри внутреннего инструмента и небольшое число проверок внутри уже запущенного процесса. Массовая проверка создана для файлов и больших массивов: она асинхронна, тарифицируется по каждой проверенной строке, а завершённые задачи можно скачать.

Серия передаётся в пути, и она должна соответствовать выбранным продуктам:

СерияEndpointidentifier
ТелефонPOST /v1/realtime/check/phoneНомер в формате E.164, например +8613800138000
EmailPOST /v1/realtime/check/emailАдрес электронной почты, например user@example.com

Запрос не может смешивать серии: выбор телефонного продукта и email-продукта в одном вызове отклоняется. country необязателен для полного номера E.164 и должен быть опущен для email.

Один вызов принимает один идентификатор и от одного до десяти продуктов:

  • один request_id на вызов
  • одна запись на продукт в results
  • одно списание на запись

Поскольку каждая запись тарифицируется отдельно, вызов может завершиться успешно для одних продуктов и неудачно для других. Это отражается как status: partial_succeeded, и каждая запись несёт свой billing_status — читайте их, а не полагайтесь на один только HTTP 200.

  1. Получите API-ключ — см. Authentication.
  2. Считайте ID продуктов, которые собираетесь использовать, из Продукты реального времени.
  3. Передавайте уникальный Idempotency-Key с каждым вызовом; он обязателен, а не опционален.