Skip to main content
GET
/
api
/
v1
/
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>'
{
  "conference_name": "My Conf Room",
  "member_count": 3,
  "members": [
    {
      "member_id": "1",
      "muted": false,
      "deaf": false
    }
  ]
}
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.
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

FieldTypeRequiredDescription
auth_idstringYesYour Vobiz account ID (e.g., {auth_id})
conference_namestringYesName of the conference to retrieve
No request body needed. Simply use the GET method with the conference name in the URL path.

​
Response

Returns the details of the conference associated with the name specified, including all active members.
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": "1456789903",
      "to": "1677889900",
      "caller_name": "John",
      "direction": "inbound",
      "call_uuid": "acfbf0b5-12e0-4d74-85f7-fce15f8f07ec",
      "join_time": "590"
    }
  ],
  "api_id": "816e903e-58c4-11e1-86da-adf28403fe48"
}

​
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": "14155551234",
      "to": "14155559999",
      "caller_name": "Alice Johnson",
      "direction": "inbound",
      "call_uuid": "a1b2c3d4-1234-5678-90ab-cdef12345678",
      "join_time": "1200"
    },
    {
      "muted": true,
      "member_id": "46",
      "deaf": false,
      "from": "14155555678",
      "to": "14155559999",
      "caller_name": "",
      "direction": "outbound",
      "call_uuid": "b2c3d4e5-2345-6789-01bc-def123456789",
      "join_time": "900"
    },
    {
      "muted": false,
      "member_id": "47",
      "deaf": false,
      "from": "14155556789",
      "to": "14155559999",
      "caller_name": "Bob Smith",
      "direction": "inbound",
      "call_uuid": "c3d4e5f6-3456-7890-12cd-ef1234567890",
      "join_time": "300"
    }
  ],
  "api_id": "816e903e-58c4-11e1-86da-adf28403fe48"
}
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
  • Poll this endpoint periodically for dashboard updates (recommended: every 5-10 seconds)
  • Cache member_ids for quick access 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

200 - application/json

Conference details