Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

The retrieveCall function

Updated on October 6, 2021

The retrieveCall function is called to retrieve the call in 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 CTI toolbar.

This function uses the following parameters:

Parameters of the retrieveCall function

callIdThe call identifier that is used to answer the call.
optionsThe object that holds the additional parameters that are required to complete the request.
successThe call back function that is invoked on success.
failureThe call back function that is invoked on failure.

To send the retrieve call request to the CTI server, copy the function from the interface file and implement it.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us