{
    "campaign_name": "<campaign-name>",
    "tenant_id": "<tenant-id-string>",
    "from_number": "<did-number>",
    "to_number": "<to-number>",
    "dial_prefix": "",
    "dial_timeout": <integer>,
    "event_subject": "",
    "enable_cpa":true/false,
    "cpa_config": "config name",
    "call_params": {
      "call_uuid": "",
      "call_type": "botcompose/voiceform",
      "disable_recording": true/false,
      "disable_streaming": true/false,
      "drop_on_cpa_events": [AM,FX,LV,...],
      "dropcall_on_break": true/false,
      "bot_inactivity_limit":"",
      "pause_bot_when_user_speaks":true/false,
      "silence_threshold_ms": null,
      "stream_on_cpa_events": [AM,FX,LV,...],
      "streaming_useraudio": null,
      "websocket_host": "<host-ip>",
      "websocket_port": "<port-number>",
      "websocket_app":"websocket-path",
      "speech_threshold":"",
      "event_url":"<url-to-your-http-endpoint>",
      "stop_bot_when_user_speaks":true/false,
      "token": "<http-endpoint-bearer-token>",
    },
    "channel_vars": {
      "sip_h_X-<name>": "some value",
      "rtp_secure_media": null
    }
  }

Parameter

Description

call_uuid

Unique identifier for the specific call instance.

call_type

If this field is set to voiceform or botcompose then websocket_host, websocket_port and websocket_app are not needed to be given.

If the call is BotCompose then you can set it to botcompose.

If the call is to Voiceform then you can set it to voiceform

disable_recording

When true, it prevents the call audio from being recorded.

disable_streaming

When true, stops live audio streaming during the call.

dial_timeout

You can specify the time for the dial to timeout. Minimum being 10.

drop_on_cpa_events

List of call progress analysis (CPA) events that should trigger dropping the call (e.g. AM -  voicemail, FX- fax, LV - Live voice).

dropcall_on_break

Ends the call if there is a break in the websocket connection or bot_inactivity_limit is reached..

bot_inactivity_limit

Drops the call if there is no audio sent by the Bot side for a specified duration

pause_bot_when_user_speaks

When true, Pauses the playback of the bot.

silence_threshold_ms

Audio level threshold to consider a segment as silence.

Can range from 200 to 2000, with a default of 800.

stream_on_cpa_events

Specifies which CPA events should trigger streaming.

streaming_useraudio

If true, streams user audio in real time.

websocket_host

Hostname of the Websocket server (your voicebot)

websocket_port

Network port number used for the Websocket connection.

websocket_app

Route path of the websocket URL. Default: "/"

speech_threshold

Speech level threshold to consider a segment as speech

Defines the minimum amplitude level required to classify a segment as speech.

Minimum 200, Maximum 800, Default: 500 

event_url

URL of your HTTP server to which call events will be sent in real time.

stop_bot_when_user_speaks

Stops the Bot Audio from continuing if User interrupts when Bot is playing an audio

dial_prefix

Digits added before the phone number when dialing (e.g., for international or trunk access).

cpa_config

Configuration for Call Progress Analysis (e.g., detecting voicemail, busy tone, etc.).

enable_cpa

Set to true to enable Call Progress Analysis; otherwise, false.

event_subject

Custom NATS Subject 

from_number

Caller ID or number used to place the call.

campaign_name

Campaign name.

tenant_id

Unique ID of the tenant or customer account making the call.

to_number

Destination phone number being called.

channel_vars

Configure one or more custom sip headers.

Eg:  “channel_vars”: { “sip_h_X-CompanyName”: “abc xyz” }