Conference
Manage multi-participant conference calls with Vobiz's Conference API for traditional meeting use cases.
Conferences let you involve multiple participants in a single call. Using Vobiz's Conference API, you can manage ongoing and completed conferences in your account, terminate ongoing conferences, and retrieve details of an ongoing or completed conference.
Base URL
https://api.vobiz.ai/apiEndpoint
https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/Authentication Required:
- • X-Auth-ID header with your account ID (e.g., {Auth_ID})
- • X-Auth-Token header with your account Auth Token
- • Content-Type: application/json for POST requests
Conference vs Multiparty Call
Vobiz offers two solutions for multi-participant calls, each optimized for different use cases:
Traditional Meeting Use Cases
- •Best for: Traditional conference calls, team meetings, webinars, group discussions
- •Setup: Typically initiated via XML (Conference element) during call flow
- •Control: Basic member controls (mute, deaf, kick, hang up)
- •Features: Simple recording, audio/text playback to members
Advanced Contact Center Use Cases
- •Best for: Contact centers, sales dialers, customer support, complex call flows
- •Setup: API-driven with programmatic participant management
- •Control: Advanced controls including role-based permissions, coach mode, hold states
- •Features: Dual-level recording, pause/resume, participant-level recording, supervisor monitoring
Recommendation: Use Conference for simple multi-participant calls and meetings. Choose Multiparty Call when you need advanced control, role-based permissions, or contact center features like coach mode and supervisor monitoring.
Key Features
Conference Management
- •Retrieve details of ongoing conferences
- •List all active conferences in your account
- •Terminate individual or all conferences
- •Monitor conference runtime and participant count
Member Control
- •Mute/unmute individual members or all members
- •Deaf/undeaf members to control what they hear
- •Kick members (disconnect with XML continuation)
- •Hang up members (terminate connection)
- •Play audio or text to specific members
Recording & Transcription
- •Start/stop recording during ongoing conferences
- •Support for MP3 and WAV file formats
- •Automatic transcription (English, under 4 hours)
- •Callback notifications for recording completion
Conference Operations
The Conference Object
Understand the Conference object structure with all attributes including conference name, runtime, member count, and individual member details.
View Documentation →Retrieve a Conference
Get detailed information about a specific ongoing conference including all active members and their states.
View Documentation →List All Conferences
Retrieve a list of all ongoing conferences in your account with their names.
View Documentation →Hang Up a Conference
Terminate a specific conference and disconnect all participants.
View Documentation →Hang Up All Conferences
Terminate all ongoing conferences in your account simultaneously.
View Documentation →Member Operations
Control individual conference members or perform actions on all members simultaneously. Most operations support targeting by member_id, comma-separated list of IDs, or "all" for bulk operations.
Conference Members
Explore all member control operations including mute, deaf, kick, hang up, and audio/text playback features.
View All Member Operations →Recording Operations
Record conference calls with automatic transcription support. Recordings can be started and stopped during ongoing conferences for flexible compliance and documentation needs.
Conference Recording
Learn about conference recording features including transcription, callback events, and file format options.
View Recording Documentation →