Call Operations

This API allows you to monitor or whisper a call.

Sample Request

curl --request POST \
     --url \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

📘 Important!

Before we begin, note that the * sign denotes the mandatory variables in each table.

Request Variables (Body Params)

The following parameter is required to monitor or whisper a call.

Variable NameDescriptionData Type
type*Type of Call Operation to be performed. 1: Monitor, 2: Whisper, 3:Barge 4: Transferinteger
agent_idUnique ID of the Agent who can monitor or can whisper during the call, is only required in case of type: 1 (Monitor), 2 (Whisper)string
call_id*Unique ID of the call on which operations needs to be performed.string
intercomUnique intercom number of the agent to whom call would be transferred, only required in case of type: 4 (Transfer)array of strings

Response Variables

The response returned is as following:

Variable NameDescriptionData Type
SuccessThe request success status, the possible values are: True (default) for success. False for failure.Boolean
MessageThe message corresponding to the success status. For example, in 400 Response where the "success" variable pops as True, the message displayed is shown here.String
Click Try It! to start a request and see the response here!