Skip to main content

Making A Call

This scenario covers making a call through the API. The user is already logged in and is monitoring the event stream.

User with device 200 on trunk 12345678, calls an external device on number 22334455.

First, the user requests to make a call using a MakeCall request:

Request
<?xml version="1.0" encoding="utf-16"?>
<MakeCall>
  <callingDevice>200</callingDevice>
  <calledDirectoryNumber>22334455</calledDirectoryNumber>
  <autoOriginate>doNotPrompt</autoOriginate>
  <privateData>
    <requestID>114-b85d6725-97dd-4e64-bbf9-09bf4879855d</requestID>
  </privateData>
</MakeCall>

The system responds with a MakeCallResponse, indicating that the request has been registered:

Response
<MakeCallResponse xmlns="http://www.ecma.ch/standards/ecma-323/csta/ed6">
  <callingDevice>
    <callID>N/A</callID>
    <deviceID>200</deviceID>
  </callingDevice>
  <callLinkageData>
    <globalCallData>
      <globalCallLinkageId>N/A</globalCallLinkageId>
    </globalCallData>
  </callLinkageData>
  <privateData>
    <requestID>114-b85d6725-97dd-4e64-bbf9-09bf4879855d</requestID>
  </privateData>
</MakeCallResponse>

The call is then delivered and auto-answered on the users own device, if the device supports that. Our softphone and many SIP devices supports this out of the box. The customers system can monitor the events on the monitorCrossRefID 'u-12345678-200'

Call started on device
<DeliveredEvent xmlns="http://www.ecma.ch/standards/ecma-323/csta/ed6">
  <monitorCrossRefID>u-12345678-200</monitorCrossRefID>
  <connection>
    <callID>SIP/hpbx-00000233</callID>
    <deviceID>200</deviceID>
  </connection>
  <alertingDevice>
    <deviceIdentifier>22334455</deviceIdentifier>
  </alertingDevice>
  <callingDevice>
    <deviceIdentifier>200</deviceIdentifier>
  </callingDevice>
  <calledDevice>
    <deviceIdentifier>22334455</deviceIdentifier>
  </calledDevice>
  <localConnectionInfo>connected</localConnectionInfo>
  <cause>newCall</cause>
  <networkCallingDevice>
    <deviceIdentifier>200</deviceIdentifier>
  </networkCallingDevice>
  <networkCalledDevice>
    <deviceIdentifier>22334455</deviceIdentifier>
  </networkCalledDevice>
  <callLinkageData>
    <globalCallData>
      <globalCallLinkageId>f64b594c-ae2a-416b-9061-96299f8a5ee3</globalCallLinkageId>
    </globalCallData>
  </callLinkageData>
  <privateData>
    <eventOrderIncrement>0</eventOrderIncrement>
    <isCstaOriginated>true</isCstaOriginated>
    <cstaCallRequestType>MakeCall</cstaCallRequestType>
    <callDirection>Outbound</callDirection>
    <localStatus>Ringing</localStatus>
    <remoteUser>22334455</remoteUser>
    <callerName>John Doe</callerName>
  </privateData>
</DeliveredEvent>

<EstablishedEvent xmlns="http://www.ecma.ch/standards/ecma-323/csta/ed6">
  <monitorCrossRefID>u-12345678-200</monitorCrossRefID>
  <establishedConnection>
    <callID>SIP/hpbx-00000233</callID>
    <deviceID>200</deviceID>
  </establishedConnection>
  <answeringDevice>
    <deviceIdentifier>22334455</deviceIdentifier>
  </answeringDevice>
  <callingDevice>
    <deviceIdentifier>200</deviceIdentifier>
  </callingDevice>
  <calledDevice>
    <deviceIdentifier>22334455</deviceIdentifier>
  </calledDevice>
  <localConnectionInfo>connected</localConnectionInfo>
  <cause>normal</cause>
  <networkCallingDevice>
    <deviceIdentifier>200</deviceIdentifier>
  </networkCallingDevice>
  <networkCalledDevice>
    <deviceIdentifier>22334455</deviceIdentifier>
  </networkCalledDevice>
  <callLinkageData>
    <globalCallData>
      <globalCallLinkageId>f64b594c-ae2a-416b-9061-96299f8a5ee3</globalCallLinkageId>
    </globalCallData>
  </callLinkageData>
  <privateData>
    <eventOrderIncrement>0</eventOrderIncrement>
    <isCstaOriginated>true</isCstaOriginated>
    <cstaCallRequestType>MakeCall</cstaCallRequestType>
    <callDirection>Outbound</callDirection>
    <localStatus>Active</localStatus>
    <remoteUser>22334455</remoteUser>
    <callerName>John Doe</callerName>
    <timestamp>2025-04-30 13:23:23Z</timestamp>
  </privateData>
</EstablishedEvent>

The customers system can also monitor the events directly on the trunks monitorCrossRefID 't-12345678'

Call started on device
<DeliveredEvent xmlns="http://www.ecma.ch/standards/ecma-323/csta/ed6">
  <monitorCrossRefID>t-12345678</monitorCrossRefID>
  <connection>
    <callID>SIP/hpbx-00000234</callID>
    <deviceID>22334455</deviceID>
  </connection>
  <alertingDevice>
    <deviceIdentifier>22334455</deviceIdentifier>
  </alertingDevice>
  <callingDevice>
    <deviceIdentifier>200</deviceIdentifier>
  </callingDevice>
  <calledDevice>
    <deviceIdentifier>22334455</deviceIdentifier>
  </calledDevice>
  <localConnectionInfo>alerting</localConnectionInfo>
  <cause>newCall</cause>
  <networkCallingDevice>
    <deviceIdentifier>200</deviceIdentifier>
  </networkCallingDevice>
  <networkCalledDevice>
    <deviceIdentifier>22334455</deviceIdentifier>
  </networkCalledDevice>
  <callLinkageData>
    <globalCallData>
      <globalCallLinkageId>f64b594c-ae2a-416b-9061-96299f8a5ee3</globalCallLinkageId>
    </globalCallData>
  </callLinkageData>
  <privateData>
    <eventOrderIncrement>0</eventOrderIncrement>
    <isCstaOriginated>false</isCstaOriginated>
    <callDirection>Inbound</callDirection>
    <localStatus>Alerting</localStatus>
    <remoteUser>200</remoteUser>
    <callerName>John Doe</callerName>
  </privateData>
</DeliveredEvent>

<EstablishedEvent xmlns="http://www.ecma.ch/standards/ecma-323/csta/ed6">
  <monitorCrossRefID>t-12345678</monitorCrossRefID>
  <establishedConnection>
    <callID>SIP/hpbx-00000234</callID>
    <deviceID>22334455</deviceID>
  </establishedConnection>
  <answeringDevice>
    <deviceIdentifier>22334455</deviceIdentifier>
  </answeringDevice>
  <callingDevice>
    <deviceIdentifier>200</deviceIdentifier>
  </callingDevice>
  <calledDevice>
    <deviceIdentifier>22334455</deviceIdentifier>
  </calledDevice>
  <localConnectionInfo>connected</localConnectionInfo>
  <cause>normal</cause>
  <networkCallingDevice>
    <deviceIdentifier>200</deviceIdentifier>
  </networkCallingDevice>
  <networkCalledDevice>
    <deviceIdentifier>22334455</deviceIdentifier>
  </networkCalledDevice>
  <callLinkageData>
    <globalCallData>
      <globalCallLinkageId>f64b594c-ae2a-416b-9061-96299f8a5ee3</globalCallLinkageId>
    </globalCallData>
  </callLinkageData>
  <privateData>
    <eventOrderIncrement>0</eventOrderIncrement>
    <isCstaOriginated>false</isCstaOriginated>
    <callDirection>Inbound</callDirection>
    <localStatus>Active</localStatus>
    <remoteUser>200</remoteUser>
    <callerName>John Doe</callerName>
    <timestamp>2025-04-30 13:23:32Z</timestamp>
  </privateData>
</EstablishedEvent>

The callee, 22334455, then hangs up the call.

Call ended by 22334455
<ConnectionClearedEvent xmlns="http://www.ecma.ch/standards/ecma-323/csta/ed6">
  <monitorCrossRefID>t-12345678</monitorCrossRefID>
  <droppedConnection>
    <callID>SIP/hpbx-00000234</callID>
    <deviceID>22334455</deviceID>
  </droppedConnection>
  <releasingDevice>
    <deviceIdentifier>22334455</deviceIdentifier>
  </releasingDevice>
  <localConnectionInfo>null</localConnectionInfo>
  <cause>Normal Clearing</cause>
  <callLinkageData>
    <globalCallData>
      <globalCallLinkageId>f64b594c-ae2a-416b-9061-96299f8a5ee3</globalCallLinkageId>
    </globalCallData>
  </callLinkageData>
</ConnectionClearedEvent>

<ConnectionClearedEvent xmlns="http://www.ecma.ch/standards/ecma-323/csta/ed6">
  <monitorCrossRefID>u-12345678-200</monitorCrossRefID>
  <droppedConnection>
    <callID>SIP/hpbx-00000233</callID>
    <deviceID>200</deviceID>
  </droppedConnection>
  <releasingDevice>
    <deviceIdentifier>22334455</deviceIdentifier>
  </releasingDevice>
  <localConnectionInfo>null</localConnectionInfo>
  <cause>Normal Clearing</cause>
  <callLinkageData>
    <globalCallData>
      <globalCallLinkageId>f64b594c-ae2a-416b-9061-96299f8a5ee3</globalCallLinkageId>
    </globalCallData>
  </callLinkageData>
</ConnectionClearedEvent>