The Conference Object

Understand the structure and attributes of the Conference object returned by the Vobiz API.

The Conference object contains information about an ongoing conference including its runtime, participant count, and detailed information about each member currently in the conference.

Note: The Conference object is returned when you retrieve a specific conference or list all conferences. It provides a complete snapshot of the conference state at the time of the request.

Conference Attributes

Top-Level Attributes

Parameter	Type	Description
`conference_name`optional	string	Name used to identify the conference. This is the unique identifier for the conference room.
`conference_run_time`optional	string	Time (in seconds) since the conference was initiated. Indicates how long the conference has been active.
`conference_member_count`optional	string	Number of members currently active in the conference. Updated in real-time as members join or leave.
`members`optional	array	Array of member objects, each containing detailed information about an individual participant in the conference. See Member Attributes below.

Member Attributes

Each member object in the members array contains the following attributes:

Member Object Attributes

Parameter	Type	Description
`member_id`optional	string	Unique ID of the member within the conference. Used to identify the member for operations like mute, deaf, or kick.
`muted`optional	boolean	true if the member is currently muted (their audio is not transmitted to other participants). false if they can speak freely.
`deaf`optional	boolean	true if the member cannot hear conversations in the conference (they are "deafened"). false if they can hear other participants.
`from`optional	string	Source of the call — either a PSTN number or SIP endpoint. Indicates where the member is calling from.
`to`optional	string	Conference bridge number — either a Vobiz number or an application URL. The destination the member dialed to join.
`caller_name`optional	string	Name of the caller (only available if the call was made from a SIP endpoint). Empty string if not specified or not applicable.
`direction`optional	string	Direction of the call — either "inbound" (caller dialed into conference) or "outbound" (conference system called the participant).
`call_uuid`optional	string	Unique identifier of the call. Can be used to reference this specific call in other API operations.
`join_time`optional	string	Time (in seconds) since the member joined the conference. Indicates how long this participant has been in the conference.

Member State Indicators:

•muted: true - Member cannot be heard by others
•deaf: true - Member cannot hear others
•muted: true, deaf: true - Member is isolated from the conference

Example Response

Here's an example Conference object with one active member:

Conference Object Example

{
  "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"
    }
  ]
}

Understanding the Example:

•Conference "My Conf Room" has been running for 590 seconds (~9.8 minutes)
•Currently has 1 active member (John)
•John is not muted or deaf - full two-way audio
•John joined via inbound call from number 1456789903
•John has been in the conference for 590 seconds (joined when conference started)

Multiple Members Example

Multiple Members Conference

{
  "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"
    }
  ]
}

Analysis:

•Alice (member 45): Joined when conference started, speaking
•Unnamed (member 46): Called outbound 5 minutes after start, currently muted
•Bob (member 47): Joined 15 minutes after start, speaking

Conference Overview

Retrieve a Conference