Voxo API Reference
website·Indexed 33 days ago
https://docs.voxo.coAPI documentation for Voxo, featuring endpoints for managing announcements, audit logs, authentication (including MFA and JWT), branches, business hours, button layouts, call campaigns, and call groups. Includes details on v2 admin endpoints and webhooks such as ANSWEREDCALL.
What's inside Voxo
- The IVR (Interactive Voice Response) system allows pharmacies to build and manage phone menus that route inbound callers and process refill requests automatically. Management is handled via the IVR page at https://pharmacy.voxo.co/ivr, which is divided into two main tabs: Calls (for analytics and history) and Settings (for configuration).
Overview of Who Is Calling feature
Who Is Calling allows pharmacy staff to open a patient's profile automatically based on the phone number of the current caller, eliminating the need to manually search for the patient. VOXO identifies the call on the workstation's extension, and the Pharmacy Management System (PMS) searches for the matching phone number.
Setup varies by PMS:
- Liberty RX: Requires a plugin installation in Liberty RXQ.
- PioneerRx: Requires a webhook URL in Pioneer's integration settings.
- BestRx: Requires setup via VOXO support.
Overview of Yealink W70B DECT base station
The Yealink W70B serves as the cordless base station for VOXO DECT phones. It connects to the network, registers to VOXO as a phone, and acts as the wireless hub for compatible cordless handsets. The base supports up to 5 paired handsets simultaneously.Overview of VOXO Meet
VOXO Meet is a cloud-based video conferencing service that allows users to meet on any device. It is available to all users who have video meetings enabled on their extension. For simple three-party conferencing via a VOXO desk phone, use the 'Conference' button; for more than three participants, VOXO Meet is required.Overview of VOXO Product Ecosystem
VOXO provides a suite of communication tools including Omnia (a comprehensive web and desktop app for calling, messaging, queue management, and administration), Connect (a streamlined phone client and contact center app for calling, messaging, video meetings, and channel management), and specialized communication features for Pharmacy workflows.Overview of VOXO Connect
VOXO Connect is a browser-based unified communications application that integrates with the VOXO phone system. It provides a single interface for voice, video, messaging, and fax services and requires no local installation.Overview of Omnia Short Numbers
A Short Number is a 2-5 digit code that allows users to reach specific destinations without dialing a full 10-digit number. For example, a user can dial '02' to reach a field technician's cell phone instead of their full number. Management of these numbers is restricted to Account Administrator and Partner Administrator roles.Overview of the AI Pharmacy Agent
The AI pharmacy agent handles inbound patient calls, prescription refill requests, status checks, outbound call campaigns (in Assistant mode), and embedded chat widget interactions. It integrates with Pharmacy Management Systems (PMS) such as PioneerRx, Liberty RX, and BestRx to perform lookups and process requests. The agent is managed via the Agent page at https://pharmacy.voxo.co/agent, which contains 'Conversations' and 'Settings' tabs.Overview of Number Porting in Omnia
Number porting allows users to move existing phone numbers from another carrier into VOXO. This process is available to Account Administrators and Partner Administrators.
Key Constraints:
- Port-ins: VOXO submits the request to the losing carrier; the losing carrier decides whether to approve or reject it.
- Port-outs: To move a number away from VOXO, the new carrier must initiate the request. VOXO does not prohibit port-outs, and approval is automatic.
- Rejections: If a port-in is rejected, the reason code (e.g., address or account number mismatch) can be found under View Order Notes within the port request.
Overview of VOXO Pharmacy Call Campaigns
Call campaigns allow pharmacies to run automated outbound calls for patient notifications such as prescription pickups, refill reminders, and birthday outreach. Campaigns can deliver pre-recorded or AI-generated messages and can capture patient responses via key presses or conversational AI. Campaigns are managed via the Call Campaigns page athttps://pharmacy.voxo.co/outbound-calling, which is organized into three tabs: Report, Campaigns, and Settings.Overview of Call Blocking in Omnia
Call blocking allows Account Administrators and Partner Administrators to block incoming calls from specific phone numbers.
Important Constraints:
- Blocking is performed on a per-number basis; there is no automated network-wide spam filter.
- Only exact matches of numbers on the blocked list are rejected.
- Because spam callers often use 'neighbor spoofing' (rotating caller IDs), administrators may need to frequently add new numbers as patterns shift.
Overview of Grandstream HT8xx Analog Telephone Adapters
Grandstream HT8xx analog telephone adapters (ATA) allow analog devices, such as fax machines or analog handsets, to connect to VOXO phone services. The adapter acts as a bridge between the network and the analog device, registering to VOXO as a phone line. The HT8xx family varies by the number of analog (FXS) ports available per model:
- HT801: 1 port
- HT812: 2 ports
- HT814: 4 ports
- HT818: 8 ports