Skip to main content
GET
/
api
/
v1
/
Account
/
{auth_id}
/
Conference
/
List conferences
curl --request GET \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/ \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'
import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/"

headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
  method: 'GET',
  headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};

fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "objects": [
    {
      "conference_name": "My Conf Room",
      "member_count": 3
    }
  ]
}
GET https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/
This endpoint retrieves a list of all ongoing conferences for your account and returns their names. You can then use these names to retrieve detailed information about specific conferences or perform operations on them.
Authentication required:
  • X-Auth-ID - Your account Auth ID
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json
Use Cases: Dashboard displays showing active conferences, monitoring conference activity, generating conference reports, administrative oversight, system health checks.

​
Path parameters

FieldTypeRequiredDescription
auth_idstringYesYour Vobiz account ID (e.g., {auth_id})
No request body or query parameters needed. Simply use the GET method on the base conference endpoint.

​
Response

Returns the names of all ongoing conferences associated with the account.
Response - 200 OK (Multiple Conferences)
{
  "conferences": [
    "Team Meeting",
    "Sales Call",
    "Customer Support Conference"
  ],
  "api_id": "816e903e-58c4-11e1-86da-adf28403fe48"
}
Response - 200 OK (No Active Conferences)
{
  "conferences": [],
  "api_id": "816e903e-58c4-11e1-86da-adf28403fe48"
}

​
Response Fields

  • conferences - Array of conference names currently active. Empty array if no conferences are running.
  • api_id - Unique identifier for this API request
Note: The response only includes conference names, not detailed information. To get member counts, runtime, and participant details, use the Retrieve a Conference endpoint for each conference name.

​
Example Request

​
List All Active Conferences

cURL Request
curl -X GET https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

​
Typical Workflow: Get Conference Details

Use this endpoint to discover conference names, then retrieve detailed information for each: 
# Get list of conference names
curl -X GET https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

# Response: {"conferences": ["Team Meeting", "Sales Call"]}

# Get details for "Team Meeting"
curl -X GET https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/Team%20Meeting/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

# Response includes member count, runtime, and all participants
Common Use Cases:
  • Dashboard overview: Display all active conferences in admin panel
  • System monitoring: Track number of concurrent conferences
  • Resource management: Identify conferences to free up capacity
  • Reporting: Generate usage statistics and activity reports
  • Cleanup operations: Find abandoned or long-running conferences
  • Billing: Track active conference usage for billing purposes
Best Practices:
  • Poll this endpoint periodically for dashboard updates (recommended: every 10-30 seconds)
  • Cache results to reduce API calls - refresh only when needed
  • Handle empty conference arrays gracefully (no active conferences is normal)
  • Iterate through results to get detailed info only when needed
  • Implement rate limiting to avoid excessive API calls
  • Use WebSockets or webhooks for real-time updates instead of frequent polling

​
Example: Dashboard Implementation

JavaScript Dashboard Logic
// Fetch all active conferences
async function getActiveConferences() {
  const response = await fetch(
    'https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/',
    {
      headers: {
        'X-Auth-ID': '{auth_id}',
        'X-Auth-Token': 'YOUR_AUTH_TOKEN'
      }
    }
  );

  const data = await response.json();
  return data.conferences; // Array of conference names
}

// Get details for each conference
async function getConferenceDetails(conferenceName) {
  const encodedName = encodeURIComponent(conferenceName);
  const response = await fetch(
    `https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/${encodedName}/`,
    {
      headers: {
        'X-Auth-ID': '{auth_id}',
        'X-Auth-Token': 'YOUR_AUTH_TOKEN'
      }
    }
  );

  return await response.json();
}

// Update dashboard every 15 seconds
setInterval(async () => {
  const conferences = await getActiveConferences();
  console.log(`Active conferences: ${conferences.length}`);

  // Get details for each
  for (const name of conferences) {
    const details = await getConferenceDetails(name);
    console.log(`${name}: ${details.conference_member_count} members`);
  }
}, 15000);

Authorizations

​
X-Auth-ID
string
header
required

Your Vobiz account Auth ID

​
X-Auth-Token
string
header
required

Your Vobiz account Auth Token

Path Parameters

​
auth_id
string
required

Your account Auth ID

Example:

"MA_XXXXXX"

Response

200 - application/json

List of conferences

​
api_id
string
required
​
conferences
array
required