IraCPA API

Make CPA Request

This API sends the CPA request, followed by the RTP data.

Request Body (json)

Use text mode in the websocket to send this json request. Keep listening to any replies asynchronously.

Key	Description	Example	Default
tenant_id required \| `string`	Name of the licensee	`acme`	None
config_name required \| `string`	Unique name for the configuration	`"my_setup"`	None
sampling_rate optional \| `integer`	Sampling rate of the audio	`16000`	`8000`
call_uuid optional \| `string`	Call_uuid to be associated with the transaction(If used with IraVoice)	Generated	None
pod_id optional \| `string`	Calling application instance	None	None

Sample Request (json)


Code
{
  "tenant_id": "acme",
  "config_name": "my_setup"
}

This API request will initialize the CPA analyser. After the request is sent, the websocket mode should be changed to binary, and RTP data should be sent in 16 bit PCM format. Preferably send 4000 bytes every 250 milliseconds. The results will be coming back whenever the CPA analyser makes a detection.

Response Body (json)

Field	Description
result `string`	Results for EAMD analysis `LV` - Live Voice `AM` - Answering Machine `TO` - Time out, total time exceeded `FX` - Fax `BP` - Beep `SL` - Silence `RT` - RingTone `SIT` - Special information tones `EAM` - Extended Answering Machine (Triggered when an answering machine is detected after a ringtone.) `IBP` - Immediate Beep (Triggered when a beep is detected within the first 1.75 seconds.) Results for AMD analysis `LV` - Live Voice `AM` - Answering Machine `TO` - Time out, total time exceeded `FX` - Fax `BP` - Beep `SL` - Silence `SIT` - Special information tones The result could also be a custom tone specified under tones. `01` - Mandatory fields are not specified `03` - Specified CPA configuration not found `04` - No license available for the tenant `05` - Specified CPA analyzer not found `06` - RTP data was sent without initializing the analyser
reason `string`	Will provide the descriptive message about the result.
break `bool`	`true` / `false` - Tells the caller to stop sending RTP and disconnect the session.
max_energy `Integer`	The maximum energy found in the voice data.
pattern `string`	Energy pattern seen in the voice data.
duration `Integer`	Duration of the data analyzed.
request_count `Integer`	Count of the requests handled so far.
real_time `Integer`	It is the time taken to send the audio to IraCpa for Analysis.
sampling_rate `Integer`	Specified sampling rate of the analysed audio file.
voice_filename `Integer`	Path to the raw file created
freq_found `Integer`	Detected frequency of the audio
initial_silence_found `Integer`	Duration of the silence found in ms
initial_silence_ignored `Integer`	Duration of the silence ignored in ms
call_uuid `Integer`	UUID of the call(When CPA is used alongside IraVoice)

Sample response


Code
***************{

   "avg_energy": 2990,
   "break": true,
   "call_uuid": "4463116f-e604-4099-9695-4b9af06cf7bd",
   "duration": "2.88",
   "freq_found": 0,
   "initial_silence_found": 1125,
   "initial_silence_ignored": 1125,
   "max_energy": 10087,
   "pattern": "11111110000000",
   "real_time": 2989,
   "request_count": 140,
   "result": "LV",
   "sampling_rate": 8000,
   "voice_filename": ""
}

Last modified on July 15, 2026

Set CPA Params Detection Edge Cases

Request Body (json)

Use text mode in the websocket to send this json request. Keep listening to any replies asynchronously.

Key

Description

Example

Default

tenant_id
required | string

Name of the licensee

acme

None

config_name
required | string

Unique name for the configuration

"my_setup"

None

sampling_rate
optional | integer

Sampling rate of the audio

16000

8000

call_uuid
optional | string

Call_uuid to be associated with the transaction(If used with IraVoice)

Generated

None

pod_id
optional | string

Calling application instance

None

Sample Request (json)

Code

{
  "tenant_id": "acme",
  "config_name": "my_setup"
}

Response Body (json)

Field

Description

result
string

Results for EAMD analysis

LV - Live Voice
AM - Answering Machine
TO - Time out, total time exceeded
FX - Fax
BP - Beep
SL - Silence
RT - RingTone
SIT - Special information tones
EAM - Extended Answering Machine (Triggered when an answering machine is detected after a ringtone.)
IBP - Immediate Beep (Triggered when a beep is detected within the first 1.75 seconds.)

Results for AMD analysis

LV - Live Voice
AM - Answering Machine
TO - Time out, total time exceeded
FX - Fax
BP - Beep
SL - Silence
SIT - Special information tones

The result could also be a custom tone specified under tones.

01 - Mandatory fields are not specified
03 - Specified CPA configuration not found
04 - No license available for the tenant
05 - Specified CPA analyzer not found
06 - RTP data was sent without initializing the analyser

reason
string

Will provide the descriptive message about the result.

break
bool

true / false - Tells the caller to stop sending RTP and disconnect the session.

max_energy
Integer

The maximum energy found in the voice data.

pattern
string

Energy pattern seen in the voice data.

duration
Integer

Duration of the data analyzed.

request_count
Integer

Count of the requests handled so far.

real_time
Integer

It is the time taken to send the audio to IraCpa for Analysis.

sampling_rate
Integer

Specified sampling rate of the analysed audio file.

voice_filename
Integer

Path to the raw file created

freq_found
Integer

Detected frequency of the audio

initial_silence_found
Integer

Duration of the silence found in ms

initial_silence_ignored
Integer

Duration of the silence ignored in ms

call_uuid
Integer

UUID of the call(When CPA is used alongside IraVoice)

Sample response

Code

***************{

   "avg_energy": 2990,
   "break": true,
   "call_uuid": "4463116f-e604-4099-9695-4b9af06cf7bd",
   "duration": "2.88",
   "freq_found": 0,
   "initial_silence_found": 1125,
   "initial_silence_ignored": 1125,
   "max_energy": 10087,
   "pattern": "11111110000000",
   "real_time": 2989,
   "request_count": 140,
   "result": "LV",
   "sampling_rate": 8000,
   "voice_filename": ""
}

Last modified on July 15, 2026