Skip to main content

Create Conference

Initialize a new conference call that participants can join. Set up basic parameters, security, and call handling options.

Endpoint​

POST https://api.audian.com:8443/v2/conferences

Request​

Headers​

Content-Type: application/json
X-Auth-Token: YOUR_API_KEY

Parameters​

ParameterTypeRequiredDescription
nameStringYesConference name
scheduled_forISO8601NoStart time (for scheduled conferences)
max_participantsNumberNoMaximum participants allowed (default: 100)
require_pinBooleanNoRequire PIN to join (default: false)
pinStringNo4-6 digit PIN code
recordBooleanNoAutomatically record (default: false)
hold_music_idStringNoMedia ID for hold music
mute_on_entryBooleanNoMute participants on join (default: false)
allow_recording_by_participantBooleanNoAllow participants to record (default: false)
member_notificationBooleanNoNotify members of joins/leaves (default: true)

Examples​

Create Basic Conference​

curl -X POST https://api.audian.com:8443/v2/conferences \
  -H "X-Auth-Token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Weekly Team Sync",
    "max_participants": 50
  }'

JavaScript/Node.js​

const axios = require('axios');

const createConference = async () => {
  try {
    const response = await axios.post(
      'https://api.audian.com:8443/v2/conferences',
      {
        name: 'Weekly Team Sync',
        max_participants: 50,
        record: true,
        mute_on_entry: false
      },
      {
        headers: {
          'Authorization': 'Bearer YOUR_API_KEY',
          'Content-Type': 'application/json'
        }
      }
    );
    console.log('Conference created:', response.data);
    console.log('Join code:', response.data.id);
  } catch (error) {
    console.error('Creation failed:', error);
  }
};

createConference();

Python​

import requests
from datetime import datetime, timedelta

def create_conference(api_key, name, max_participants=100, 
                     require_pin=False, pin=None, record=False,
                     hold_music_id=None, mute_on_entry=False):
    url = 'https://api.audian.com:8443/v2/conferences'
    headers = {
        'X-Auth-Token': api_key,
        'Content-Type': 'application/json'
    }
    
    payload = {
        'name': name,
        'max_participants': max_participants,
        'require_pin': require_pin,
        'record': record,
        'mute_on_entry': mute_on_entry
    }
    
    if pin:
        payload['pin'] = pin
    
    if hold_music_id:
        payload['hold_music_id'] = hold_music_id
    
    response = requests.post(url, headers=headers, json=payload)
    return response.json()

# Usage
result = create_conference(
    api_key='YOUR_API_KEY',
    name='Weekly Team Sync',
    max_participants=50,
    require_pin=True,
    pin='1234',
    record=True
)
print(result)

Scheduled Conference with PIN​

curl -X POST https://api.audian.com:8443/v2/conferences \
  -H "X-Auth-Token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Client Quarterly Review",
    "scheduled_for": "2024-02-15T14:00:00Z",
    "max_participants": 25,
    "require_pin": true,
    "pin": "5678",
    "record": true,
    "mute_on_entry": true,
    "member_notification": true
  }'

Large Webinar Conference​

curl -X POST https://api.audian.com:8443/v2/conferences \
  -H "X-Auth-Token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Product Launch Webinar",
    "max_participants": 500,
    "require_pin": false,
    "record": true,
    "mute_on_entry": true,
    "allow_recording_by_participant": false,
    "member_notification": false
  }'

Response​

Success (201)​

{
  "id": "conf_abc123def456",
  "name": "Weekly Team Sync",
  "status": "created",
  "max_participants": 50,
  "current_participants": 0,
  "require_pin": false,
  "record": true,
  "mute_on_entry": false,
  "member_notification": true,
  "join_url": "https://api.audian.com/conferences/conf_abc123def456/join",
  "created_at": "2024-02-04T11:00:00Z",
  "scheduled_for": null,
  "expires_at": "2024-02-05T11:00:00Z"
}

Error (400)​

{
  "error": "invalid_pin",
  "message": "PIN must be 4-6 digits"
}

Conference ID​

The id returned in the response is the conference identifier. Use this to:

  • Add participants
  • Control conference settings
  • Manage participants
  • Record the conference
  • End the conference

Join Methods​

Participants can join using:

  1. Direct Call: Call the conference access number with the conference ID
  2. Web Link: Use the join_url in a web interface
  3. Dial-in Code: Provide conference ID as dial code
  4. Email Invite: Send join details via email

Security Considerations​

PIN Protection​

Enable require_pin for confidential meetings:

  • 4-6 digit PIN codes
  • Participants must enter PIN before joining
  • Can be changed after conference creation

Mute on Entry​

Enable mute_on_entry for large conferences or presentations:

  • Prevents background noise from multiple participants
  • Organizer can unmute individual participants
  • Participants may self-unmute (configurable)

Recording Restrictions​

Control who can record:

  • record: true - Conference is recorded by Audian
  • allow_recording_by_participant: false - Prevent participant recording

Scheduled Conferences​

For future meetings, use scheduled_for:

const futureDate = new Date();
futureDate.setHours(futureDate.getHours() + 2); // 2 hours from now

const conference = {
  name: 'Future Meeting',
  scheduled_for: futureDate.toISOString(),
  max_participants: 30
};

Limits and Quotas​

  • Max participants per conference: 1000
  • Max active conferences: 100 per account
  • Conference duration: Up to 24 hours
  • PIN length: 4-6 digits
  • Name length: Max 255 characters
  • Scheduled conferences: Up to 365 days in advance