API Documentation
REST endpoints for OmniReceptionist integration
Webhooks
Incoming event webhooks for call handling
POST
/api/omni-receptionist/webhook/call-start
Triggered when a new inbound call begins
POST
/api/omni-receptionist/webhook/call-end
Triggered when a call ends with outcome data
POST
/api/omni-receptionist/webhook/voicemail
Triggered when a voicemail is left
POST
/api/omni-receptionist/webhook/appointment
Triggered when an appointment is booked via call
POST
/api/omni-receptionist/webhook/transfer
Triggered when a call is transferred to a human
Call Sessions
Manage and query call session data
GET
/api/omni-receptionist/calls
List call sessions with pagination and filters
GET
/api/omni-receptionist/calls/{id}
Get details for a specific call session
GET
/api/omni-receptionist/calls/{id}/transcript
Get the full transcript for a call
GET
/api/omni-receptionist/calls/{id}/recording
Get the recording URL for a call
Appointments
Manage appointments booked through the receptionist
GET
/api/omni-receptionist/appointments
List appointments with date range and status filters
GET
/api/omni-receptionist/appointments/{id}
Get appointment details
PUT
/api/omni-receptionist/appointments/{id}
Update appointment status or details
DELETE
/api/omni-receptionist/appointments/{id}
Cancel an appointment
Knowledge Base
Manage the receptionist's knowledge entries
GET
/api/omni-receptionist/knowledge
List all knowledge entries
POST
/api/omni-receptionist/knowledge
Add a new knowledge entry
PUT
/api/omni-receptionist/knowledge/{id}
Update an existing knowledge entry
DELETE
/api/omni-receptionist/knowledge/{id}
Remove a knowledge entry
Configuration
Manage receptionist profile and settings
GET
/api/omni-receptionist/profile
Get the current receptionist profile
PUT
/api/omni-receptionist/profile
Update the receptionist profile
GET
/api/omni-receptionist/voices
List available voices
PUT
/api/omni-receptionist/voice
Update the active voice selection
Analytics
Query analytics and reporting data
GET
/api/omni-receptionist/analytics/stats
Get dashboard statistics
GET
/api/omni-receptionist/analytics/outcomes
Get outcome breakdown
GET
/api/omni-receptionist/analytics/volume
Get call volume by date range
GET
/api/omni-receptionist/analytics/usage
Get current billing period usage
Billing
Subscription and usage management
GET
/api/omni-receptionist/billing/subscription
Get current subscription details
POST
/api/omni-receptionist/billing/subscribe
Create or change subscription plan
GET
/api/omni-receptionist/billing/usage
Get usage for current billing period
GET
/api/omni-receptionist/billing/invoices
List billing invoices