Skip to main content

App DR Conf CDR Object

This section describes the elements of the App DR Conf CDR object.

App DR Conf CDR Object Attributes​

These fields and values make up the JSON object that gets returned with successful requests.

AttributeData TypeDescription
address_dst
read only

string

The fully qualified address of the called party which includes the SIP information with special characters formatted.

address_src
read only

string

The fully qualified address of the calling party which includes the SIP information with special characters formatted.

bridge
read only

string

The name of the bridge which handled the call.

call_sid
read only

string

The secure ID of the call which the system uses to identify it among other calls.

custom_call_type
read only

string

The special field used to identify the origin of the call. Values accepted in this field are:

  • dc for the service DC link initiated and assigned by the bridge.
  • foreign for the third-party VoIP or PSTN clients.
  • private_asd for the native controlling client initiated and assigned by the bridge.
  • private_call for the native clients, i.e. the clients that are using a specific VoIP library.
  • recording for the meeting recording service call initiated and assigned by the bridge.

custom_name
read only

string

The custom name for the calling party set by the software used, web, or IVR with special characters formatted.

date_disconnected
read only

string

The date and time when the call was disconnected from the meeting.

date_insert
read only

string

The date and time when the detail record about the call was inserted into the database.

date_join
read only

string

The date and time when the calling party joined the meeting.

date_start
read only

string

The date and time when the call started.

date_stop
read only

string

The date and time when the call ended.

direction
read only

string

The call direction, either inbound or outbound.

disconnect_cause
read only

string

The numeric SIP code used to describe the reason to drop the call.

disconnect_originator
read only

string

The initiator of the disconnection. Values accepted in this field are:

  • bridge for the conference bridge to be the disconnection originator (this can happen, when the host leaves the meeting and the meeting is over for all other participants).
  • src for the calling party to be the disconnection originator (i.e., when the participant decides to leave the meeting).

disconnect_reason
read only

string

The detailed descriptive information about the reason to drop the call.

duration
read only

number

The total call duration, specified in seconds.

duration_meeting
read only

number

The duration of the caller's participation in the meeting, specified in seconds.

endpoint_sid
read only

string

The secure ID of the Conference endpoint associated with the call.

meeting_room_sid
read only

string

The secure ID of the meeting room with which the meeting is associated. This field is available for the secured call flow type, and for the open call flow type when the calling party enters an access code for an existing meeting room.

meeting_sid
read only

string

The secure ID of the meeting in which the calling party participated.

node
read only

string

The IP address of the bridge node.

number_dst
read only

string

The called party phone number.

number_src
read only

string

The calling party phone number.

partner_sid
read only

string

The secure ID of the partner with which the Conference endpoint is associated.

role
read only

string

The role of the calling party in the meeting. Values accepted in this field are:

  • host for the calling party which joined the meeting as the meeting moderator, or host.
  • listener for the calling party which joined the meeting as the user that can only listen to the meeting.
  • participant for the calling party which joined the meeting as the user which can speak, but does not have moderator (host) rights.

user_agent
read only

string

The details about the user agent used by the calling party, if available.

Sample App DR Conf CDR Object​

{
    "address_dst": "\"15162065515\" <sip:15162065515@11.22.33.44>",
    "address_src": "<sip:+17605692222@12.34.56.78",
    "audio_key": null,
    "bridge": "conference-bridge",
    "call_sid": "69057c3e-bb90-4ed3-9c53-000000001142",
    "custom_call_type": null,
    "custom_name": null,
    "date_disconnected": "2023-12-14T10:04:04.000Z",
    "date_insert": "2023-12-14T11:01:03.195Z",
    "date_join": "2023-12-14T10:03:30.000Z",
    "date_start": "2023-12-14T10:03:14.000Z",
    "date_stop": "2023-12-14T10:04:04.000Z",
    "direction": "inbound",
    "disconnect_cause": 16,
    "disconnect_originator": "src",
    "disconnect_reason": "Normal",
    "duration": "50",
    "duration_meeting": "34",
    "endpoint_sid": "e3ddc435-7b07-4f3a-98d5-4fe9be107652",
    "meeting_room_sid": "f752b4a5-b821-4322-a26f-db5cfbf014ab",
    "meeting_sid": "69057c3e-bb90-4ed3-9c53-000000000392",
    "node": "11.22.33.44",
    "number_dst": "15162065515",
    "number_src": "+17605692222",
    "partner_sid": "cee93bf3-5746-43fe-a1a2-822c05fef687",
    "role": "host",
    "user_agent": "CX-IVS-SBC"
}

Get Conference Calls​

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

get /app/conference/calls

Sample​

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

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

Response​

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

{
    "count": 1,
    "has_more": false,
    "items": [
        {
            "address_dst": "\"15162065515\" <sip:15162065515@11.22.33.44>",
            "address_src": "<sip:+17605692222@12.34.56.78",
            "audio_key": null,
            "bridge": "conference-bridge",
            "call_sid": "69057c3e-bb90-4ed3-9c53-000000001142",
            "custom_call_type": null,
            "custom_name": null,
            "date_disconnected": "2023-12-14T10:04:04.000Z",
            "date_insert": "2023-12-14T11:01:03.195Z",
            "date_join": "2023-12-14T10:03:30.000Z",
            "date_start": "2023-12-14T10:03:14.000Z",
            "date_stop": "2023-12-14T10:04:04.000Z",
            "direction": "inbound",
            "disconnect_cause": 16,
            "disconnect_originator": "src",
            "disconnect_reason": "Normal",
            "duration": "50",
            "duration_meeting": "34",
            "endpoint_sid": "e3ddc435-7b07-4f3a-98d5-4fe9be107652",
            "meeting_room_sid": "f752b4a5-b821-4322-a26f-db5cfbf014ab",
            "meeting_sid": "69057c3e-bb90-4ed3-9c53-000000000392",
            "node": "11.22.33.44",
            "number_dst": "15162065515",
            "number_src": "+17605692222",
            "partner_sid": "cee93bf3-5746-43fe-a1a2-822c05fef687",
            "role": "host",
            "user_agent": "CX-IVS-SBC"
        }
    ],
    "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 CDR objects, the partner must have one of the following scopes enabled:

  • app.manage
  • app.read

To view information about App DR Conf CDR 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 call, targeted by secure ID.

get /app/conference/calls/{call_sid}

Sample​

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

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

Response​

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

{
    "address_dst": "\"15162065515\" <sip:15162065515@11.22.33.44>",
    "address_src": "<sip:+17605692222@12.34.56.78",
    "audio_key": null,
    "bridge": "conference-bridge",
    "call_sid": "69057c3e-bb90-4ed3-9c53-000000001142",
    "custom_call_type": null,
    "custom_name": null,
    "date_disconnected": "2023-12-14T10:04:04.000Z",
    "date_insert": "2023-12-14T11:01:03.195Z",
    "date_join": "2023-12-14T10:03:30.000Z",
    "date_start": "2023-12-14T10:03:14.000Z",
    "date_stop": "2023-12-14T10:04:04.000Z",
    "direction": "inbound",
    "disconnect_cause": 16,
    "disconnect_originator": "src",
    "disconnect_reason": "Normal",
    "duration": "50",
    "duration_meeting": "34",
    "endpoint_sid": "e3ddc435-7b07-4f3a-98d5-4fe9be107652",
    "meeting_room_sid": "f752b4a5-b821-4322-a26f-db5cfbf014ab",
    "meeting_sid": "69057c3e-bb90-4ed3-9c53-000000000392",
    "node": "11.22.33.44",
    "number_dst": "15162065515",
    "number_src": "+17605692222",
    "partner_sid": "cee93bf3-5746-43fe-a1a2-822c05fef687",
    "role": "host",
    "user_agent": "CX-IVS-SBC"
}

This request is enabled for Field Filtering.

Required Scopes​

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

  • app.manage
  • app.read

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

Path Arguments​

ParameterData TypeDescription
call_sid requiredstringThe conference call secure ID.