Отримання даних перед дзвінком

​

Як це працює

1. Дзвінок надходить (вхідний) або ініціюється (вихідний).
2. Платформа надсилає запит на налаштований ендпоінт: POST зі стандартизованим тілом або GET з номером в URL.
3. Абонент чує гудки виклику, поки триває очікування відповіді.
4. Ваш API повертає JSON — у стандартному форматі з полем initial_context або у власному (див. API у власному форматі).
5. Змінні додаються до початкового контексту дзвінка.
6. Голосовий агент починає розмову з повним доступом до отриманих даних через синтаксис {{назва_змінної}}.

​

Налаштування

​

Формат запиту

{
  "event": "call_inbound",
  "call_inbound": {
    "agent_id": 123,
    "from_number": "+380501234567",
    "to_number": "+380671234567"
  }
}

​

Очікуваний формат відповіді

{
  "call_inbound": {
    "initial_context": {
      "customer_name": "Іван Петренко",
      "account_status": "active",
      "loyalty_tier": "gold",
      "open_tickets": 2
    }
  }
}

{
  "initial_context": {
    "customer_name": "Іван Петренко",
    "account_status": "active"
  }
}

• Привітання: Вітаю, {{customer_name}}, дякуємо за дзвінок!
• Промпт: Клієнт має статус {{loyalty_tier}} і {{open_tickets}} відкритих звернень.

​

Вкладені змінні

{
  "call_inbound": {
    "initial_context": {
      "customer": {
        "name": "Іван Петренко",
        "address": {
          "city": "Київ"
        }
      }
    }
  }
}

​

API у власному форматі

https://crm.example.com/api/clients?phone={{caller_number}}

{
  "success": true,
  "data": [
    { "id": 101, "project": "A", "status": "active", "first_name": "Іван", "amount": "1208.32" },
    { "id": 102, "project": "B", "status": "closed", "first_name": "Іван", "amount": "540.00" }
  ]
}

• Якщо за шляхом об’єкт, його поля стають змінними — так само, як initial_context.
• Якщо за шляхом список, він стає записами:
  • {{records}} — список записів (у промпті підставляється як JSON, агент бачить усі поля);
  • {{records_count}} — кількість записів, 0 — не знайдено;
  • якщо лишився рівно один запис, його поля доступні ще й напряму: {{first_name}}, {{amount | money}}.

​

Таймаут

​

Тестування тестовими дзвінками

1. Відкрийте сценарій і перейдіть у Налаштування.
2. У розділі Контекстні змінні додайте:
   • caller_number — номер, який симулює абонента (наприклад, +380501234567).
   • called_number — номер, на який ніби здійснюється дзвінок (наприклад, +380671234567).
3. Збережіть налаштування.

​

Приклад інтеграції

app.post("/pre-call", async (req, res) => {
  const { call_inbound } = req.body;

  const customer = await db.customers.findOne({
    phone: call_inbound.from_number,
  });

  if (!customer) {
    return res.json({});
  }

  res.json({
    call_inbound: {
      initial_context: {
        customer_name: customer.name,
        account_status: customer.status,
        loyalty_tier: customer.tier,
      },
    },
  });
});