Retrieve a Conference

GET

api

Account

{auth_id}

Conference

{conference_name}

Retrieve a conference

curl --request GET \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/ \
  --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/{conference_name}/"

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/{conference_name}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "conference_name": "My Conf Room",
  "conference_run_time": "590",
  "conference_member_count": "1",
  "members": [
    {
      "muted": false,
      "member_id": "17",
      "deaf": false,
      "from": "CALLER_NUMBER",
      "to": "VOBIZ_NUMBER",
      "caller_name": "CALLER_NAME",
      "direction": "inbound",
      "call_uuid": "CALL_UUID",
      "join_time": "590"
    }
  ],
  "api_id": "API_REQUEST_ID"
}

GET https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/

Retrieves the details of a particular conference by its name. The response includes the conference runtime, member count, and detailed information about each member currently in the conference.

Known limitation: A live conference can return 200 OK with {"error":"failed"} instead of conference details. Check the response body before using it, and capture ConferenceMemberID from conference enter callbacks when you need to target a member.

Authentication required:

X-Auth-ID - Your account Auth ID
X-Auth-Token - Your account Auth Token
Content-Type: application/json

Use Cases: Monitor active conferences, check participant status, verify member states (muted/deaf), track join times, and gather call UUIDs for further operations.

Path parameters

Field	Type	Required	Description
`auth_id`	string	Yes	Your Vobiz account ID (e.g., `{auth_id}`)
`conference_name`	string	Yes	Name of the conference to retrieve

No request body needed. Simply use the GET method with the conference name in the URL path.

Response

When available, the response contains conference details and active members. The current failure response for a live conference is:

Response - 200 OK

{
  "error": "failed",
  "api_id": "API_REQUEST_ID"
}

An ended or unknown conference returns 404 Not Found with {"error":"conference not found"}.

Response - 200 OK

{
  "conference_name": "My Conf Room",
  "conference_run_time": "590",
  "conference_member_count": "1",
  "members": [
    {
      "muted": false,
      "member_id": "17",
      "deaf": false,
      "from": "CALLER_NUMBER",
      "to": "VOBIZ_NUMBER",
      "caller_name": "John",
      "direction": "inbound",
      "call_uuid": "CALL_UUID",
      "join_time": "590"
    }
  ],
  "api_id": "API_REQUEST_ID"
}

Response Fields

conference_name - Name of the conference
conference_run_time - Duration in seconds since conference started
conference_member_count - Number of active members
members - Array of member objects with detailed information
api_id - Unique identifier for this API request

Member Information: Each member object includes their ID, mute/deaf status, caller details, direction (inbound/outbound), call UUID, and join time. See The Conference Object documentation for detailed attribute descriptions.

Example Request

Retrieve Conference by Name

cURL Request

curl -X GET https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/My%20Conf%20Room/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

Conference names with spaces must be URL-encoded (space becomes %20).

Response with Multiple Members

JSON Response

{
  "conference_name": "Team Meeting",
  "conference_run_time": "1200",
  "conference_member_count": "3",
  "members": [
    {
      "muted": false,
      "member_id": "45",
      "deaf": false,
      "from": "CALLER_NUMBER_1",
      "to": "VOBIZ_NUMBER",
      "caller_name": "Alice Johnson",
      "direction": "inbound",
      "call_uuid": "CALL_UUID_1",
      "join_time": "1200"
    },
    {
      "muted": true,
      "member_id": "46",
      "deaf": false,
      "from": "CALLER_NUMBER_2",
      "to": "VOBIZ_NUMBER",
      "caller_name": "",
      "direction": "outbound",
      "call_uuid": "CALL_UUID_2",
      "join_time": "900"
    },
    {
      "muted": false,
      "member_id": "47",
      "deaf": false,
      "from": "CALLER_NUMBER_3",
      "to": "VOBIZ_NUMBER",
      "caller_name": "Bob Smith",
      "direction": "inbound",
      "call_uuid": "CALL_UUID_3",
      "join_time": "300"
    }
  ],
  "api_id": "API_REQUEST_ID"
}

Common Use Cases:

Monitor conference status: Check how long a conference has been running
Verify participants: See who is currently in the conference
Check member states: Identify which members are muted or deaf
Track join times: Determine when each participant joined
Get call UUIDs: Retrieve call UUIDs for further call operations
Dashboard display: Show real-time conference information in admin panels

Best Practices:

URL-encode conference names that contain spaces or special characters
Do not rely on this endpoint as the only source for dashboard updates
Capture member IDs from conference enter callbacks when performing member operations
Use call_uuid to correlate conference members with CDR records
Handle 404 responses gracefully - conference may have ended between requests

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"

conference_name

string

required

Example:

"My Conf Room"

Response

Conference details or the current live-retrieval failure payload

Conference details
Current live-retrieval failure

conference_name

string

required

conference_run_time

string

required

Conference runtime in seconds

conference_member_count

string

required

members

object[]

required

Show child attributes

api_id

string

required

⌘I

Retrieve a conference

curl --request GET \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/ \
  --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/{conference_name}/"

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/{conference_name}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "conference_name": "My Conf Room",
  "conference_run_time": "590",
  "conference_member_count": "1",
  "members": [
    {
      "muted": false,
      "member_id": "17",
      "deaf": false,
      "from": "CALLER_NUMBER",
      "to": "VOBIZ_NUMBER",
      "caller_name": "CALLER_NAME",
      "direction": "inbound",
      "call_uuid": "CALL_UUID",
      "join_time": "590"
    }
  ],
  "api_id": "API_REQUEST_ID"
}

​Path parameters

​Response

​Response Fields

​Example Request

​Retrieve Conference by Name

​Response with Multiple Members

Authorizations

Path Parameters

Response

Path parameters

Response

Response Fields

Example Request

Retrieve Conference by Name

Response with Multiple Members