Class: Telnyx::Resources::PhoneNumbers::Voice

Inherits:

Object

• Object
• Telnyx::Resources::PhoneNumbers::Voice

Defined in:

lib/telnyx/resources/phone_numbers/voice.rb

Overview

Configure your phone numbers

Instance Method Summary

• #initialize(client:) ⇒ Voice constructor private

  A new instance of Voice.

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

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

• #retrieve(id, request_options: {}) ⇒ Telnyx::Models::PhoneNumbers::VoiceRetrieveResponse

  Retrieve a phone number with voice settings.

• #update(id, call_forwarding: nil, call_recording: nil, caller_id_name_enabled: nil, cnam_listing: nil, inbound_call_screening: nil, media_features: nil, tech_prefix_enabled: nil, translated_number: nil, usage_payment_method: nil, request_options: {}) ⇒ Telnyx::Models::PhoneNumbers::VoiceUpdateResponse

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

Constructor Details

#initialize(client:) ⇒ Voice

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 Voice.

Parameters:

• client (Telnyx::Client)

# File 'lib/telnyx/resources/phone_numbers/voice.rb', line 107

def initialize(client:)
  @client = client
end

Instance Method Details

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

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

List phone numbers with voice settings

Parameters:

• filter (Telnyx::Models::PhoneNumbers::VoiceListParams::Filter) —

  Consolidated filter parameter (deepObject style). Originally: filter[phone_numbe

• page_number (Integer)
• page_size (Integer)
• sort (Symbol, Telnyx::Models::PhoneNumbers::VoiceListParams::Sort) —

  Specifies the sort order for results. If not given, results are sorted by create

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

Returns:

• (Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::PhoneNumbers::PhoneNumberWithVoiceSettings>)

See Also:

• Models::PhoneNumbers::VoiceListParams

# File 'lib/telnyx/resources/phone_numbers/voice.rb', line 91

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

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

Retrieve a phone number with voice settings

Parameters:

• id (String) —

  Identifies the resource.

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

Returns:

• (Telnyx::Models::PhoneNumbers::VoiceRetrieveResponse)

See Also:

• Models::PhoneNumbers::VoiceRetrieveParams

# File 'lib/telnyx/resources/phone_numbers/voice.rb', line 19

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

#update(id, call_forwarding: nil, call_recording: nil, caller_id_name_enabled: nil, cnam_listing: nil, inbound_call_screening: nil, media_features: nil, tech_prefix_enabled: nil, translated_number: nil, usage_payment_method: nil, request_options: {}) ⇒ Telnyx::Models::PhoneNumbers::VoiceUpdateResponse

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

Update a phone number with voice settings

Parameters:

• id (String) —

  Identifies the resource.

• call_forwarding (Telnyx::Models::PhoneNumbers::CallForwarding) —

  The call forwarding settings for a phone number.

• call_recording (Telnyx::Models::PhoneNumbers::CallRecording) —

  The call recording settings for a phone number.

• caller_id_name_enabled (Boolean) —

  Controls whether the caller ID name is enabled for this phone number.

• cnam_listing (Telnyx::Models::PhoneNumbers::CnamListing) —

  The CNAM listing settings for a phone number.

• inbound_call_screening (Symbol, Telnyx::Models::PhoneNumbers::UpdateVoiceSettings::InboundCallScreening) —

  The inbound_call_screening setting is a phone number configuration option variab

• media_features (Telnyx::Models::PhoneNumbers::MediaFeatures) —

  The media features settings for a phone number.

• tech_prefix_enabled (Boolean) —

  Controls whether a tech prefix is enabled for this phone number.

• translated_number (String) —

  This field allows you to rewrite the destination number of an inbound call befor

• usage_payment_method (Symbol, Telnyx::Models::PhoneNumbers::UpdateVoiceSettings::UsagePaymentMethod) —

  Controls whether a number is billed per minute or uses your concurrent channels.

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

Returns:

• (Telnyx::Models::PhoneNumbers::VoiceUpdateResponse)

See Also:

• Models::PhoneNumbers::VoiceUpdateParams

# File 'lib/telnyx/resources/phone_numbers/voice.rb', line 60

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