The 3PCC API enables applications to monitor calls, make calls, and modify existing calls.

Command Summary

Command Description BST Support Endpoint
makeCall Place a new call Yes POST /api/v1/calls
getCalls List active calls for user Yes GET /api/v1/calls/{callObserverId}
getCall Get details of a specific call Yes GET /api/v1/calls/{callObserverId}
parkCall Park a call at a location Yes POST /api/v1/calls/{callId}
answerCall Answer a ringing call No (MiNET/Poly only) POST /api/v1/calls/{callObserverId}
hangupCall Hang up a call Yes POST /api/v1/calls/{callObserverId}
deflectCall Deflect ringing call to coverage Yes POST /api/v1/calls/{callId}
holdCall Put a call on hold No (MiNET/Poly only) POST /api/v1/calls/{callId}
resumeCall Resume a held call No (MiNET/Poly only) POST /api/v1/calls/{callId}
transferCall Transfer active and held calls Yes POST /api/v1/calls/{callId2}
retrieveCall Retrieve a parked call Yes POST /api/v1/calls

BST = Basic SIP Terminal. BST phones must handle 2+ concurrent calls, have available line appearances, and accept/send reINVITEs.

makeCall

Places a call. Supports BYON (Bring Your Own Number) to place calls from an external number.

POST https://{ip}/api/v1/calls
{
  "request": "makeCall",
  "from": "102@tenantId",
  "to": "912125551212"
}

With external device (BYON):

POST https://{ip}/api/v1/calls
{
  "request": "makeCall",
  "from": "102@tenantId",
  "to": "912125551212",
  "deviceIdType": "external",
  "deviceId": "{external number}"
}

getCalls

Gets a list of active calls for the authorized user.

GET https://{ip}/api/v1/calls/{callObserverId}

getCall

Gets the details of a particular call.

GET https://{ip}/api/v1/calls/{callObserverId}

answerCall