Справочник API WapFlow OTP

Отправляйте и проверяйте коды подтверждения с собственного номера WhatsApp. Все ответы возвращаются в формате JSON.

Базовый адрес: https://wapflow.net/api/otp/v1

Аутентификация

Передавайте заголовок Authorization: Bearer <key> в каждом запросе. Ключи создаются на странице WapFlow OTP в панели WapFlow; боевые ключи начинаются с wfo_live_, тестовые — с wfo_test_. Ключ показывается только один раз, при создании: сохраните его в надёжном месте и используйте только на сервере.

Успешный ответ выглядит так: { "success": true, ... }; ответ с ошибкой — так: { "success": false, "error": { "code": "...", "message": "..." } }.

Отправка кода

POST/send

phone (обязательно) — номер получателя. Необязательные параметры: code_length (4–8), ttl (60–900 с), lang (например, tr, en) и app_name. Всё, что не указано, берётся из настроек панели.

Запрос
{
  "phone": "905321234567",
  "code_length": 6,
  "ttl": 300,
  "lang": "tr",
  "app_name": "Acme"
}
Ответ (200)
{
  "success": true,
  "request_id": "req_...",
  "phone": "905321234567",
  "expires_at": "2026-11-12T10:05:00.000Z",
  "status": "sent"            // "sent" | "queued"
}

Проверка кода

POST/verify

phone и code обязательны. Если передан request_id, проверяется именно этот запрос; если нет, проверяется последний не истёкший код, отправленный на этот номер с этим ключом. После 5 неверных попыток запрос блокируется, а подтверждённый код повторно использовать нельзя.

Запрос
{ "request_id": "req_...", "phone": "905321234567", "code": "123456" }
Ответ (200)
{ "success": true, "valid": true }

{ "success": true, "valid": false,
  "reason": "invalid_code",     // invalid_code | expired | too_many_attempts | already_verified | not_found
  "attempts_left": 3 }

Проверка статуса

GET/status/:request_id

Возвращает статус запроса: queued, sent, delivered, read, failed, verified или expired.

{ "success": true, "request_id": "req_...", "status": "delivered",
  "sent_at": "...", "delivered_at": "...", "verified_at": null }

Проверка соединения

GET/me

Показывает, что ключ действителен, ваш тариф, количество подключённых аккаунтов и использование квоты за этот месяц (кнопка «Проверить соединение» в плагине WordPress использует этот запрос).

{ "success": true, "plan": "otp-2",
  "accounts": { "limit": 2, "connected": 1 },
  "quota": { "monthly": 15000, "used": 42, "period": "2026-11" },
  "ends_at": "2026-12-12T10:00:00.000Z", "mode": "live" }

Примеры

Примеры ниже отправляют код, а затем проверяют код, который введёт пользователь. Замените wfo_live_XXXX на свой ключ.

# 1) send
curl -X POST https://wapflow.net/api/otp/v1/send \
  -H "Authorization: Bearer wfo_live_XXXX" \
  -H "Content-Type: application/json" \
  -d '{"phone":"905321234567","app_name":"Acme"}'

# 2) verify
curl -X POST https://wapflow.net/api/otp/v1/verify \
  -H "Authorization: Bearer wfo_live_XXXX" \
  -H "Content-Type: application/json" \
  -d '{"request_id":"req_...","phone":"905321234567","code":"123456"}'
<?php
function wapflow_otp(string $path, array $body): array {
    $ch = curl_init('https://wapflow.net/api/otp/v1' . $path);
    curl_setopt_array($ch, [
        CURLOPT_POST => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_TIMEOUT => 15,
        CURLOPT_HTTPHEADER => [
            'Authorization: Bearer ' . getenv('WAPFLOW_OTP_KEY'),
            'Content-Type: application/json',
        ],
        CURLOPT_POSTFIELDS => json_encode($body),
    ]);
    $res = json_decode(curl_exec($ch), true) ?: [];
    curl_close($ch);
    return $res;
}

$sent = wapflow_otp('/send', ['phone' => '905321234567', 'app_name' => 'Acme']);
// ... kullanıcı kodu girince:
$check = wapflow_otp('/verify', ['request_id' => $sent['request_id'], 'phone' => '905321234567', 'code' => $_POST['code']]);
if (!empty($check['valid'])) { /* giriş başarılı */ }
const BASE = 'https://wapflow.net/api/otp/v1';

async function otp(path, body) {
  const res = await fetch(BASE + path, {
    method: 'POST',
    headers: {
      Authorization: `Bearer ${process.env.WAPFLOW_OTP_KEY}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify(body),
  });
  return res.json();
}

const sent = await otp('/send', { phone: '905321234567', app_name: 'Acme' });
// ... when the user submits the code:
const check = await otp('/verify', { request_id: sent.request_id, phone: '905321234567', code: '123456' });
if (check.valid) { /* signed in */ }
import os
import requests

BASE = "https://wapflow.net/api/otp/v1"
HEADERS = {"Authorization": "Bearer " + os.environ["WAPFLOW_OTP_KEY"]}

def otp(path, body):
    return requests.post(BASE + path, json=body, headers=HEADERS, timeout=15).json()

sent = otp("/send", {"phone": "905321234567", "app_name": "Acme"})
# ... when the user submits the code:
check = otp("/verify", {"request_id": sent["request_id"], "phone": "905321234567", "code": "123456"})
if check.get("valid"):
    pass  # signed in

Коды ошибок

HTTPКодЗначение
400invalid_requestТело запроса или параметры некорректны.
401invalid_keyКлюч API недействителен или отозван.
402no_subscriptionУ этого аккаунта нет подписки WapFlow OTP.
402subscription_expiredСрок подписки истёк; продлите её.
403sales_disabledСервис временно недоступен.
422invalid_phoneНомер телефона некорректен.
429rate_limitedПревышено ограничение частоты; повторите запрос через retry_after секунд, указанных в ответе.
429quota_exceededКвота кодов на этот месяц исчерпана.
429daily_limit_reachedДостигнут дневной лимит отправки подключённых аккаунтов WhatsApp; повторите попытку через количество секунд, указанное в retry_after в ответе (на следующий день в 00:00 по стамбульскому времени). Квота не расходуется.
503no_account_connectedНет подключённого и включённого аккаунта WhatsApp.
503send_failedНе удалось отправить сообщение; повторите попытку немного позже.

Ограничения частоты

Прогрев аккаунта и дневной лимит

Тестовые ключи

Ключи, начинающиеся с wfo_test_, не отправляют сообщения в WhatsApp и не расходуют квоту; код возвращается в поле test_code. Правила отправки и ограничения частоты такие же, как у боевых ключей, и активная подписка по-прежнему нужна. Чтобы перейти на боевой режим, просто замените ключ.

{ "success": true, "request_id": "req_...", "status": "sent", "test_code": "482913" }

Формат номера телефона

Замечания по безопасности

Плагин WordPress

  1. Скачайте wapflow-otp.zip.
  2. В панели администратора WordPress откройте Плагины → Добавить новый → Загрузить плагин, загрузите zip-архив и активируйте его.
  3. В настройках плагина вставьте ключ API, созданный в панели WapFlow.
  4. Кнопкой «Проверить соединение» проверьте ключ и свой тариф.
  5. Сначала попробуйте с тестовым ключом, затем введите боевой ключ.