Class: Telnyx::Models::UacConnectionUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/uac_connection_update_params.rb

Overview

See Also:

Defined Under Namespace

Modules: NoiseSuppression, SipUriCallingPreference, WebhookAPIVersion Classes: ExternalUacSettings, Inbound, InternalUacSettings, Outbound

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(destination_uri: nil) ⇒ Object

Some parameter documentations has been truncated, see InternalUacSettings for more details.

Internal Telnyx-side settings for a UAC connection.

Parameters:

  • destination_uri (String) (defaults to: nil) —

    The SIP URI that Telnyx will call when handling an inbound request from the exte




# File 'lib/telnyx/models/uac_connection_update_params.rb', line 560

Instance Attribute Details

#active ⇒ Boolean?

Defaults to true

Returns:

  • (Boolean, nil) 


19
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 19

optional :active, Telnyx::Internal::Type::Boolean

#anchorsite_override ⇒ Symbol, ...

‘Latency` directs Telnyx to route media through the site with the lowest round-trip time to the user’s connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

Returns:



27
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 27

optional :anchorsite_override, enum: -> { Telnyx::AnchorsiteOverride }

#android_push_credential_id ⇒ String?

The uuid of the push credential for Android

Returns:

  • (String, nil) 


33
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 33

optional :android_push_credential_id, String, nil?: true

#call_cost_in_webhooks ⇒ Boolean?

Specifies if call cost webhooks should be sent for this connection.

Returns:

  • (Boolean, nil) 


39
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 39

optional :call_cost_in_webhooks, Telnyx::Internal::Type::Boolean

#connection_name ⇒ String?

A user-assigned name to help manage the connection.

Returns:

  • (String, nil) 


45
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 45

optional :connection_name, String

#default_on_hold_comfort_noise_enabled ⇒ Boolean?

When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout.

Returns:

  • (Boolean, nil) 


53
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 53

optional :default_on_hold_comfort_noise_enabled, Telnyx::Internal::Type::Boolean

#dtmf_type ⇒ Symbol, ...

Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.

Returns:



60
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 60

optional :dtmf_type, enum: -> { Telnyx::DtmfType }

#encode_contact_header_enabled ⇒ Boolean?

Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.

Returns:

  • (Boolean, nil) 


67
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 67

optional :encode_contact_header_enabled, Telnyx::Internal::Type::Boolean

#encrypted_media ⇒ Symbol, ...

Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TLS.

Returns:



74
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 74

optional :encrypted_media, enum: -> { Telnyx::EncryptedMedia }, nil?: true

#external_uac_settings ⇒ Telnyx::Models::UacConnectionUpdateParams::ExternalUacSettings?

External SIP peer settings used by Telnyx when registering to your PBX and routing outbound calls.

Returns:



81
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 81

optional :external_uac_settings, -> { Telnyx::UacConnectionUpdateParams::ExternalUacSettings }

#id ⇒ String

Returns:

  • (String) 


13
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 13

required :id, String

#inbound ⇒ Telnyx::Models::UacConnectionUpdateParams::Inbound?

Inbound settings that can be supplied when creating or updating a UAC connection. The SIP subdomain fields returned in UAC connection responses are generated by Telnyx and are not accepted as request parameters.

Returns:



89
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 89

optional :inbound, -> { Telnyx::UacConnectionUpdateParams::Inbound }

#internal_uac_settings ⇒ Telnyx::Models::UacConnectionUpdateParams::InternalUacSettings?

Internal Telnyx-side settings for a UAC connection.

Returns:



95
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 95

optional :internal_uac_settings, -> { Telnyx::UacConnectionUpdateParams::InternalUacSettings }

#ios_push_credential_id ⇒ String?

The uuid of the push credential for Ios

Returns:

  • (String, nil) 


101
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 101

optional :ios_push_credential_id, String, nil?: true

#jitter_buffer ⇒ Telnyx::Models::ConnectionJitterBuffer?

Configuration options for Jitter Buffer. Enables Jitter Buffer for RTP streams of SIP Trunking calls. The feature is off unless enabled. You may define min and max values in msec for customized buffering behaviors. Larger values add latency but tolerate more jitter, while smaller values reduce latency but are more sensitive to jitter and reordering.

Returns:



111
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 111

optional :jitter_buffer, -> { Telnyx::ConnectionJitterBuffer }

#noise_suppression ⇒ Symbol, ...

Controls when noise suppression is applied to calls. When set to ‘inbound’, noise suppression is applied to incoming audio. When set to ‘outbound’, it’s applied to outgoing audio. When set to ‘both’, it’s applied in both directions. When set to ‘disabled’, noise suppression is turned off.

Returns:



120
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 120

optional :noise_suppression, enum: -> { Telnyx::UacConnectionUpdateParams::NoiseSuppression }

#noise_suppression_details ⇒ Telnyx::Models::ConnectionNoiseSuppressionDetails?

Configuration options for noise suppression. These settings are stored regardless of the noise_suppression value, but only take effect when noise_suppression is not ‘disabled’. If you disable noise suppression and later re-enable it, the previously configured settings will be used.

Returns:



129
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 129

optional :noise_suppression_details, -> { Telnyx::ConnectionNoiseSuppressionDetails }

#onnet_t38_passthrough_enabled ⇒ Boolean?

Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg’s settings.

Returns:

  • (Boolean, nil) 


137
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 137

optional :onnet_t38_passthrough_enabled, Telnyx::Internal::Type::Boolean

#outbound ⇒ Telnyx::Models::UacConnectionUpdateParams::Outbound?

Returns:



142
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 142

optional :outbound, -> { Telnyx::UacConnectionUpdateParams::Outbound }

#password ⇒ String?

The password to be used as part of the credentials. Must be 8 to 128 characters long.

Returns:

  • (String, nil) 


149
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 149

optional :password, String

#rtcp_settings ⇒ Telnyx::Models::ConnectionRtcpSettings?

Returns:



154
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 154

optional :rtcp_settings, -> { Telnyx::ConnectionRtcpSettings }

#sip_uri_calling_preference ⇒ Symbol, ...

This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI <your-username>@telnyx.com will be connected to your Connection. You can also choose to allow only calls that are originated on any Connections under your account (internal).

Returns:



164
165
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 164

optional :sip_uri_calling_preference,
enum: -> { Telnyx::UacConnectionUpdateParams::SipUriCallingPreference }

#tags ⇒ Array<String>?

Tags associated with the connection.

Returns:

  • (Array<String>, nil) 


171
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 171

optional :tags, Telnyx::Internal::Type::ArrayOf[String]

#user_name ⇒ String?

The user name to be used as part of the credentials. Must be 4-32 characters long and alphanumeric values only (no spaces or special characters).

Returns:

  • (String, nil) 


178
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 178

optional :user_name, String

#webhook_api_version ⇒ Symbol, ...

Determines which webhook format will be used, Telnyx API v1 or v2.

Returns:



184
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 184

optional :webhook_api_version, enum: -> { Telnyx::UacConnectionUpdateParams::WebhookAPIVersion }

#webhook_event_failover_url ⇒ String?

The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as ‘https’.

Returns:

  • (String, nil) 


191
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 191

optional :webhook_event_failover_url, String, nil?: true

#webhook_event_url ⇒ String?

The URL where webhooks related to this connection will be sent. Must include a scheme, such as ‘https’.

Returns:

  • (String, nil) 


198
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 198

optional :webhook_event_url, String

#webhook_timeout_secs ⇒ Integer?

Specifies how many seconds to wait before timing out a webhook.

Returns:

  • (Integer, nil) 


204
 
# File 'lib/telnyx/models/uac_connection_update_params.rb', line 204

optional :webhook_timeout_secs, Integer, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/uac_connection_update_params.rb', line 362