Skip to content

Key concepts

These terms mean the same thing in the console, the API and these docs. Many API values are Turkish words; their meaning is given below.

The AI that speaks on behalf of your store. Every assistant has a configuration: conversation prompt (instructions), greeting, voice and speech recognition settings, interruption and silence behaviour, knowledge sources and tools. A company can have as many assistants as its plan allows. Listed under Assistants in the console. Assistant →

A published, frozen state of the assistant. The configuration is saved block by block; publish takes a snapshot of the current blocks and opens it to calls under a new version number (v1, v2, …). Versions →

One conversation with the assistant: inbound (phone_in), outbound (phone_out) or from the browser (web). Each call has a status (e.g. completed, no_answer), duration, transcript, event log, summary, resolution and topics. Call history →

A work item opened during a call and followed up by your team. Numbers look like TLP-000001. Kinds:

KindCode
Address changeadres_degisikligi
Delivery changeteslimat_degisikligi
Urgent shippingacil_kargo
Cancellationiptal
Returniade
Invoice changefatura_degisikligi
Otherdiger

Statuses: acik (open), islemde (in progress), tamamlandi (completed), reddedildi (rejected). Requests →

A template that defines why the assistant calls a customer: key (e.g. sikayet, complaint), type (hizmet service or ticari commercial), goal, instructions, greeting, allowed tools, outcome codes, an optional coupon rule and the İYS check. Every outbound call request belongs to a purpose. Purposes →

A request to call a customer for a purpose. Its source is konsol (console), buton (button), api or asistan (a callback appointment taken during a call). Statuses: sirada (queued), planlandi (scheduled), arama (calling), tamamlandi (completed), reddedildi (rejected), basarisiz (failed), iptal (cancelled). Triggers →

A node in your company’s two-level topic tree: group → topic (e.g. “Shipping and delivery → Shipment status”). Each call is tagged automatically with 1–3 topics after it ends; you can correct the tags. Topics are never deleted, only deactivated, so past statistics stay intact. Analytics and topics →

The context you work in in the console. Company users work in their company workspace; if you belong to several companies you switch with the picker in the top bar. The platform operator (support team) also sees the Platform workspace and can enter a company it is not a member of only in support mode. Workspaces →

  • Do-not-call list (arama yasağı): numbers of people who said “don’t call me”. Numbers are stored as a company-specific hash, not in plain text. Pre-checks →
  • İYS: Turkey’s Message Management System (İleti Yönetim Sistemi). Before commercial calls, the customer’s CALL consent is checked. İYS →
  • Data API (Veri API): the REST API through which sites without a ready-made connection send product, order, cart and customer data. Data API →
  • Publishable key: the rz_pub_ key used by the browser button; it cannot start a call on its own. Button →