Click to Dial Error API
Purpose
To notify when a call is not reachable to the caller's desk or a softphone.
Request URL
{{api-domain}}/phonebridge/v3/clicktodialerror
Request Method
POST
Request Parameters
| Parameter Name (* - Mandatory) | Data Type | Description | Possible Values |
|---|---|---|---|
| code* | String | To inform the error code to click-to-dial. | busy, invalid, blocked, notavailable, noanswer, rejected |
| from* | String | The agent's number from which the agent calls to reach the customer. | Accepts a numeric value in E.164 format. Example: +18885554567. |
| to* | String | The customer's number to which the agent makes the call. | Accepts a numeric value in E.164 format. Example: +18885554567. |
| zohouser | String | The unique ID of the PhoneBridge user. | -- |
| message | String | The error message for click-to-dial. | Example: International dialing is disabled for the extension 3201. |
Note
If the "to" and "from" phone numbers contain the "+" symbol, you must encode it.
Possible Errors
| HTTP Status | Error Code | Message | Reason |
|---|---|---|---|
| 400 | SC_BAD_REQUEST | REQUIRED_PARAM_MISSING | You have not specified one or all of the mandatory parameters in the request. |
| 500 | SC_INTERNAL_SERVER_ERROR | INTERNAL_ERROR | An exception occurred while processing the request. |
Sample Request
Copiedcurl "https://www.zohoapis.com/phonebridge/v3/clicktodialerror"
-X POST
-d "code=busy&from="agent number"&to="customer_number"
-H "Authorization: Zoho-oauthtoken 1000.xxxxxxxxxxxxxxx.4ee7"
-H "Content-Type: application/x-www-form-urlencoded"Sample Response
Copied{
"status": "success",
"code": "SUCCESS"
}