Class: DIDWW::ComplexObject::Configuration::SipConfiguration

Inherits:

Base

• Object
• Base
• Base
• DIDWW::ComplexObject::Configuration::SipConfiguration

Defined in:

lib/didww/complex_objects/configurations/sip_configuration.rb

Constant Summary

DIVERSION_RELAY_POLICY_NONE =

Type: String Nullable: No Description: Diversion header relay policy for SIP INVITE. See DIVERSION_RELAY_POLICIES for available values. In API v3.4 this attribute was named ‘diversion_relay_mode`.

'none'

DIVERSION_RELAY_POLICY_AS_IS =

'as_is'

DIVERSION_RELAY_POLICY_SIP =

'sip'

DIVERSION_RELAY_POLICY_TEL =

'tel'

DIVERSION_RELAY_POLICIES =

[
  DIVERSION_RELAY_POLICY_NONE,
  DIVERSION_RELAY_POLICY_AS_IS,
  DIVERSION_RELAY_POLICY_SIP,
  DIVERSION_RELAY_POLICY_TEL
].freeze

MEDIA_ENCRYPTION_MODES =

[
  'disabled',
  'srtp_sdes',
  'srtp_dtls',
  'zrtp'
].freeze

STIR_SHAKEN_MODES =

[
  'disabled',
  'original',
  'pai',
  'original_pai',
  'verstat'
].freeze

DEFAULTS =

{
    username: DID_PLACEHOLDER,
    port: '5060',
    tx_dtmf_format_id: 1,
    sst_min_timer: 600,
    sst_max_timer: 900,
    sst_refresh_method_id: 1,
    sst_accept_501: true,
    sip_timer_b: 8000,
    dns_srv_failover_timer: 2000,
    rtp_timeout: 30,
    auth_enabled: false,
    max_transfers: 0,
    max_30x_redirects: 0,
    codec_ids: DEFAULT_CODEC_IDS,
    rerouting_disconnect_code_ids: DEFAULT_REROUTING_DISCONNECT_CODE_IDS,
    transport_protocol_id: 1
}.freeze

RECOMMENDED =

DEFAULTS.merge(
    #-- Authentication
    auth_user: '',
    auth_password: '',
    auth_from_user: '',
    auth_from_domain: '',
    #-- Media & DTMF
    rx_dtmf_format_id: 1,
    rtp_ping: false,
    force_symmetric_rtp: false,
    symmetric_rtp_ignore_rtcp: false,
    #-- Advanced Signalling Settings
    sst_enabled: false,
    sst_session_expires: '',
).freeze

Constants inherited from Base

Base::CODECS, Base::DEFAULT_CODEC_IDS, Base::DEFAULT_REROUTING_DISCONNECT_CODE_IDS, Base::DID_PLACEHOLDER, Base::REROUTING_DISCONNECT_CODES, Base::RX_DTMF_FORMATS, Base::SST_REFRESH_METHODS, Base::TRANSPORT_PROTOCOLS, Base::TX_DTMF_FORMATS

Instance Method Summary

• #rx_dtmf_format ⇒ Object
• #sst_refresh_method ⇒ Object
• #transport_protocol ⇒ Object
• #tx_dtmf_format ⇒ Object

Methods inherited from Base

#[], #[]=, #as_json, #as_json_api, #attributes, cast, #initialize, property, schema, type, #type

Constructor Details

This class inherits a constructor from DIDWW::ComplexObject::Base

Instance Method Details

#rx_dtmf_format ⇒ Object

# File 'lib/didww/complex_objects/configurations/sip_configuration.rb', line 249

def rx_dtmf_format
  RX_DTMF_FORMATS[rx_dtmf_format_id]
end

#sst_refresh_method ⇒ Object

# File 'lib/didww/complex_objects/configurations/sip_configuration.rb', line 245

def sst_refresh_method
  SST_REFRESH_METHODS[sst_refresh_method_id]
end

#transport_protocol ⇒ Object

# File 'lib/didww/complex_objects/configurations/sip_configuration.rb', line 257

def transport_protocol
  TRANSPORT_PROTOCOLS[transport_protocol_id]
end

#tx_dtmf_format ⇒ Object

# File 'lib/didww/complex_objects/configurations/sip_configuration.rb', line 253

def tx_dtmf_format
  TX_DTMF_FORMATS[tx_dtmf_format_id]
end