Class: Telnyx::Models::IPConnectionCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::IPConnectionCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/ip_connection_create_params.rb

Overview

See Also:

• Resources::IPConnections#create

Defined Under Namespace

Modules: NoiseSuppression, TransportProtocol, WebhookAPIVersion Classes: Inbound

Instance Attribute Summary

• #active ⇒ Boolean^?

  Defaults to true.

• #anchorsite_override ⇒ Symbol, ...

  ‘Latency` directs Telnyx to route media through the site with the lowest round-trip time to the user’s connection.

• #android_push_credential_id ⇒ String^?

  The uuid of the push credential for Android.

• #call_cost_in_webhooks ⇒ Boolean^?

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

• #connection_name ⇒ String^?
• #default_on_hold_comfort_noise_enabled ⇒ Boolean^?

  When enabled, Telnyx will generate comfort noise when you place the call on hold.

• #dtmf_type ⇒ Symbol, ...

  Sets the type of DTMF digits sent from Telnyx to this Connection.

• #encode_contact_header_enabled ⇒ Boolean^?

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

• #encrypted_media ⇒ Symbol, ...

  Enable use of SRTP for encryption.

• #inbound ⇒ Telnyx::Models::IPConnectionCreateParams::Inbound^?
• #ios_push_credential_id ⇒ String^?

  The uuid of the push credential for Ios.

• #jitter_buffer ⇒ Telnyx::Models::ConnectionJitterBuffer^?

  Configuration options for Jitter Buffer.

• #noise_suppression ⇒ Symbol, ...

  Controls when noise suppression is applied to calls.

• #noise_suppression_details ⇒ Telnyx::Models::ConnectionNoiseSuppressionDetails^?

  Configuration options for noise suppression.

• #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.

• #outbound ⇒ Telnyx::Models::OutboundIP^?
• #rtcp_settings ⇒ Telnyx::Models::ConnectionRtcpSettings^?
• #tags ⇒ Array<String>^?

  Tags associated with the connection.

• #transport_protocol ⇒ Symbol, ...

  One of UDP, TLS, or TCP.

• #webhook_api_version ⇒ Symbol, ...

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

• #webhook_event_failover_url ⇒ String^?

  The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails.

• #webhook_event_url ⇒ String^?

  The URL where webhooks related to this connection will be sent.

• #webhook_timeout_secs ⇒ Integer^?

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

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

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, #initialize, 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

This class inherits a constructor from Telnyx::Internal::Type::BaseModel

Instance Attribute Details

#active ⇒ Boolean^?

Defaults to true

Returns:

• (Boolean, nil)

# File 'lib/telnyx/models/ip_connection_create_params.rb', line 14

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:

• (Symbol, Telnyx::Models::AnchorsiteOverride, nil)

# File 'lib/telnyx/models/ip_connection_create_params.rb', line 22

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

#android_push_credential_id ⇒ String^?

The uuid of the push credential for Android

Returns:

• (String, nil)

# File 'lib/telnyx/models/ip_connection_create_params.rb', line 28

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)

# File 'lib/telnyx/models/ip_connection_create_params.rb', line 34

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

#connection_name ⇒ String^?

Returns:

• (String, nil)

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

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)

# File 'lib/telnyx/models/ip_connection_create_params.rb', line 47

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:

• (Symbol, Telnyx::Models::DtmfType, nil)

# File 'lib/telnyx/models/ip_connection_create_params.rb', line 54

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)

# File 'lib/telnyx/models/ip_connection_create_params.rb', line 61

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:

• (Symbol, Telnyx::Models::EncryptedMedia, nil)

# File 'lib/telnyx/models/ip_connection_create_params.rb', line 68

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

#inbound ⇒ Telnyx::Models::IPConnectionCreateParams::Inbound^?

Returns:

• (Telnyx::Models::IPConnectionCreateParams::Inbound, nil)

# File 'lib/telnyx/models/ip_connection_create_params.rb', line 73

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

#ios_push_credential_id ⇒ String^?

The uuid of the push credential for Ios

Returns:

• (String, nil)

# File 'lib/telnyx/models/ip_connection_create_params.rb', line 79

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:

• (Telnyx::Models::ConnectionJitterBuffer, nil)

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

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:

• (Symbol, Telnyx::Models::IPConnectionCreateParams::NoiseSuppression, nil)

# File 'lib/telnyx/models/ip_connection_create_params.rb', line 98

optional :noise_suppression, enum: -> { Telnyx::IPConnectionCreateParams::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:

• (Telnyx::Models::ConnectionNoiseSuppressionDetails, nil)

# File 'lib/telnyx/models/ip_connection_create_params.rb', line 107

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)

# File 'lib/telnyx/models/ip_connection_create_params.rb', line 115

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

#outbound ⇒ Telnyx::Models::OutboundIP^?

Returns:

• (Telnyx::Models::OutboundIP, nil)

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

optional :outbound, -> { Telnyx::OutboundIP }

#rtcp_settings ⇒ Telnyx::Models::ConnectionRtcpSettings^?

Returns:

• (Telnyx::Models::ConnectionRtcpSettings, nil)

# File 'lib/telnyx/models/ip_connection_create_params.rb', line 125

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

#tags ⇒ Array<String>^?

Tags associated with the connection.

Returns:

• (Array<String>, nil)

# File 'lib/telnyx/models/ip_connection_create_params.rb', line 131

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

#transport_protocol ⇒ Symbol, ...

One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication.

Returns:

• (Symbol, Telnyx::Models::IPConnectionCreateParams::TransportProtocol, nil)

# File 'lib/telnyx/models/ip_connection_create_params.rb', line 138

optional :transport_protocol, enum: -> { Telnyx::IPConnectionCreateParams::TransportProtocol }

#webhook_api_version ⇒ Symbol, ...

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

Returns:

• (Symbol, Telnyx::Models::IPConnectionCreateParams::WebhookAPIVersion, nil)

# File 'lib/telnyx/models/ip_connection_create_params.rb', line 144

optional :webhook_api_version, enum: -> { Telnyx::IPConnectionCreateParams::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)

# File 'lib/telnyx/models/ip_connection_create_params.rb', line 151

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)

# File 'lib/telnyx/models/ip_connection_create_params.rb', line 158

optional :webhook_event_url, String

#webhook_timeout_secs ⇒ Integer^?

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

Returns:

• (Integer, nil)

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

optional :webhook_timeout_secs, Integer, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/ip_connection_create_params.rb', line 432