Basic call control functions
You can perform basic call state control, such as answering a call, putting a call on
hold, and making a call. Pega Call supports call types that you can
use to circumstance call treatment rules. The pyCallType property
specifies the call types, which include: Each call state activity in the Call Control Panel sends a request to the Computer
Telephony Integration (CTI) server. The CTI server receives a call handling request,
applies appropriate settings, and returns an event that instructs the Call Control Panel
how to handle the call. Basic call control includes the following call handling requests: You must map the CTI server Inbound event to the Pega Platform framework layer, using the
forwardEvent parameter of the login
function. When the Pega Platform layer receives an
Inbound offering event, it applies call control functions
and processes the event. The answerCall function is called to move the call answer state
to an incoming call while in a ringing state. This function uses the
callId parameter to place an answer call request to the CTI server.
If no calls are found in the ringing state, then an error is returned to the Call Control
Panel. This function uses the following parameters: To send the answer call request to the CTI server, copy the function from the interface
file and implement it in your implementation JavaScript file. The holdCall function is used to put an ongoing call on hold.
This function uses the callId parameter to place the hold call request
to the CTI server. This function uses the following parameters: To send the hold call request to the CTI server, copy the function from the interface
file and implement it in your implementation JavaScript file. The makeCall function is used to place a new call to a
destination number that is specified on the interface file. This function uses the
destination parameter to send the new call request to the CTI
server. If the call is successful, then no data is returned from the CTI server. If the make
call request is unsuccessful, then the CTI server returns an error to the Call Control
Panel. This function uses the following parameters: To send the make call request to the CTI server, copy the function from the interface
file and implement it in your implementation JavaScript file. The hangUpCall function is invoked to release an active call
from an established state. This function uses the callId parameter to
place the hang-up call request to the CTI server. If the call is successfully released, then
the state of the call is changed to the released state. If the hangup call request is
unsuccessful, then the CTI server returns an error to the Call Control Panel. This function uses the following parameters: To send the hang up call request to the CTI server, copy the function from the interface
file and implement it in your implementation JavaScript file. The retrieveCall function is called to retrieve the call from a
hold state to an active state. This function uses the callId parameter
to perform a retrieve call request to the CTI server. If the call retrieval is successful,
then the state of the call is changed to the active state. If the request is unsuccessful,
then the CTI server will return an error to the Call Control Panel. This function uses the following parameters: To send the retrieve call request to the CTI server, copy the function from the interface
file and implement it in your implementation JavaScript file. The sendDTMF function is used to send DTMF tones while the call
is on hold. If the request is unsuccessful, then the CTI server returns an error to the Call
Control Panel. This function uses the following parameters: To send the send DTMF tone request to the CTI server, copy the function from the
interface file and implement it in your implementation JavaScript file.Enabling call control
The answerCall function
Parameters of the answerCall function
Parameter Description callId The call identifier options The object that holds the additional parameters that are required to
complete the request success The callback function that is invoked on success failure The callback function that is invoked on failure The holdCall function
Parameters of the holdCall function
Parameter Description callId The call identifier options The object that holds the additional parameters that are required to
complete the request success The callback function that is invoked on success failure The callback function that is invoked on failure The makeCall function
Parameters of the makeCall function
Parameter Description destination The phone number that is used to dial to send the new call
request options The object that holds the additional parameters that are required to
complete the request success The callback function that is invoked on success failure The callback function that is invoked on failure The hangUpCall function
Parameters of the hangUpCall function
Parameter Description callId The call identifier options The object that holds the additional parameters that are required to
complete the request success The callback function that is invoked on success failure The callback function that is invoked on failure The retrieveCall function
Parameters of the retrieveCall function
Parameter Description callId The call identifier options The object that holds the additional parameters that are required to
complete the request success The callback function that is invoked on success failure The callback function that is invoked on failure The sendDTMF function
Parameters of the sendDTMF function
Parameter Description callId The call identifier digits The string of tones that are sent while the call is put on
hold options The object that holds the additional parameters that are required to
complete the request success The callback function that is invoked on success failure The callback function that is invoked on failure
Previous topic CTI functions Next topic Agent state management functions