Outgoing Call Notify API - Unattended

Purpose

To notify when a call is unattended.

Request URL

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

Request Method

POST

Request Parameters

Parameter Name (* - Mandatory)	Data Type	Description	Possible Values
type*	String	The type of call.	dialed
state*	String	The status of the outgoing call.	busy, invalid, blocked, notavailable, noanswer, rejected
id*	String	Unique ID used to identify each call made. This helps to pull up info about a particular call easily.	Accepts an alphanumeric value. Example: callid123456.
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.	--
start_time*	String	The time at which the customer has called the agent, in the format yyyy-MM-dd HH:mm:ss. The time zone must be GMT.	Example: 2019-09-20 15:09:10.
voiceuri	String	The file path to the voice message i.e., the URL of the audio file where the voice message is available.	--

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/callnotify 
-X POST
-d "type=dialed&state=busy&id=&from=&to=&start_time="
-H "Authorization: Zoho-oauthtoken 1000.xxxxxxxxxxxxxxx.4ee7"
-H "Content-Type: application/x-www-form-urlencoded"

Sample Response

Copied{
    "status": "success",
    "code": "SUCCESS"
}