Skip to content

🤖 Documentation: Bot

Omnichannel bot / flows. What it is, how it works and how to use it — explained step by step.

🤖 Definition — Bot module

The Bot is an omnichannel flow builder: you design the conversation once (with nodes: IVR menu, AI assistant, voicemail, transfer, agent hand-off, data lookup…) and activate it on any of its 5 channels. Everything handled lands in a unified inbox.

5 channels to activate a bot: Voice (VoIP), WhatsApp Voice, SMS, WhatsApp and Email.

📞
Voice (VoIP)Phone call through the PBX (SIP). The bot answers with IVR menus, AI assistant and voicemail.
🟢
WhatsApp VoiceVoice call over WhatsApp. Technically the same voice bot (same IVR/AI/voicemail flow); only the call enters via WhatsApp instead of the phone.
💬
SMSText auto-reply with menus (optional per number).
🟢
WhatsAppMessage auto-reply with interactive menus and opt-in.
📧
EmailEmail auto-reply by flow, with anti-loop safeguards.

Note — Voice: Voice (VoIP) and WhatsApp Voice are technically the same voice bot (same flow, IVR, AI and voicemail); the only difference is where the call comes in — the phone network or WhatsApp.

🗺️ Per-channel diagrams

The same flow engine handles each channel; only the entry point changes.

📞 Voice (VoIP)

📱Customercallscall🏢PBXSIPARI🤖UCaaS · Botflow enginenodes🧩IVR / AI / Voicemailaction

🟢 WhatsApp Voice

📱CustomerWhatsApp callcall☁️WhatsApp providerWhatsAppSIP🏢PBXSIPARI🤖UCaaS · Botsame voice flow

💬 SMS

📱CustomerSMSSMS📡SMS providerswebhookwebhook🤖UCaaS · BotSMS flowreplies💬Replyto customer

🟢 WhatsApp

📱CustomerWhatsAppWA☁️WhatsApp providerwebhookwebhook🤖UCaaS · BotWhatsApp flowreplies🟢Replyto customer

📧 Email

✉️Inbound mailfrom customerIMAP🤖UCaaS · BotEmail flowSMTP📤Replyto customer

Voice (VoIP) and WhatsApp Voice use the same voice bot (same flow: IVR, AI, voicemail); on SMS, WhatsApp and Email the same engine drives the auto-reply.

📘 Explanation (step by step)

The module has 4 tabs: Assign (pick the number and assign the flow per channel), Flows (your flow library and which numbers use them), Create (example templates → editor) and Inbox (omnichannel log).

  1. Create: in the Create tab pick an example template (or "from scratch"). The flow opens in the editor right there to view, analyze and modify it; the templates stay visible (with their description) so you can switch between them.
  2. Add nodes: menu (IVR), AI assistant, language, business hours, data capture, data lookup (balance/invoice/account), code verification, survey, voicemail, transfer to queue/extension, agent hand-off, guided hand-off to WhatsApp, notification and hang up.
  3. When you tap Save flow a new flow is created in your library (it asks for a name; the original template is untouched) and you move to Flows. From Assign (or Flows → Apply) assign the flow to channels per number: Voice, WhatsApp Voice, SMS, WhatsApp or Email. The same flow can be shared across several numbers — editing it updates them all.
  4. Configure the flow notifications (voicemail → email and/or WhatsApp) with a checkbox to enable/test.
  5. Check the Bot Inbox: omnichannel log (voice, SMS, WhatsApp, Email) with each interaction outcome and the voicemail audio.

Online help: the builder includes online help to build and edit the call and conversation flows.

🔎 Self-service: Data lookup

The Data lookup node lets the caller self-serve: the bot identifies them (by the calling number or by asking for their account number), requests a PIN and returns their data —for example balance, invoice and account— read out by voice or sent by message.

📞Customercalls / writesidentify🔑PINvalidates identityOK🗄️Data sourceinternal / external / APIfetch💳Balance / Invoiceanswer

Data sources (chosen per customer):

🗄️
UCaaS internal databaseManaged from the portal (load/import the data). Ideal for testing or customers without their own system.
🌐
Customer / TelHarbor external databaseA database on another server (read-only, encrypted credentials, safe queries).
🔌
Customer APIA customer web service (REST) that responds with the data.

Data it can return: account, name, balance, invoice (amount, due date, status) and extra fields. Built-in test: each connection has a Test button that validates access and shows sample data, without exposing credentials or the PIN.

Security: read-only connections, PIN never read aloud, encrypted credentials and parameterized queries.

💬 Guided hand-off to WhatsApp

From a voice call, the bot can continue the conversation on WhatsApp: it sends a WhatsApp to the caller and, once they reply, the chat continues on WhatsApp with the call context (name, account, data already looked up). The customer repeats nothing.

📞On the calloffers itsends💬WhatsAppmessage to customerreplies🤖UCaaS · Botresumes with contextcontinuesChat handlingno repeats

Requires the customer to have a WhatsApp number with a bot. The first message is sent as an approved template; once they reply, the conversation opens and the bot continues at the chosen point.