Click to Dial

When you enable the Click to Dial feature for a user, and when that user initiates an outbound call using the clicktodial button, Zoho PhoneBridge posts the call details to the clicktodial API. Providers can also send the call functionality URLs such as clicktodialuri, zohouser, clicktodialparam and authorizationparam as parameters in this API. Please note that these parameters need to be sent in the URL format.

Purpose

To enable or disable the Click to Dial feature for a user.

Request URL

{{api-domain}}/phonebridge/v3/clicktodial

Request Method

POST - To enable click to dial

DELETE - To disable click to dial

Request Parameters

Parameter Name (* - mandatory)	Data Type	Description	Possible Values
clicktodialuri*	String	To initiate a call from a Zoho record by sending this URL to the Provider.	https://api.pbx.com/zoho/clicktodial
zohouser	String	To enable clicktodial 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}
clicktodialparam	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}] To send the callee phone number in the parameter named callee: [{name:pbxuserid,value:pbxuser1234},{name:emailaddress,value:xyz@pbx.com},{name:callee,value:'{to}'}]

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 Click to Dial

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

Sample Response

Copied{
  "message": "(Provider Name) Clicktodial functionality has been enabled successfully" 
  "status":"success",
  "code":"SUCCESS"
}

Sample Request to Disable Click to Dial

Copiedcurl "https://www.zohoapis.com/phonebridge/v3/clicktodial" 
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.xxxxxxxxxxxxxxx.4ee7"

Sample Response

Copied{
  "message": "(Provider Name) Clicktodial functionality has been disabled successfully" 
  "status":"success",
  "code":"SUCCESS"
}