Мазмұнға өту
ҚұжаттамаКіру

Үзінді көшірме және баланс

Бұл бөлімдегі барлық маршрут код жіберуге қолданылатын кілтпен жұмыс істейді.

Сессиялар тізімі

GET /v1/verifications сессиялар массивін қайтарады, жаңалары жоғарыда.

Параметр Мәні
status pending, verified, failed немесе expired
channel Кодты жеткізген арна: telegram, whatsapp немесе sms
q vrf_…, нөмірдің бір бөлігі немесе correlation_id
limit 1-ден 100-ге дейін, әдепкіде 50
before Курсор, RFC 3339 форматындағы уақыт

Келесі бетті алу үшін before параметріне соңғы жолдың created_at мәнін беріңіз.

GET /v1/verifications.csv сол сүзгілерді қабылдайды және 10 000 жолға дейін қайтарады: бөлгіш ;, кодтау UTF-8, BOM-мен.

Сессия карточкасы

GET /v1/verifications/{id} сессияны және кодтың арналар бойынша жолын көрсетеді:

{
  "id": "vrf_8c1f04a2b7d93e6f5a10",
  "phone": "+77011234567",
  "status": "verified",
  "purpose": "login",
  "checks": 1,
  "cost_tiyn": 1400,
  "created_at": "2026-11-08T10:00:00Z",
  "expires_at": "2026-11-08T10:05:00Z",
  "verified_at": "2026-11-08T10:00:41Z",
  "test": false,
  "correlation_id": "order-42",
  "attempts": [
    {"channel": "telegram", "status": "undeliverable", "cost_tiyn": 0, "error": "PHONE_NUMBER_NOT_FOUND", "created_at": "2026-11-08T10:00:00Z", "updated_at": "2026-11-08T10:00:02Z"},
    {"channel": "whatsapp", "status": "delivered", "cost_tiyn": 1400, "created_at": "2026-11-08T10:00:02Z", "updated_at": "2026-11-08T10:00:05Z"}
  ]
}

error ішіндегі мәтін провайдерден келеді және өзгеруі мүмкін, логиканы соған сүйеп құрмаңыз. Міндетті емес өрістер мәні болғанда ғана пайда болады: verified_at, ip, ip_country, device, locale, preferred_channel, correlation_id.

Статистика

GET /v1/stats?days=14 1 күннен 90 күнге дейінгі кезеңнің қорытындысын қайтарады: verifications, verified, delivered, spent_tiyn, saved_vs_sms_tiyn, channels және daily бөлінісі.

Баланс және шоттар

GET /v1/billing/balance:

{"balance_tiyn": 1250000, "balance_kzt": "12500.00"}

POST /v1/billing/invoices денесінде {"amount_kzt": 50000} берілсе, 5 000 ₸-ден 50 000 000 ₸-ге дейінгі сомаға шот шығарады. GET /v1/billing/invoices соңғы 50 шотты қайтарады.