Incoming Call Notify API - Ringing

Purpose

To notify the PhoneBridge service of an inbound call when the destination phone rings.

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.	received
state*	String	The status of the incoming call.	ringing
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 customer's number from which the customer calls to reach the agent. Mandatory key.	Accepts a numeric value in E.164 format. Example: +18885554567.
to*	String	The agent's number to which the customer makes the call.	Accepts a numeric value in E.164 format. Example: +18885554567.
transferredcallid	String	The ID of the call you must send to the new agent, in case the call is being transferred to a different agent. Mandatory key only when the value of the key state is ringing.	Accepts an alphanumeric value. Example: callid123456.
zohouser	String	The unique ID of the PhoneBridge user.	--

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=received&state=ringing&id=&from=&to="
-H "Authorization: Zoho-oauthtoken 1000.xxxxxxxxxxxxxxx.4ee7"
-H "Content-Type: application/x-www-form-urlencoded"

Sample Response

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