Class: Telnyx::Models::CredentialConnectionCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/credential_connection_create_params.rb

Overview

See Also:

• Resources::CredentialConnections#create

Defined Under Namespace

Modules: NoiseSuppression, SipUriCallingPreference, WebhookAPIVersion

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

  A user-assigned name to help manage the connection.

• #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::CredentialInbound^?
• #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::CredentialOutbound^?
• #password ⇒ String

  The password to be used as part of the credentials.

• #rtcp_settings ⇒ Telnyx::Models::ConnectionRtcpSettings^?
• #sip_uri_calling_preference ⇒ Symbol, ...

  This feature enables inbound SIP URI calls to your Credential Auth Connection.

• #tags ⇒ Array<String>^?

  Tags associated with the connection.

• #user_name ⇒ String

  The user name to be used as part of the credentials.

• #webhook_api_version ⇒ Symbol, ...

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

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

Instance Method Summary

• #initialize(connection_name:, password:, user_name:, active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, rtcp_settings: nil, sip_uri_calling_preference: nil, tags: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {}) ⇒ Object constructor

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

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(connection_name:, password:, user_name:, active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, rtcp_settings: nil, sip_uri_calling_preference: nil, tags: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::CredentialConnectionCreateParams for more details.

Parameters:

• connection_name (String) —

  A user-assigned name to help manage the connection.

• password (String) —

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

• user_name (String) —

  The user name to be used as part of the credentials. Must be 4-32 characters lon

• active (Boolean) (defaults to: nil) —

  Defaults to true

• anchorsite_override (Symbol, Telnyx::Models::AnchorsiteOverride) (defaults to: nil) —

  ‘Latency` directs Telnyx to route media through the site with the lowest round-t

• android_push_credential_id (String, nil) (defaults to: nil) —

  The uuid of the push credential for Android

• call_cost_in_webhooks (Boolean) (defaults to: nil) —

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

• default_on_hold_comfort_noise_enabled (Boolean) (defaults to: nil) —

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

• dtmf_type (Symbol, Telnyx::Models::DtmfType) (defaults to: nil) —

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

• encode_contact_header_enabled (Boolean) (defaults to: nil) —

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

• encrypted_media (Symbol, Telnyx::Models::EncryptedMedia, nil) (defaults to: nil) —

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

• inbound (Telnyx::Models::CredentialInbound) (defaults to: nil)
• ios_push_credential_id (String, nil) (defaults to: nil) —

  The uuid of the push credential for Ios

• jitter_buffer (Telnyx::Models::ConnectionJitterBuffer) (defaults to: nil) —

  Configuration options for Jitter Buffer. Enables Jitter Buffer for RTP streams o

• noise_suppression (Symbol, Telnyx::Models::CredentialConnectionCreateParams::NoiseSuppression) (defaults to: nil) —

  Controls when noise suppression is applied to calls. When set to ‘inbound’, nois

• noise_suppression_details (Telnyx::Models::ConnectionNoiseSuppressionDetails) (defaults to: nil) —

  Configuration options for noise suppression. These settings are stored regardles

• onnet_t38_passthrough_enabled (Boolean) (defaults to: nil) —

  Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly

• outbound (Telnyx::Models::CredentialOutbound) (defaults to: nil)
• rtcp_settings (Telnyx::Models::ConnectionRtcpSettings) (defaults to: nil)
• sip_uri_calling_preference (Symbol, Telnyx::Models::CredentialConnectionCreateParams::SipUriCallingPreference) (defaults to: nil) —

  This feature enables inbound SIP URI calls to your Credential Auth Connection. I

• tags (Array<String>) (defaults to: nil) —

  Tags associated with the connection.

• webhook_api_version (Symbol, Telnyx::Models::CredentialConnectionCreateParams::WebhookAPIVersion) (defaults to: nil) —

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

• webhook_event_failover_url (String, nil) (defaults to: nil) —

  The failover URL where webhooks related to this connection will be sent if sendi

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

  The URL where webhooks related to this connection will be sent. Must include a s

• webhook_timeout_secs (Integer, nil) (defaults to: nil) —

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

• request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/telnyx/models/credential_connection_create_params.rb', line 187

Instance Attribute Details

#active ⇒ Boolean^?

Defaults to true

Returns:

• (Boolean, nil)

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

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/credential_connection_create_params.rb', line 42

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/credential_connection_create_params.rb', line 48

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/credential_connection_create_params.rb', line 54

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

#connection_name ⇒ String

A user-assigned name to help manage the connection.

Returns:

• (String)

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

required :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/credential_connection_create_params.rb', line 62

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/credential_connection_create_params.rb', line 69

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/credential_connection_create_params.rb', line 76

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/credential_connection_create_params.rb', line 83

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

#inbound ⇒ Telnyx::Models::CredentialInbound^?

Returns:

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

# File 'lib/telnyx/models/credential_connection_create_params.rb', line 88

optional :inbound, -> { Telnyx::CredentialInbound }

#ios_push_credential_id ⇒ String^?

The uuid of the push credential for Ios

Returns:

• (String, nil)

# File 'lib/telnyx/models/credential_connection_create_params.rb', line 94

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/credential_connection_create_params.rb', line 104

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::CredentialConnectionCreateParams::NoiseSuppression, nil)

# File 'lib/telnyx/models/credential_connection_create_params.rb', line 113

optional :noise_suppression, enum: -> { Telnyx::CredentialConnectionCreateParams::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/credential_connection_create_params.rb', line 122

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/credential_connection_create_params.rb', line 130

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

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

Returns:

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

# File 'lib/telnyx/models/credential_connection_create_params.rb', line 135

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

#password ⇒ String

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

Returns:

• (String)

# File 'lib/telnyx/models/credential_connection_create_params.rb', line 21

required :password, String

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

Returns:

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

# File 'lib/telnyx/models/credential_connection_create_params.rb', line 140

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:

• (Symbol, Telnyx::Models::CredentialConnectionCreateParams::SipUriCallingPreference, nil)

# File 'lib/telnyx/models/credential_connection_create_params.rb', line 150

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

#tags ⇒ Array<String>^?

Tags associated with the connection.

Returns:

• (Array<String>, nil)

# File 'lib/telnyx/models/credential_connection_create_params.rb', line 157

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)

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

required :user_name, String

#webhook_api_version ⇒ Symbol, ...

Determines which webhook format will be used, Telnyx API v1, v2 or texml. Note - texml can only be set when the outbound object parameter call_parking_enabled is included and set to true.

Returns:

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

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

optional :webhook_api_version, enum: -> { Telnyx::CredentialConnectionCreateParams::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/credential_connection_create_params.rb', line 172

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/credential_connection_create_params.rb', line 179

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/credential_connection_create_params.rb', line 185

optional :webhook_timeout_secs, Integer, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/credential_connection_create_params.rb', line 255