Struct CreateCallParams

pub struct CreateCallParams {

    pub account_sid: String,
    pub to: String,
    pub from: String,
    pub method: Option<String>,
    pub fallback_url: Option<String>,
    pub fallback_method: Option<String>,
    pub status_callback: Option<String>,
    pub status_callback_event: Option<Vec<String>>,
    pub status_callback_method: Option<String>,
    pub send_digits: Option<String>,
    pub timeout: Option<i32>,
    pub record: Option<bool>,
    pub recording_channels: Option<String>,
    pub recording_status_callback: Option<String>,
    pub recording_status_callback_method: Option<String>,
    pub sip_auth_username: Option<String>,
    pub sip_auth_password: Option<String>,
    pub machine_detection: Option<String>,
    pub machine_detection_timeout: Option<i32>,
    pub recording_status_callback_event: Option<Vec<String>>,
    pub trim: Option<String>,
    pub caller_id: Option<String>,
    pub machine_detection_speech_threshold: Option<i32>,
    pub machine_detection_speech_end_threshold: Option<i32>,
    pub machine_detection_silence_timeout: Option<i32>,
    pub async_amd: Option<String>,
    pub async_amd_status_callback: Option<String>,
    pub async_amd_status_callback_method: Option<String>,
    pub byoc: Option<String>,
    pub call_reason: Option<String>,
    pub call_token: Option<String>,
    pub recording_track: Option<String>,
    pub time_limit: Option<i32>,
    pub url: Option<String>,
    pub twiml: Option<String>,
    pub application_sid: Option<String>,
}

struct for passing parameters to the method create_call

Fields

account_sid: String

The SID of the Account that will create the resource.

to: String

The phone number, SIP address, or client identifier to call.

from: String

The phone number or client identifier to use as the caller id. If using a phone number, it must be a Twilio number or a Verified outgoing caller id for your account. If the to parameter is a phone number, From must also be a phone number.

method: Option<String>

The HTTP method we should use when calling the url parameter’s value. Can be: GET or POST and the default is POST. If an application_sid parameter is present, this parameter is ignored.

fallback_url: Option<String>

The URL that we call using the fallback_method if an error occurs when requesting or executing the TwiML at url. If an application_sid parameter is present, this parameter is ignored.

fallback_method: Option<String>

The HTTP method that we should use to request the fallback_url. Can be: GET or POST and the default is POST. If an application_sid parameter is present, this parameter is ignored.

status_callback: Option<String>

The URL we should call using the status_callback_method to send status information to your application. If no status_callback_event is specified, we will send the completed status. If an application_sid parameter is present, this parameter is ignored. URLs must contain a valid hostname (underscores are not permitted).

status_callback_event: Option<Vec<String>>

The call progress events that we will send to the status_callback URL. Can be: initiated, ringing, answered, and completed. If no event is specified, we send the completed status. If you want to receive multiple events, specify each one in a separate status_callback_event parameter. See the code sample for monitoring call progress. If an application_sid is present, this parameter is ignored.

status_callback_method: Option<String>

The HTTP method we should use when calling the status_callback URL. Can be: GET or POST and the default is POST. If an application_sid parameter is present, this parameter is ignored.

send_digits: Option<String>

A string of keys to dial after connecting to the number, maximum of 32 digits. Valid digits in the string include: any digit (0-9), ‘#’, ‘*’ and ‘w’, to insert a half second pause. For example, if you connected to a company phone number and wanted to pause for one second, and then dial extension 1234 followed by the pound key, the value of this parameter would be ww1234#. Remember to URL-encode this string, since the ‘#’ character has special meaning in a URL. If both SendDigits and MachineDetection parameters are provided, then MachineDetection will be ignored.

timeout: Option<i32>

The integer number of seconds that we should allow the phone to ring before assuming there is no answer. The default is 60 seconds and the maximum is 600 seconds. For some call flows, we will add a 5-second buffer to the timeout value you provide. For this reason, a timeout value of 10 seconds could result in an actual timeout closer to 15 seconds. You can set this to a short time, such as 15 seconds, to hang up before reaching an answering machine or voicemail.

record: Option<bool>

Whether to record the call. Can be true to record the phone call, or false to not. The default is false. The recording_url is sent to the status_callback URL.

recording_channels: Option<String>

The number of channels in the final recording. Can be: mono or dual. The default is mono. mono records both legs of the call in a single channel of the recording file. dual records each leg to a separate channel of the recording file. The first channel of a dual-channel recording contains the parent call and the second channel contains the child call.

recording_status_callback: Option<String>

The URL that we call when the recording is available to be accessed.

recording_status_callback_method: Option<String>

The HTTP method we should use when calling the recording_status_callback URL. Can be: GET or POST and the default is POST.

sip_auth_username: Option<String>

The username used to authenticate the caller making a SIP call.

sip_auth_password: Option<String>

The password required to authenticate the user account specified in sip_auth_username.

machine_detection: Option<String>

Whether to detect if a human, answering machine, or fax has picked up the call. Can be: Enable or DetectMessageEnd. Use Enable if you would like us to return AnsweredBy as soon as the called party is identified. Use DetectMessageEnd, if you would like to leave a message on an answering machine. If send_digits is provided, this parameter is ignored. For more information, see Answering Machine Detection.

machine_detection_timeout: Option<i32>

The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with AnsweredBy of unknown. The default timeout is 30 seconds.

recording_status_callback_event: Option<Vec<String>>

The recording status events that will trigger calls to the URL specified in recording_status_callback. Can be: in-progress, completed and absent. Defaults to completed. Separate multiple values with a space.

trim: Option<String>

Whether to trim any leading and trailing silence from the recording. Can be: trim-silence or do-not-trim and the default is trim-silence.

caller_id: Option<String>

The phone number, SIP address, or Client identifier that made this call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as name@company.com.

machine_detection_speech_threshold: Option<i32>

The number of milliseconds that is used as the measuring stick for the length of the speech activity, where durations lower than this value will be interpreted as a human and longer than this value as a machine. Possible Values: 1000-6000. Default: 2400.

machine_detection_speech_end_threshold: Option<i32>

The number of milliseconds of silence after speech activity at which point the speech activity is considered complete. Possible Values: 500-5000. Default: 1200.

machine_detection_silence_timeout: Option<i32>

The number of milliseconds of initial silence after which an unknown AnsweredBy result will be returned. Possible Values: 2000-10000. Default: 5000.

async_amd: Option<String>

Select whether to perform answering machine detection in the background. Default, blocks the execution of the call until Answering Machine Detection is completed. Can be: true or false.

async_amd_status_callback: Option<String>

The URL that we should call using the async_amd_status_callback_method to notify customer application whether the call was answered by human, machine or fax.

async_amd_status_callback_method: Option<String>

The HTTP method we should use when calling the async_amd_status_callback URL. Can be: GET or POST and the default is POST.

byoc: Option<String>

The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that byoc is only meaningful when to is a phone number; it will otherwise be ignored. (Beta)

call_reason: Option<String>

The Reason for the outgoing call. Use it to specify the purpose of the call that is presented on the called party’s phone. (Branded Calls Beta)

call_token: Option<String>

A token string needed to invoke a forwarded call. A call_token is generated when an incoming call is received on a Twilio number. Pass an incoming call’s call_token value to a forwarded call via the call_token parameter when creating a new call. A forwarded call should bear the same CallerID of the original incoming call.

recording_track: Option<String>

The audio track to record for the call. Can be: inbound, outbound or both. The default is both. inbound records the audio that is received by Twilio. outbound records the audio that is generated from Twilio. both records the audio that is received and generated by Twilio.

time_limit: Option<i32>

The maximum duration of the call in seconds. Constraints depend on account and configuration.

url: Option<String>

The absolute URL that returns the TwiML instructions for the call. We will call this URL using the method when the call connects. For more information, see the Url Parameter section in Making Calls.

twiml: Option<String>

TwiML instructions for the call Twilio will use without fetching Twiml from url parameter. If both twiml and url are provided then twiml parameter will be ignored. Max 4000 characters.

application_sid: Option<String>

The SID of the Application resource that will handle the call, if the call will be handled by an application.

Trait Implementations

impl Clone for CreateCallParams

fn clone(&self) -> CreateCallParams

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateCallParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.