Call Object
In CarrierX API, the Call objects describe the calls of all users into the conference.
The system returns a Call JSON object with the fields listed in the table below in response to one of the following successful requests:
Call Object Attributes
The fields listed in the table below will be returned in a JSON object when a successful request has been made.
| Attribute | Data Type | Description |
|---|---|---|
| access_code read only | string | The access code entered by the caller. |
| account_sid read only | string | The secure ID of the account associated with the Call object. |
| call_sid read only | string | The call secure ID. |
| codecs read only | string | The semicolon-separated list of audio codecs used for the call. The codecs depend on the client used to connect to the conference. Most commonly used conference audio codecs are G722, ISAC, NOVOICE, OPUS, PCMU, and the combinations of these codecs with video codecs (e.g., ISAC,VP8, PCMU,VP8, etc.) |
| date_created read only | string | The date and time when the calling party placed the call. |
| date_joined read only | string | The date and time when the calling party joined the meeting. |
| direction read only | string | The direction of the call. Values accepted in this field are: In and Out. |
| duration read only | integer | The duration of the call specified in seconds. |
| gain_level read only | integer | The gain of the transmission circuit. |
| meeting_room_sid read only | string | The secure ID of the meeting room with which this call is associated. This value is filled only after the caller enters the meeting. |
| meeting_sid read only | string | The secure ID of the meeting this call is intended for. This value is filled only after the caller enters the meeting. |
| muted | boolean | Whether the call is muted or not. |
| name | string | The user name as it is sent by the client. |
| number_dst read only | string | The DID being dialed. |
| number_src read only | string | The phone number of the calling party. |
| on_hold | boolean | Whether the call is on hold or not. |
| role read only | string | The role of the calling party in the conference. Values accepted in this field are host, participant, and listener. |
Sample Call Object
{
"access_code": "890671",
"account_sid": "a1f38bf7-5879-49c1-be72-50ffa7f249a6",
"call_sid": "69057c3e-bb90-4ed3-9c53-000000000563",
"codecs": "PCMU",
"date_created": "2025-06-03T14:11:55.000Z",
"date_joined": "2025-06-03T14:11:55.000Z",
"direction": "In",
"duration": 28,
"gain_level": 0,
"meeting_room_sid": "d54061ef-8a16-459c-b055-6c0c297f46af",
"meeting_sid": "aaa07454-fa93-3d2d-b7b4-c5da9f2f87fd",
"muted": false,
"name": "",
"number_dst": "\"15162065515\" <sip:15162065515@11.22.33.44>",
"number_src": "<sip:+17605692222@55.66.77.88",
"on_hold": false,
"role": "host"
}