post https://api.servetel.in/v1/call/options
This API allows you to monitor or whisper a call.
Sample Request
curl --request POST \
--url https://api.servetel.in/v1/call/options \
--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 Name | Description | Data Type |
|---|---|---|
| type* | Type of Call Operation to be performed. 1: Monitor, 2: Whisper, 3:Barge 4: Transfer | integer |
| agent_id | Unique ID of the Agent who can monitor or can whisper during the call, is only required in case of type: 1 (Monitor), 2 (Whisper). This can be retrieved from fetch users API - Fetch Multiple Users , Variable name- data[i].agent.id. | string |
| call_id* | Unique ID of the call on which operations needs to be performed. | string |
| intercom | Unique 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 Name | Description | Data Type |
|---|---|---|
| Success | The request success status, the possible values are: True (default) for success. False for failure. | Boolean |
| Message | The 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 |