App DR Mediator Object

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

App DR Mediator Object Attributes

Attribute	Data Type	Description
attributes read only	object	The attributes of a binding or dialout.
date_insert read only	string	The date and time when the call detail record was processed and added to the database.
date_start read only	string	The date and time when the call started or SMS was created.
date_stop read only	string	The date and time when the call stopped or SMS was delivered (with any status).
date_talk read only	string	The date and time when the call was answered by the destination party.
direction read only	string	The direction of the call or SMS. Values accepted in this field are: `any` `inbound` `outbound` `undirected`
dr_sid read only	string	The detail record secure ID.
dtmf read only	string	The DTMF signals used during the call in the binding or dialout.
duration read only	number	The call duration in seconds. The value is calculated as `date_stop` — `date_start`.
endpoint_sid read only	string	The associated endpoint secure ID.
endpoint_type read only	string	The associated endpoint type. Values accepted in this field are: `conference` `conference_playback` `flexml` `mediator` `peering_receiver` `peering_sender` `system_gateway` `third_party` `voicemail`
event_type read only	string	The type of the Mediator event. Values accepted in this field are: `binding` `call` `dialout` `meeting`
number_dst read only	string	The destination number.
number_redirect read only	string	The Mediator redirect number.
number_src read only	string	The source number.
partner_sid read only	string	The secure ID of the Partner, to whom this detail record belongs.
reference_sid read only	string	The secure ID of the Mediator binding or dialout.
type read only	string	The type of call. Values accepted in this field are: `conference_call` `conference_meeting` `mediator` `mms` `sms` `telecom`
version read only	integer	The version of the detail record as it comes from the source.

Sample App DR Mediator Object

{
    "attributes": {
        "hide_origination_did": "true"
    },
    "date_insert": "2020-10-09T10:15:01.000Z",
    "date_start": "2020-10-09T10:12:28.000Z",
    "date_stop": "2020-10-09T10:12:43.000Z",
    "date_talk": "2020-10-09T10:12:32.000Z",
    "direction": "outbound",
    "dr_sid": "2ce7599c-8391-4cc2-8e06-7b832f110e48",
    "dtmf": null,
    "duration": "15",
    "endpoint_sid": "d59fbc20-3fda-4624-b58b-a8a4ef64b0a8",
    "endpoint_type": "mediator",
    "event_type": "dialout",
    "number_dst": "14437317761",
    "number_redirect": "15162065919",
    "number_src": "12029021281",
    "partner_sid": "cee93bf3-5746-43fe-a1a2-822c05fef687",
    "reference_sid": "89b3ef2c-222b-4bd7-bc46-084021e5a770",
    "type": "mediator",
    "version": 2
}

Get Mediator CDRs

This request returns a list of call detail records related to the Mediator endpoint.

get

/app/mediator/calls

Sample

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

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

Response

200 status code with a list of App DR Mediator objects:

{
    "count": 1,
    "has_more": false,
    "items": [
        {
            "attributes": {
                "hide_origination_did": "true"
            },
            "date_insert": "2020-10-09T10:15:01.000Z",
            "date_start": "2020-10-09T10:12:28.000Z",
            "date_stop": "2020-10-09T10:12:43.000Z",
            "date_talk": "2020-10-09T10:12:32.000Z",
            "direction": "outbound",
            "dr_sid": "2ce7599c-8391-4cc2-8e06-7b832f110e48",
            "dtmf": null,
            "duration": "15",
            "endpoint_sid": "d59fbc20-3fda-4624-b58b-a8a4ef64b0a8",
            "endpoint_type": "mediator",
            "event_type": "dialout",
            "number_dst": "14437317761",
            "number_redirect": "15162065919",
            "number_src": "12029021281",
            "partner_sid": "cee93bf3-5746-43fe-a1a2-822c05fef687",
            "reference_sid": "89b3ef2c-222b-4bd7-bc46-084021e5a770",
            "type": "mediator",
            "version": 2
        }
    ],
    "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 Mediator objects, the partner must have one of the following scopes enabled:

app.manage
app.read

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

App DR Mediator Object