Class: Telnyx::Models::Texml::Accounts::CallCallsParams::Body::ApplicationDefault

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/texml/accounts/call_calls_params.rb

Defined Under Namespace

Modules: AsyncAmdStatusCallbackMethod, DeepfakeDetection, DeepfakeDetectionCallbackMethod, DetectionMode, MachineDetection, MediaEncryption, RecordingChannels, RecordingStatusCallbackMethod, RecordingTrack, SipRegion, StatusCallbackEvent, StatusCallbackMethod, SupervisingRole, Trim, URLMethod Classes: CustomHeader

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(name:, value:) ⇒ Object

Parameters:

  • name (String) —

    The name of the custom header

  • value (String) —

    The value of the custom header




# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1817

Instance Attribute Details

#application_sid ⇒ String?

The ID of the TeXML Application.

Returns:

  • (String, nil) 


1444
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1444

optional :application_sid, String, api_name: :ApplicationSid

#async_amd ⇒ Boolean?

Select whether to perform answering machine detection in the background. By default execution is blocked until Answering Machine Detection is completed.

Returns:

  • (Boolean, nil) 


1451
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1451

optional :async_amd, Telnyx::Internal::Type::Boolean, api_name: :AsyncAmd

#async_amd_status_callback ⇒ String?

URL destination for Telnyx to send AMD callback events to for the call.

Returns:

  • (String, nil) 


1457
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1457

optional :async_amd_status_callback, String, api_name: :AsyncAmdStatusCallback

#async_amd_status_callback_method ⇒ Symbol, ...

HTTP request type used for ‘AsyncAmdStatusCallback`. The default value is inherited from TeXML Application setting.

Returns:



1464
1465
1466
1467
1468
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1464

optional :async_amd_status_callback_method,
enum: -> {
  Telnyx::Texml::Accounts::CallCallsParams::Body::ApplicationDefault::AsyncAmdStatusCallbackMethod
},
api_name: :AsyncAmdStatusCallbackMethod

#caller_id ⇒ String?

To be used as the caller id name (SIP From Display Name) presented to the destination (‘To` number). The string should have a maximum of 128 characters, containing only letters, numbers, spaces, and `-_~!.+` special characters. If ommited, the display name will be the same as the number in the `From` field.

Returns:

  • (String, nil) 


1477
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1477

optional :caller_id, String, api_name: :CallerId

#cancel_playback_on_detect_message_end ⇒ Boolean?

Whether to cancel ongoing playback on ‘greeting ended` detection. Defaults to `true`.

Returns:

  • (Boolean, nil) 


1484
1485
1486
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1484

optional :cancel_playback_on_detect_message_end,
Telnyx::Internal::Type::Boolean,
api_name: :CancelPlaybackOnDetectMessageEnd

#cancel_playback_on_machine_detection ⇒ Boolean?

Whether to cancel ongoing playback on ‘machine` detection. Defaults to `true`.

Returns:

  • (Boolean, nil) 


1492
1493
1494
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1492

optional :cancel_playback_on_machine_detection,
Telnyx::Internal::Type::Boolean,
api_name: :CancelPlaybackOnMachineDetection

#custom_headers ⇒ Array<Telnyx::Models::Texml::Accounts::CallCallsParams::Body::ApplicationDefault::CustomHeader>?

Custom HTTP headers to be sent with the call. Each header should be an object with ‘name’ and ‘value’ properties.

Returns:



1501
1502
1503
1504
1505
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1501

optional :custom_headers,
-> {
  Telnyx::Internal::Type::ArrayOf[Telnyx::Texml::Accounts::CallCallsParams::Body::ApplicationDefault::CustomHeader]
},
api_name: :CustomHeaders

#deepfake_detection ⇒ Symbol, ...

Enables Deepfake Detection on the dialed call. When enabled, audio from the remote party is analyzed to determine whether the voice is AI-generated. Results are delivered asynchronously via a callback.

Returns:



1513
1514
1515
1516
1517
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1513

optional :deepfake_detection,
enum: -> {
  Telnyx::Texml::Accounts::CallCallsParams::Body::ApplicationDefault::DeepfakeDetection
},
api_name: :DeepfakeDetection

#deepfake_detection_callback_method ⇒ Symbol, ...

HTTP request type used for ‘DeepfakeDetectionCallbackUrl`.

Returns:



1523
1524
1525
1526
1527
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1523

optional :deepfake_detection_callback_method,
enum: -> {
  Telnyx::Texml::Accounts::CallCallsParams::Body::ApplicationDefault::DeepfakeDetectionCallbackMethod
},
api_name: :DeepfakeDetectionCallbackMethod

#deepfake_detection_callback_url ⇒ String?

URL destination for Telnyx to send deepfake detection callback events to for the call.

Returns:

  • (String, nil) 


1534
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1534

optional :deepfake_detection_callback_url, String, api_name: :DeepfakeDetectionCallbackUrl

#detection_mode ⇒ Symbol, ...

Allows you to choose between Regular, Premium, and PremiumCallScreening detections. See developers.telnyx.com/docs/voice/programmable-voice/answering-machine-detection

Returns:



1542
1543
1544
1545
1546
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1542

optional :detection_mode,
enum: -> {
  Telnyx::Texml::Accounts::CallCallsParams::Body::ApplicationDefault::DetectionMode
},
api_name: :DetectionMode

#fallback_url ⇒ String?

A failover URL for which Telnyx will retrieve the TeXML call instructions if the ‘Url` is not responding.

Returns:

  • (String, nil) 


1553
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1553

optional :fallback_url, String, api_name: :FallbackUrl

#from ⇒ String?

The phone number of the party that initiated the call. Phone numbers are formatted with a ‘+` and country code.

Returns:

  • (String, nil) 


1560
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1560

optional :from, String, api_name: :From

#machine_detection ⇒ Symbol, ...

Enables Answering Machine Detection.

Returns:



1566
1567
1568
1569
1570
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1566

optional :machine_detection,
enum: -> {
  Telnyx::Texml::Accounts::CallCallsParams::Body::ApplicationDefault::MachineDetection
},
api_name: :MachineDetection

#machine_detection_prompt_end_timeout ⇒ Integer?

Silence duration threshold after a call screening prompt before ending prompt detection, in milliseconds. Used when ‘DetectionMode` is `PremiumCallScreening`.

Returns:

  • (Integer, nil) 


1577
1578
1579
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1577

optional :machine_detection_prompt_end_timeout,
Integer,
api_name: :MachineDetectionPromptEndTimeout

#machine_detection_silence_timeout ⇒ Integer?

If initial silence duration is greater than this value, consider it a machine. Ignored when ‘premium` detection is used.

Returns:

  • (Integer, nil) 


1586
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1586

optional :machine_detection_silence_timeout, Integer, api_name: :MachineDetectionSilenceTimeout

#machine_detection_speech_end_threshold ⇒ Integer?

Silence duration threshold after a greeting message or voice for it be considered human. Ignored when ‘premium` detection is used.

Returns:

  • (Integer, nil) 


1593
1594
1595
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1593

optional :machine_detection_speech_end_threshold,
Integer,
api_name: :MachineDetectionSpeechEndThreshold

#machine_detection_speech_threshold ⇒ Integer?

Maximum threshold of a human greeting. If greeting longer than this value, considered machine. Ignored when ‘premium` detection is used.

Returns:

  • (Integer, nil) 


1602
1603
1604
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1602

optional :machine_detection_speech_threshold,
Integer,
api_name: :MachineDetectionSpeechThreshold

#machine_detection_timeout ⇒ Integer?

Maximum timeout threshold in milliseconds for overall detection.

Returns:

  • (Integer, nil) 


1610
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1610

optional :machine_detection_timeout, Integer, api_name: :MachineDetectionTimeout

#media_encryption ⇒ Symbol, ...

Defines whether media should be encrypted on the call. When set to ‘SRTP`, the call will use Secure Real-time Transport Protocol for media encryption. When set to `DTLS`, the call will use DTLS for media encryption. Only supported for SIP destinations.

Returns:



1619
1620
1621
1622
1623
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1619

optional :media_encryption,
enum: -> {
  Telnyx::Texml::Accounts::CallCallsParams::Body::ApplicationDefault::MediaEncryption
},
api_name: :MediaEncryption

#preferred_codecs ⇒ String?

The list of comma-separated codecs to be offered on a call.

Returns:

  • (String, nil) 


1629
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1629

optional :preferred_codecs, String, api_name: :PreferredCodecs

#record ⇒ Boolean?

Whether to record the entire participant’s call leg. Defaults to ‘false`.

Returns:

  • (Boolean, nil) 


1635
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1635

optional :record, Telnyx::Internal::Type::Boolean, api_name: :Record

#recording_channels ⇒ Symbol, ...

The number of channels in the final recording. Defaults to ‘mono`.

Returns:



1641
1642
1643
1644
1645
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1641

optional :recording_channels,
enum: -> {
  Telnyx::Texml::Accounts::CallCallsParams::Body::ApplicationDefault::RecordingChannels
},
api_name: :RecordingChannels

#recording_status_callback ⇒ String?

The URL the recording callbacks will be sent to.

Returns:

  • (String, nil) 


1651
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1651

optional :recording_status_callback, String, api_name: :RecordingStatusCallback

#recording_status_callback_event ⇒ String?

The changes to the recording’s state that should generate a call to ‘RecoridngStatusCallback`. Can be: `in-progress`, `completed` and `absent`. Separate multiple values with a space. Defaults to `completed`.

Returns:

  • (String, nil) 


1659
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1659

optional :recording_status_callback_event, String, api_name: :RecordingStatusCallbackEvent

#recording_status_callback_method ⇒ Symbol, ...

HTTP request type used for ‘RecordingStatusCallback`. Defaults to `POST`.

Returns:



1665
1666
1667
1668
1669
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1665

optional :recording_status_callback_method,
enum: -> {
  Telnyx::Texml::Accounts::CallCallsParams::Body::ApplicationDefault::RecordingStatusCallbackMethod
},
api_name: :RecordingStatusCallbackMethod

#recording_timeout ⇒ Integer?

The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected. The timer only starts when the speech is detected. Please note that the transcription is used to detect silence and the related charge will be applied. The minimum value is 0. The default value is 0 (infinite)

Returns:

  • (Integer, nil) 


1678
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1678

optional :recording_timeout, Integer, api_name: :RecordingTimeout

#recording_track ⇒ Symbol, ...

The audio track to record for the call. The default is ‘both`.

Returns:



1684
1685
1686
1687
1688
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1684

optional :recording_track,
enum: -> {
  Telnyx::Texml::Accounts::CallCallsParams::Body::ApplicationDefault::RecordingTrack
},
api_name: :RecordingTrack

#send_recording_url ⇒ Boolean?

Whether to send RecordingUrl in webhooks.

Returns:

  • (Boolean, nil) 


1694
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1694

optional :send_recording_url, Telnyx::Internal::Type::Boolean, api_name: :SendRecordingUrl

#sip_auth_password ⇒ String?

The password to use for SIP authentication.

Returns:

  • (String, nil) 


1700
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1700

optional :sip_auth_password, String, api_name: :SipAuthPassword

#sip_auth_username ⇒ String?

The username to use for SIP authentication.

Returns:

  • (String, nil) 


1706
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1706

optional :sip_auth_username, String, api_name: :SipAuthUsername

#sip_region ⇒ Symbol, ...

Defines the SIP region to be used for the call.

Returns:



1712
1713
1714
1715
1716
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1712

optional :sip_region,
enum: -> {
  Telnyx::Texml::Accounts::CallCallsParams::Body::ApplicationDefault::SipRegion
},
api_name: :SipRegion

#status_callback ⇒ String?

URL destination for Telnyx to send status callback events to for the call.

Returns:

  • (String, nil) 


1722
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1722

optional :status_callback, String, api_name: :StatusCallback

#status_callback_event ⇒ Symbol, ...

The call events for which Telnyx should send a webhook. Multiple events can be defined when separated by a space.

Returns:



1729
1730
1731
1732
1733
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1729

optional :status_callback_event,
enum: -> {
  Telnyx::Texml::Accounts::CallCallsParams::Body::ApplicationDefault::StatusCallbackEvent
},
api_name: :StatusCallbackEvent

#status_callback_method ⇒ Symbol, ...

HTTP request type used for ‘StatusCallback`.

Returns:



1739
1740
1741
1742
1743
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1739

optional :status_callback_method,
enum: -> {
  Telnyx::Texml::Accounts::CallCallsParams::Body::ApplicationDefault::StatusCallbackMethod
},
api_name: :StatusCallbackMethod

#supervise_call_sid ⇒ String?

The call control ID of the existing call to supervise. When provided, the created leg will be added to the specified call in supervising mode. Status callbacks and action callbacks will NOT be sent for the supervising leg.

Returns:

  • (String, nil) 


1751
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1751

optional :supervise_call_sid, String, api_name: :SuperviseCallSid

#supervising_role ⇒ Symbol, ...

The supervising role for the new leg. Determines the audio behavior: barge (hear both sides), whisper (only hear supervisor), monitor (hear both sides but supervisor muted). Default: barge

Returns:



1759
1760
1761
1762
1763
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1759

optional :supervising_role,
enum: -> {
  Telnyx::Texml::Accounts::CallCallsParams::Body::ApplicationDefault::SupervisingRole
},
api_name: :SupervisingRole

#texml ⇒ String?

Returns:

  • (String, nil) 


1768
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1768

optional :texml, String, api_name: :Texml, nil?: true

#time_limit ⇒ Integer?

The maximum duration of the call in seconds. The minimum value is 30 and the maximum value is 14400 (4 hours). Default is 14400 seconds.

Returns:

  • (Integer, nil) 


1775
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1775

optional :time_limit, Integer, api_name: :TimeLimit

#timeout ⇒ Integer?

The number of seconds to wait for the called party to answer the call before the call is canceled. The minimum value is 5 and the maximum value is 120. Default is 30 seconds.

Returns:

  • (Integer, nil) 


1783
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1783

optional :timeout, Integer, api_name: :Timeout

#to ⇒ String?

The phone number of the called party. Phone numbers are formatted with a ‘+` and country code.

Returns:

  • (String, nil) 


1790
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1790

optional :to, String, api_name: :To

#trim ⇒ Symbol, ...

Whether to trim any leading and trailing silence from the recording. Defaults to ‘trim-silence`.

Returns:



1797
1798
1799
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1797

optional :trim,
enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Body::ApplicationDefault::Trim },
api_name: :Trim

#url ⇒ String?

Returns:

  • (String, nil) 


1804
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1804

optional :url, String, api_name: :Url, nil?: true

#url_method ⇒ Symbol, ...

HTTP request type used for ‘Url`. The default value is inherited from TeXML Application setting.

Returns:



1811
1812
1813
1814
1815
 
# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1811

optional :url_method,
enum: -> {
  Telnyx::Texml::Accounts::CallCallsParams::Body::ApplicationDefault::URLMethod
},
api_name: :UrlMethod

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/texml/accounts/call_calls_params.rb', line 1922