Class: Telnyx::Resources::FqdnConnections

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/fqdn_connections.rb,
lib/telnyx/resources/fqdn_connections/fqdn_authentication.rb,
sig/telnyx/resources/fqdn_connections.rbs,
sig/telnyx/resources/fqdn_connections/fqdn_authentication.rbs

Overview

FQDN connection operations

Defined Under Namespace

Classes: FqdnAuthentication

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ FqdnConnections

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of FqdnConnections.

Parameters:



232
233
234
235
 
# File 'lib/telnyx/resources/fqdn_connections.rb', line 232

def initialize(client:)
  @client = client
  @fqdn_authentication = Telnyx::Resources::FqdnConnections::FqdnAuthentication.new(client: client)
end

Instance Attribute Details

#fqdn_authentication ⇒ Telnyx::Resources::FqdnConnections::FqdnAuthentication (readonly)

FQDN connection operations

Returns:



9
10
11
 
# File 'lib/telnyx/resources/fqdn_connections.rb', line 9

def fqdn_authentication
  @fqdn_authentication
end

Instance Method Details

#create(connection_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, microsoft_teams_sbc: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, rtcp_settings: nil, tags: nil, transport_protocol: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {}) ⇒ Telnyx::Models::FqdnConnectionCreateResponse

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

Creates a FQDN connection.

Parameters:

  • connection_name (String) —

    A user-assigned name to help manage the connection.

  • active (Boolean) —

    Defaults to true

  • anchorsite_override (Symbol, Telnyx::Models::AnchorsiteOverride) —

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

  • android_push_credential_id (String, nil) —

    The uuid of the push credential for Android

  • call_cost_in_webhooks (Boolean) —

    Specifies if call cost webhooks should be sent for this 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, Telnyx::Models::DtmfType) —

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

  • encode_contact_header_enabled (Boolean) —

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

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

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

  • inbound (Telnyx::Models::InboundFqdn)
  • ios_push_credential_id (String, nil) —

    The uuid of the push credential for Ios

  • jitter_buffer (Telnyx::Models::ConnectionJitterBuffer) —

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

  • microsoft_teams_sbc (Boolean) —

    When enabled, the connection will be created for Microsoft Teams Direct Routing.

  • noise_suppression (Symbol, Telnyx::Models::ConnectionNoiseSuppression) —

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

  • noise_suppression_details (Telnyx::Models::ConnectionNoiseSuppressionDetails) —

    Configuration options for noise suppression. These settings are stored regardles

  • onnet_t38_passthrough_enabled (Boolean) —

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

  • outbound (Telnyx::Models::OutboundFqdn)
  • rtcp_settings (Telnyx::Models::ConnectionRtcpSettings)
  • tags (Array<String>) —

    Tags associated with the connection.

  • transport_protocol (Symbol, Telnyx::Models::TransportProtocol) —

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

  • webhook_api_version (Symbol, Telnyx::Models::WebhookAPIVersion) —

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

  • webhook_event_failover_url (String, nil) —

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

  • webhook_event_url (String) —

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

  • webhook_timeout_secs (Integer, nil) —

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

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

Returns:

See Also:



71
72
73
74
75
76
77
78
79
80
 
# File 'lib/telnyx/resources/fqdn_connections.rb', line 71

def create(params)
  parsed, options = Telnyx::FqdnConnectionCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "fqdn_connections",
    body: parsed,
    model: Telnyx::Models::FqdnConnectionCreateResponse,
    options: options
  )
end

#delete(id, request_options: {}) ⇒ Telnyx::Models::FqdnConnectionDeleteResponse

Deletes an FQDN connection.

Parameters:

  • id (String) —

    Identifies the resource.

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

Returns:

See Also:



220
221
222
223
224
225
226
227
 
# File 'lib/telnyx/resources/fqdn_connections.rb', line 220

def delete(id, params = {})
  @client.request(
    method: :delete,
    path: ["fqdn_connections/%1$s", id],
    model: Telnyx::Models::FqdnConnectionDeleteResponse,
    options: params[:request_options]
  )
end

#list(filter: nil, page_number: nil, page_size: nil, sort: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::FqdnConnection>

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

Returns a list of your FQDN connections.

filter[connection_

Parameters:

Returns:

See Also:



196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/telnyx/resources/fqdn_connections.rb', line 196

def list(params = {})
  parsed, options = Telnyx::FqdnConnectionListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "fqdn_connections",
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::FqdnConnection,
    options: options
  )
end

#retrieve(id, request_options: {}) ⇒ Telnyx::Models::FqdnConnectionRetrieveResponse

Retrieves the details of an existing FQDN connection.

Parameters:

  • id (String) —

    Identifies the resource.

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

Returns:

See Also:



93
94
95
96
97
98
99
100
 
# File 'lib/telnyx/resources/fqdn_connections.rb', line 93

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["fqdn_connections/%1$s", id],
    model: Telnyx::Models::FqdnConnectionRetrieveResponse,
    options: params[:request_options]
  )
end

#update(id, active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: nil, connection_name: nil, conversation_persistence: 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, tags: nil, transport_protocol: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {}) ⇒ Telnyx::Models::FqdnConnectionUpdateResponse

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

Updates settings of an existing FQDN connection.

Parameters:

  • id (String) —

    Identifies the resource.

  • active (Boolean) —

    Defaults to true

  • anchorsite_override (Symbol, Telnyx::Models::AnchorsiteOverride) —

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

  • android_push_credential_id (String, nil) —

    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.

  • conversation_persistence (Boolean) —

    Whether conversation persistence is enabled for this connection. When enabled, c

  • default_on_hold_comfort_noise_enabled (Boolean) —

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

  • dtmf_type (Symbol, Telnyx::Models::DtmfType) —

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

  • encode_contact_header_enabled (Boolean) —

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

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

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

  • inbound (Telnyx::Models::InboundFqdn)
  • ios_push_credential_id (String, nil) —

    The uuid of the push credential for Ios

  • jitter_buffer (Telnyx::Models::ConnectionJitterBuffer) —

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

  • noise_suppression (Symbol, Telnyx::Models::ConnectionNoiseSuppression) —

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

  • noise_suppression_details (Telnyx::Models::ConnectionNoiseSuppressionDetails) —

    Configuration options for noise suppression. These settings are stored regardles

  • onnet_t38_passthrough_enabled (Boolean) —

    Enable on-net T38 if you prefer that the sender and receiver negotiate T38 direc

  • outbound (Telnyx::Models::OutboundFqdn)
  • rtcp_settings (Telnyx::Models::ConnectionRtcpSettings)
  • tags (Array<String>) —

    Tags associated with the connection.

  • transport_protocol (Symbol, Telnyx::Models::TransportProtocol) —

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

  • webhook_api_version (Symbol, Telnyx::Models::WebhookAPIVersion) —

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

  • webhook_event_failover_url (String, nil) —

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

  • webhook_event_url (String) —

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

  • webhook_timeout_secs (Integer, nil) —

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

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

Returns:

See Also:



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/telnyx/resources/fqdn_connections.rb', line 164

def update(id, params = {})
  parsed, options = Telnyx::FqdnConnectionUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["fqdn_connections/%1$s", id],
    body: parsed,
    model: Telnyx::Models::FqdnConnectionUpdateResponse,
    options: options
  )
end