Schemas

BridgeCalls

first_uuid

string · required

Unique identifier of the first call.

second_uuid

string · required

Unique identifier of the second call.

DropCall

call_uuid

string · required

HTTPValidationError

ValidationError[]

MakeCall

campaign_name

string · required

The unique campaign name created either through API or through the monitor portal.

to_number

string · required

Destination phone number.

from_number

string

Caller ID Number.

Default:

object

Any valid json object. If websocket_host, websocket_port, and websocket_app are set, the media will be streamed to the websocket server.

Default: {"disable_recording":false,"stream_on_cpa_events":["LV"],"drop_on_cpa_events":["FX","AM"],"stream_frame_size_ms":200,"bot_inactivity_limit":0}

object

List of channel variables including SIP headers. Variables with prefix sip_h_X- will set the SIP headers

Default: {}

cpa_config

string

If call progress analysis is required to detect answering machines, specify the previously configured cpa config name

Default:

dial_timeout

integer

Timeout for the dialing. If the call is not answered within this time limit, the call will be dropped.

Default: 30

MakeCallDirect

cluster

string · required

Unique ID of the IraVoice cluster

campaign_name

string · required

The unique campaign name created either through API or through the monitor portal.

to_number

string · required

Destination phone number.

from_number

string

Caller ID Number.

Default:

object

Any valid json object. If websocket_host, websocket_port, and websocket_app are set, the media will be streamed to the websocket server.

Default: {"disable_recording":false,"stream_on_cpa_events":["LV"],"drop_on_cpa_events":["FX","AM"],"stream_frame_size_ms":200,"bot_inactivity_limit":0}

object

List of channel variables including SIP headers. Variables with prefix sip_h_X- will set the SIP headers

Default: {}

cpa_config

string

If call progress analysis is required to detect answering machines, specify the previously configured cpa config name

Default:

dial_timeout

integer

Timeout for the dialing. If the call is not answered within this time limit, the call will be dropped.

Default: 30

MakeCallResponse

status

string · required

Status of the API call.

status_code

integer · required

Status code of the API response. 0 indicates success, any non-zero value indicates an error.

Unique identifier of the call if the request is successfully queued.

Indicates if the system has a huge queue of pending requests and the client should slow down the rate of API calls. If you get true in this field, we recommend you to stop calling make call API for 60s to avoid hitting the rate limits.

Default: false

The cluster where the call is being processed. If a campaign is using trunks from multiple clusters, this field can be used to identify the cluster for each call.

StopStream

call_uuid

string · required

TransferCall

call_uuid

string · required

destination

string · required

Default: false

ValidationError

array · required

msg

string · required

type

string · required

input

ctx

object

MakeCall

campaign_name

string · required

The unique campaign name created either through API or through the monitor portal.

to_number

string · required

Destination phone number.

from_number

string

Caller ID Number.

Default:

object

Any valid json object. If websocket_host, websocket_port, and websocket_app are set, the media will be streamed to the websocket server.

Default: {"disable_recording":false,"stream_on_cpa_events":["LV"],"drop_on_cpa_events":["FX","AM"],"stream_frame_size_ms":200,"bot_inactivity_limit":0}

object

List of channel variables including SIP headers. Variables with prefix sip_h_X- will set the SIP headers

Default: {}

cpa_config

string

If call progress analysis is required to detect answering machines, specify the previously configured cpa config name

Default:

dial_timeout

integer

Timeout for the dialing. If the call is not answered within this time limit, the call will be dropped.

Default: 30

MakeCallDirect

cluster

string · required

Unique ID of the IraVoice cluster

campaign_name

string · required

The unique campaign name created either through API or through the monitor portal.

to_number

string · required

Destination phone number.

from_number

string

Caller ID Number.

Default:

object

Any valid json object. If websocket_host, websocket_port, and websocket_app are set, the media will be streamed to the websocket server.

Default: {"disable_recording":false,"stream_on_cpa_events":["LV"],"drop_on_cpa_events":["FX","AM"],"stream_frame_size_ms":200,"bot_inactivity_limit":0}

object

List of channel variables including SIP headers. Variables with prefix sip_h_X- will set the SIP headers

Default: {}

cpa_config

string

If call progress analysis is required to detect answering machines, specify the previously configured cpa config name

Default:

dial_timeout

integer

Timeout for the dialing. If the call is not answered within this time limit, the call will be dropped.

Default: 30

MakeCallResponse

status

string · required

Status of the API call.

status_code

integer · required

Status code of the API response. 0 indicates success, any non-zero value indicates an error.

Unique identifier of the call if the request is successfully queued.

Default: false

The cluster where the call is being processed. If a campaign is using trunks from multiple clusters, this field can be used to identify the cluster for each call.