Standard Programmable Voice APIs

Anonymize Call Flow

For the Anonymize or number masking use-case, an API is required from the user (1) (It will be called as “user’s API” (2).), which will provide the B party’s number in the API response for a given A party’s number in the API request body.

[1: “user” refers to the Enterprise who needs the Number Masking solution.]

[2: “user’s API” is the API implemented and provided by the user for determining the B party’s (destination) number for a given A party’s (caller) number.]

Request Body

copy

{
	"uuid": "$uuid",
	"call_id": "$call_id",
	"call_to_number": "$call_to_number",
	"caller_id_number": "$caller_id_number",
	"start_stamp": "$start_stamp"
}

Request Variables

The below data is sent to the user’s API.

Response Variables

The call transfers based on B party’s number. The user’s API should return the country-code prefixed phone number of the B party in the API response to transfer the call to the B party’s number. The below example shows a sample API response to transfer the call based on B party’s number where “XXXXXXXXXX” is the B party’s number prefixed with country calling code.

Sample transfer objects

copy

[{
	"transfer": {
		"type": "number",
		"data": ["XXXXXXXXXX"]
	}
}]

Click to Call API

Sample Request (cURL)

copy

curl --request POST \
--url {ENDPOINT}v1/click_to_call \
--header 'Authorization: <AUTHORIZATION_VALUE>' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{"agent_number":"+9190XXXXXXXX9","destination_number":"+9180XXXXXXXX9"}'

Request variables (Body params)

The body params used for making calls are:

Response variables

The response is as following:

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:

JSON

copy

{
	"success": true,
	"message": "Originate successfully queued"
}

Generate Outbound Call API (OTP or Voice Announcement)

Announcement of Voice on an outbound call can be started by calling the below-mentioned two APIs one after the other,
that is, first call the “Lead API”, then call the “Click to Call Support API”. The following examples are for the
announcement of OTP (One Time Password) on an outbound call. Similarly, other messages can also be announced using
similar format of the APIs.

Similarly, other messages can also be announced using similar format of the APIs.

A) Lead API

Sample Request (cURL)

copy

curl --request POST \
--url '{ENDPOINT}/v1/broadcast/lead/<LEAD_ID>' \
--header 'Authorization: <AUTHORIZATION_VALUE>'
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{"field_0":"XXXXXXXXXX","field_5":"123456", "duplicate_option": "overwrite"}'

Path Parameters

The body params used for making calls are:

Request Variables

The response is as following:

Response Variables

B) Click to Call Support API

Sample Request (cURL)

copy

curl --request POST \
--url '{ENDPOINT}/v1/c2c_api' \
--header 'Authorization: <AUTHORIZATION_VALUE>'
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{"customer_number":"XXXXXXXXXX","api_key":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"}'

Request Variables

Response Variables

Fetch Call Detail Records

Sample Request

copy

curl --request GET \
--url '{ENDPOINT}/v1/call/records' \
--header 'Accept: application/json' \
--header 'Authorization: <AUTHORIZATION_VALUE>'

Request Variables (Query Params)

Response Variables

It takes a JSON body with the following notable parameters:

Call Hangup API

Presently, active/live call can be hung up by using the below method.

Request Variables

Sample Request (cURL)

copy

curl --request POST \
--url '{ENDPOINT}/v1/call/hangup' \
--header 'Authorization: <AUTHORIZATION_VALUE>'
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{"call_id": "XXXXXXXXXXXX"}'

Response Variables

Sample Response

copy

{
	"success": true,
	"message": "Call hangup successful"
}

Call Transfer

Add Agent

To transfer an active call to an agent (B2), the agent B2 must first be added as an agent into the system
if the agent is not added yet. The following is the API to add a new agent into the system.

Request Variables

Sample Request (cURL)

copy

curl --request POST \
--url '{ENDPOINT}/v1/agent' \
--header 'Authorization: <AUTHORIZATION_VALUE>'
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
    	"name": "Test Agent",
	"follow_me_number": XXXXXXXXXX,
	"intercom": XXXX,
}'

Response Variables

Sample Response

copy

{
	"success": true,
	"message": "Agent added successfully",
	""agent_id": "XXXXXXXXXXXXXX",
}

Get Agent Details

If the agent (B2) is already added, you can get the agent’s details using the following method.

Sample Request (cURL)

copy

curl --request GET \
--url '{ENDPOINT}/v1/agents' \
--header 'Authorization: <AUTHORIZATION_VALUE>' 
--header 'accept: application/json'

Sample Response

copy

[{
	"id": 111111,
	"name": "Test Agent",
	"follow_me_number": "+91XXXXXXXXXX",
	"eid": "XXXXXXXXXXXXXXX",
	"intercom": null,
	"calls_answered": 1,
	"calls_missed": 0,
	"custom_status": 0,
	"timegroup_name": null,
	"timegroup_id": null,
	"failover_destination": null,
	"failover_destination_name": null,
	"is_verified": 1,
	"departments": [],
	"allowed_caller_ids": [{
		"id": "2222222",
		"number": "91XXXXXXXXXX"
	}],
	"agent_cdr": false,
	"associated_agent": false,
	"agent_groups": [],
	"sticky_settings": {
		"timeout": null,
		"ring_strategy": null,
		"alternate_numbers": [
			""
		]
	}
}]

Response Variables

Transfer Call using API

To transfer a call to another agent, use the following method.

Request Variables

Sample Request (cURL)

copy

curl --request POST \
--url '{ENDPOINT}/v1/call/options' \
--header 'Authorization: <AUTHORIZATION_VALUE>'
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
	"type": 4,
	"call_id": "XXXXXXXXXXXXX",
	"agent_id": "XXXXXXXXXXXXX",
	"intercom": "XXXXXXXXXX"
}'

Response Variables

Sample Request (cURL)

copy

{
	"success": true,
	"message": "Redirect successful"
}