App DR Conf MDR Object

This section describes the elements of the App DR Conf MDR object. These fields and values make up the JSON object that gets returned with successful requests.

App DR Conf MDR Object Attributes

Attribute	Data Type	Description
attendee_count read only	integer	The total number of the meeting attendees.
audio_attendee_count read only	integer	The number of the attendees who used audio conferencing during the meeting.
control_attendee_count read only	integer	The number of the attendees who used conference controls during the meeting.
data_attendee_count read only	integer	The number of the attendees who sent data during the meeting.
date_insert read only	string	The date and time when the detail record about the meeting was inserted into the database.
date_start read only	string	The date and time when the meeting started.
date_stop read only	string	The date and time when the meeting ended.
duration read only	number	The total conference duration, measured in seconds.
duration_audio read only	number	The duration of the meeting audio conferencing, measured in seconds.
duration_control read only	number	The duration of the conference control usage during the meeting, measured in seconds.
duration_data read only	number	The duration of the meeting during which some data was sent or received (e.g., the participants used the screensharing feature), measured in seconds.
duration_meeting read only	number	The duration of the meeting, measured in seconds.
duration_recording read only	number	The duration of the meeting during which the recording was made, measured in seconds.
duration_video read only	number	The duration of the meeting during which the video conferencing was used, measured in seconds.
endpoint_sid read only	string	The secure ID of the Conference endpoint associated with the meeting.
has_recording read only	boolean	Whether or not the meeting was recorded.
meeting_room_sid read only	string	The secure ID of the meeting room associated with the meeting.
meeting_sid read only	string	The secure ID of the meeting which the system uses to identify it among other meetings.
partner_sid read only	string	The secure ID of the partner with which the Conference endpoint is associated.
unique_attendee_count read only	integer	The number of the unique attendees which took part in the meeting.
video_attendee_count read only	integer	The number of the attendees which used video conferencing during the meeting.

Sample App DR Conf MDR Object

{
    "attendee_count": 2,
    "audio_attendee_count": 2,
    "control_attendee_count": 0,
    "data_attendee_count": 0,
    "date_insert": "2021-12-14T11:01:20.224Z",
    "date_start": "2021-12-14T10:02:26.000Z",
    "date_stop": "2021-12-14T10:04:04.000Z",
    "duration": "98",
    "duration_audio": "98",
    "duration_control": "0",
    "duration_data": "0",
    "duration_meeting": "98",
    "duration_recording": "0",
    "duration_video": "0",
    "endpoint_sid": "e3ddc435-7b07-4f3a-98d5-4fe9be107652",
    "has_recording": false,
    "meeting_room_sid": "f752b4a5-b821-4322-a26f-db5cfbf014ab",
    "meeting_sid": "69057c3e-bb90-4ed3-9c53-000000000392",
    "partner_sid": "cee93bf3-5746-43fe-a1a2-822c05fef687",
    "unique_attendee_count": 2,
    "video_attendee_count": 0
}

Get Conference Meetings

This request returns a list of detail records related to the Conference Meeting objects.

get

/app/conference/meetings

Sample

A sample GET request to get the Conference endpoint Meeting object detail records matching the criteria in the request URL:

curl -X GET \
'https://api.carrierx.com/core/v2/app/conference/meetings' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

200 response code with a list of App DR Conf MDR objects:

{
    "count": 1,
    "has_more": false,
    "items": [
        {
            "attendee_count": 2,
            "audio_attendee_count": 2,
            "control_attendee_count": 0,
            "data_attendee_count": 0,
            "date_insert": "2021-12-14T11:01:20.224Z",
            "date_start": "2021-12-14T10:02:26.000Z",
            "date_stop": "2021-12-14T10:04:04.000Z",
            "duration": "98",
            "duration_audio": "98",
            "duration_control": "0",
            "duration_data": "0",
            "duration_meeting": "98",
            "duration_recording": "0",
            "duration_video": "0",
            "endpoint_sid": "e3ddc435-7b07-4f3a-98d5-4fe9be107652",
            "has_recording": false,
            "meeting_room_sid": "f752b4a5-b821-4322-a26f-db5cfbf014ab",
            "meeting_sid": "69057c3e-bb90-4ed3-9c53-000000000392",
            "partner_sid": "cee93bf3-5746-43fe-a1a2-822c05fef687",
            "unique_attendee_count": 2,
            "video_attendee_count": 0
        }
    ],
    "limit": 10,
    "offset": 0,
    "pagination": {},
    "total": null
}

This request is enabled for Pagination, Result Filtering, and Field Filtering.

Required Scopes

To get information about App DR Conf MDR objects, the partner must have one of the following scopes enabled:

app.manage
app.read

To view information about App DR Conf MDR objects for the inherited partner, the partner must additionally have the app.read_descendant scope enabled.

Get Conference Call by SID

This request returns data for a Conference meeting, targeted by secure ID.

get

/app/conference/calls/{meeting_sid}

Sample

A sample GET request to get a a detail record related to Conference meeting, targeted by secure ID:

curl -X GET \
'https://api.carrierx.com/core/v2/app/conference/meetings/69057c3e-bb90-4ed3-9c53-000000000392' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

200 response code with a serialized copy of the App DR Conf MDR object:

{
    "attendee_count": 2,
    "audio_attendee_count": 2,
    "control_attendee_count": 0,
    "data_attendee_count": 0,
    "date_insert": "2021-12-14T11:01:20.224Z",
    "date_start": "2021-12-14T10:02:26.000Z",
    "date_stop": "2021-12-14T10:04:04.000Z",
    "duration": "98",
    "duration_audio": "98",
    "duration_control": "0",
    "duration_data": "0",
    "duration_meeting": "98",
    "duration_recording": "0",
    "duration_video": "0",
    "endpoint_sid": "e3ddc435-7b07-4f3a-98d5-4fe9be107652",
    "has_recording": false,
    "meeting_room_sid": "f752b4a5-b821-4322-a26f-db5cfbf014ab",
    "meeting_sid": "69057c3e-bb90-4ed3-9c53-000000000392",
    "partner_sid": "cee93bf3-5746-43fe-a1a2-822c05fef687",
    "unique_attendee_count": 2,
    "video_attendee_count": 0
}

This request is enabled for Field Filtering.

Required Scopes

To get information about App DR Conf MDR objects, the partner must have one of the following scopes enabled:

app.manage
app.read

To view information about App DR Conf MDR objects for the inherited partner, the partner must additionally have the app.read_descendant scope enabled.

Path Arguments

Parameter	Data Type	Description
meeting_sid required	string	The conference meeting secure ID.

App DR Conf MDR Object