Call Object

This section outlines the Call object.

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
accessCode update	string	The access code entered by the caller.
addressFrom update	string	The phone number and SIP data of the calling party.
addressTo update	string	The phone number and SIP data of the called party.
bridgeName read only	string	The hosted bridge name.
callee update	string	The DID being dialed.
caller update	string	The phone number of the calling party.
codec update	string	The audio codec of the call.
connectionStatus update	integer	This field indicates the call direction. Values accepted in this field are as follows: 0 for inbound call 1 for outbound call
created read only	string	The date and time when the call was created.
customName update	string	A friendly name for the call.
duration read only	integer	The duration in seconds of the call.
gainLevel update	integer	The gain of the transmission circuit.
holdMode update	integer	Whether meeting participants and listeners are on hold. Values accepted in this field are either 0 or 40. 0 means that no parties are on hold. 40 means that participants and listeners have been placed on hold by the meeting host. When callers are on hold, they will hear music while the hosts have a private discussion.
id read only	integer	The call ID.
joined read only	integer	The date and time when the call was joined.
meetingNumber read only	integer	The meeting number of the meeting associated with the call.
muteMode update	integer	There are three mute states. The following values reflect which access level parties have been muted: 32 for listeners have been muted 36 for listeners have muted themselves and participants have muted themselves 40 for participants and listeners have been muted
nodeName update	string	The name of the hosted node, or communication endpoint.
presenterMedia update	integer	The media for the call. Values accepted in this field are: 1 for audio 2 for screensharing 4 for video 8 for controlling Note that you can add the integer values together. For example, for audio and video, 1 + 4 = 5.
qaMode read only	integer	The state of a Q&A meeting. Values accepted in this field are: 0 for meeting has not started yet 1 for active meeting 2 for talking to the next participant in the queue 4 for clearing the queue
role update	integer	The role associated with the access code. Values accepted in this field are: 1 for host 2 for participant 3 for listener
state update	integer	The current call state. Values accepted in this field are: 1 for call that is owned by the frontend 2 for call that is owned by the backend 3 for call that is closed 4 for call that is being dialed

Sample Call Object

{
    "accessCode": "111",
    "addressFrom": "+15162065319",
    "addressTo": "\"15162065318\" <sip:15162065318@10.2.114.15>",
    "bridgeName": "MIA-FCC4D",
    "callee": "15162065318",
    "caller": "+15162065319",
    "codec": "PCMU",
    "connectionStatus": 0,
    "created": 1544643810000,
    "customName": "",
    "duration": 171,
    "gainLevel": 0,
    "holdMode": 0,
    "id": 6889184,
    "joined": 1544643810000,
    "meetingNumber": 106131,
    "muteMode": 0,
    "nodeName": "10.2.114.15",
    "presenterMedia": 0,
    "qaMode": 0,
    "role": 1,
    "state": 2
}