Class: Telnyx::Models::VerifiedNumberCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/verified_number_create_params.rb

Overview

See Also:

• Resources::VerifiedNumbers#create

Defined Under Namespace

Modules: VerificationMethod

Instance Attribute Summary

• #extension ⇒ String^?

  Optional DTMF extension sequence to dial after the call is answered.

• #phone_number ⇒ String
• #verification_method ⇒ Symbol, Telnyx::Models::VerifiedNumberCreateParams::VerificationMethod

  Verification method.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(phone_number:, verification_method:, extension: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see VerifiedNumberCreateParams 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(phone_number:, verification_method:, extension: nil, request_options: {}) ⇒ Object

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

Parameters:

• phone_number (String)
• verification_method (Symbol, Telnyx::Models::VerifiedNumberCreateParams::VerificationMethod) —

  Verification method.

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

  Optional DTMF extension sequence to dial after the call is answered. This parame

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

# File 'lib/telnyx/models/verified_number_create_params.rb', line 31

Instance Attribute Details

#extension ⇒ String^?

Optional DTMF extension sequence to dial after the call is answered. This parameter enables verification of phone numbers behind IVR systems that require extension dialing. Valid characters: digits 0-9, letters A-D, symbols * and #. Pauses: w = 0.5 second pause, W = 1 second pause. Maximum length: 50 characters. Only works with ‘call’ verification method.

Returns:

• (String, nil)

# File 'lib/telnyx/models/verified_number_create_params.rb', line 29

optional :extension, String

#phone_number ⇒ String

Returns:

• (String)

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

required :phone_number, String

#verification_method ⇒ Symbol, Telnyx::Models::VerifiedNumberCreateParams::VerificationMethod

Verification method.

Returns:

• (Symbol, Telnyx::Models::VerifiedNumberCreateParams::VerificationMethod)

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

required :verification_method, enum: -> { Telnyx::VerifiedNumberCreateParams::VerificationMethod }