Call Control

When you enable the Click to Dial feature for a user, and when the user initiates an outbound call within Zoho PhoneBridge, the provider can provide additional call controls to the user such as mute, unmute, hold, unhold, answer, hang up, and keypress.

Purpose

To enable or disable the Call Control feature for a user.

Request URL

https://www.zohoapis.com/phonebridge/v3/callcontrol

Request Method

POST - To enable call control

DELETE - To disable call control

Request Parameters

Parameter Name	Data Type	Description	Possible Values
answeruri	String	To send a request to answer the call.	https://api.pbx.com/zoho/answeruri
hungupuri	String	To send a request to hang up the call.	https://api.pbx.com/zoho/hungupuri
muteuri	String	To send a request to mute the call.	https://api.pbx.com/zoho/muteuri
unmuteuri	String	To send a request to unmute the call.	https://api.pbx.com/zoho/unmuteuri
holduri	String	To send a request to put the call on hold.	https://api.pbx.com/zoho/holduri
unholduri	String	To send a request to resume a call from hold.	https://api.pbx.com/zoho/unholduri
keypressuri	String	To send the details about the keys/digits pressed during the call.	https://api.pbx.com/zoho/keypressuri
zohouser	String	To enable call control for multiple users, call this API multiple times by passing the zohouser parameter in your API request. zohouser is the ID of the PhoneBridge user who is making the outbound call. Both incoming and outgoing notifications will be enabled for the mentioned users.	--
authorizationparam	String	A JSON object containing the name and value of the authorization details as a key-value pair.	{name:param/header_name,value:token value}
callcontrolparam	String	A JSON array of any custom parameters. There are no limits on the number of key-value pairs you can send in this parameter.	[{name:pbxuserid,value:pbxuser1234}, {name:emailaddress,value:xyz@pbx.com}]

Note

By default, when a user uses clicktodial from Zoho products, we will call your API and pass the callee phone number in the tonumber parameter.
If you want to send the callee phone number in any other parameter other than tonumber, pass the name and the callee number as a key-value pair in clicktodialparam.

Possible Errors

HTTP Status	Error Code	Message	Reason
400	SC_BAD_REQUEST	PROVIDER_NOT_REGISTERED	The PhoneBridge registration information is not available for the Provider name obtained from the OAuth Token object.
400	SC_BAD_REQUEST	PROVIDER_NOT_INTEGRATED	The Provider is not integrated with PhoneBridge.
403	SC_FORBIDDEN	NO_PERMISSION	The telephony integration is not accessible for the current user's license.
403	SC_FORBIDDEN	NO_PERMISSION	Requested user does not have enough privilege to perform this process.
500	SC_INTERNAL_SERVER_ERROR	INTERNAL_ERROR	An exception occurred while processing the request.

Sample Request to Enable Call Controls

Copiedcurl "https://www.zohoapis.com/phonebridge/v3/callcontrol" 
-X POST
-d "answeruri=https://pbx.com/answeruri"
-H "Authorization: Zoho-oauthtoken 1000.xxxxxxxxxxxxx.ebd1"

Sample Response

Copied{
	"message": "(Provider Name) Call control notifications has been enabled for the account successfully",
	"status":"success",
	"code":"SUCCESS"
}

Sample Request to Disable Call Controls

Copiedcurl "https://www.zohoapis.com/phonebridge/v3/callcontrol" 
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.xxxxxxxxxxxxx.ebd1"

Sample Response

Copied{
	"message": "(Provider Name) Call control notifications has been disabled for the account successfully",
	"status":"success",
	"code":"SUCCESS"
}