Class: Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, sid: nil) ⇒ IncomingPhoneNumberInstance

Initialize the IncomingPhoneNumberInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The SID of the [Account](www.twilio.com/docs/iam/api/account) that created this IncomingPhoneNumber resource.

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

    The Twilio-provided string that uniquely identifies the IncomingPhoneNumber resource to fetch.



534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 534

def initialize(version, payload, account_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'address_sid' => payload['address_sid'],
      'address_requirements' => payload['address_requirements'],
      'api_version' => payload['api_version'],
      'beta' => payload['beta'],
      'capabilities' => payload['capabilities'],
      'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
      'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
      'friendly_name' => payload['friendly_name'],
      'identity_sid' => payload['identity_sid'],
      'phone_number' => payload['phone_number'],
      'origin' => payload['origin'],
      'sid' => payload['sid'],
      'sms_application_sid' => payload['sms_application_sid'],
      'sms_fallback_method' => payload['sms_fallback_method'],
      'sms_fallback_url' => payload['sms_fallback_url'],
      'sms_method' => payload['sms_method'],
      'sms_url' => payload['sms_url'],
      'status_callback' => payload['status_callback'],
      'status_callback_method' => payload['status_callback_method'],
      'trunk_sid' => payload['trunk_sid'],
      'uri' => payload['uri'],
      'voice_application_sid' => payload['voice_application_sid'],
      'voice_caller_id_lookup' => payload['voice_caller_id_lookup'],
      'voice_fallback_method' => payload['voice_fallback_method'],
      'voice_fallback_url' => payload['voice_fallback_url'],
      'voice_method' => payload['voice_method'],
      'voice_url' => payload['voice_url'],
      'emergency_status' => payload['emergency_status'],
      'emergency_address_sid' => payload['emergency_address_sid'],
      'bundle_sid' => payload['bundle_sid'],
  }

  # Context
  @instance_context = nil
  @params = {'account_sid' => , 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



590
591
592
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 590

def 
  @properties['account_sid']
end

#address_requirements ⇒ incoming_phone_number.AddressRequirement

Returns Whether the phone number requires an Address registered with Twilio.

Returns:

  • (incoming_phone_number.AddressRequirement) —

    Whether the phone number requires an Address registered with Twilio.



602
603
604
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 602

def address_requirements
  @properties['address_requirements']
end

#address_sid ⇒ String

Returns The SID of the Address resource associated with the phone number.

Returns:

  • (String) —

    The SID of the Address resource associated with the phone number



596
597
598
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 596

def address_sid
  @properties['address_sid']
end

#api_version ⇒ String

Returns The API version used to start a new TwiML session.

Returns:

  • (String) —

    The API version used to start a new TwiML session



608
609
610
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 608

def api_version
  @properties['api_version']
end

#assigned_add_ons ⇒ assigned_add_ons

Access the assigned_add_ons

Returns:



884
885
886
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 884

def assigned_add_ons
  context.assigned_add_ons
end

#beta ⇒ Boolean

Returns Whether the phone number is new to the Twilio platform.

Returns:

  • (Boolean) —

    Whether the phone number is new to the Twilio platform



614
615
616
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 614

def beta
  @properties['beta']
end

#bundle_sid ⇒ String

Returns The SID of the Bundle resource associated with number.

Returns:

  • (String) —

    The SID of the Bundle resource associated with number



770
771
772
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 770

def bundle_sid
  @properties['bundle_sid']
end

#capabilities ⇒ String

Returns Indicate if a phone can receive calls or messages.

Returns:

  • (String) —

    Indicate if a phone can receive calls or messages



620
621
622
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 620

def capabilities
  @properties['capabilities']
end

#context ⇒ IncomingPhoneNumberContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



581
582
583
584
585
586
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 581

def context
  unless @instance_context
    @instance_context = IncomingPhoneNumberContext.new(@version, @params['account_sid'], @params['sid'], )
  end
  @instance_context
end

#date_created ⇒ Time

Returns The RFC 2822 date and time in GMT that the resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT that the resource was created



626
627
628
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 626

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT that the resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT that the resource was last updated



632
633
634
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 632

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the IncomingPhoneNumberInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



877
878
879
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 877

def delete
  context.delete
end

#emergency_address_sid ⇒ String

Returns The emergency address configuration to use for emergency calling.

Returns:

  • (String) —

    The emergency address configuration to use for emergency calling



764
765
766
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 764

def emergency_address_sid
  @properties['emergency_address_sid']
end

#emergency_status ⇒ incoming_phone_number.EmergencyStatus

Returns Whether the phone number is enabled for emergency calling.

Returns:

  • (incoming_phone_number.EmergencyStatus) —

    Whether the phone number is enabled for emergency calling



758
759
760
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 758

def emergency_status
  @properties['emergency_status']
end

#fetch ⇒ IncomingPhoneNumberInstance

Fetch a IncomingPhoneNumberInstance

Returns:



870
871
872
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 870

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource



638
639
640
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 638

def friendly_name
  @properties['friendly_name']
end

#identity_sid ⇒ String

Returns The SID of the Identity resource associated with number.

Returns:

  • (String) —

    The SID of the Identity resource associated with number



644
645
646
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 644

def identity_sid
  @properties['identity_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



897
898
899
900
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 897

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Api.V2010.IncomingPhoneNumberInstance #{values}>"
end

#origin ⇒ String

Returns The phone number’s origin. Can be twilio or hosted.

Returns:

  • (String) —

    The phone number’s origin. Can be twilio or hosted.



656
657
658
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 656

def origin
  @properties['origin']
end

#phone_number ⇒ String

Returns The phone number in E.164 format.

Returns:

  • (String) —

    The phone number in E.164 format



650
651
652
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 650

def phone_number
  @properties['phone_number']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



662
663
664
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 662

def sid
  @properties['sid']
end

#sms_application_sid ⇒ String

Returns The SID of the application that handles SMS messages sent to the phone number.

Returns:

  • (String) —

    The SID of the application that handles SMS messages sent to the phone number



668
669
670
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 668

def sms_application_sid
  @properties['sms_application_sid']
end

#sms_fallback_method ⇒ String

Returns The HTTP method used with sms_fallback_url.

Returns:

  • (String) —

    The HTTP method used with sms_fallback_url



674
675
676
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 674

def sms_fallback_method
  @properties['sms_fallback_method']
end

#sms_fallback_url ⇒ String

Returns The URL that we call when an error occurs while retrieving or executing the TwiML.

Returns:

  • (String) —

    The URL that we call when an error occurs while retrieving or executing the TwiML



680
681
682
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 680

def sms_fallback_url
  @properties['sms_fallback_url']
end

#sms_method ⇒ String

Returns The HTTP method to use with sms_url.

Returns:

  • (String) —

    The HTTP method to use with sms_url



686
687
688
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 686

def sms_method
  @properties['sms_method']
end

#sms_url ⇒ String

Returns The URL we call when the phone number receives an incoming SMS message.

Returns:

  • (String) —

    The URL we call when the phone number receives an incoming SMS message



692
693
694
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 692

def sms_url
  @properties['sms_url']
end

#status_callback ⇒ String

Returns The URL to send status information to your application.

Returns:

  • (String) —

    The URL to send status information to your application



698
699
700
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 698

def status_callback
  @properties['status_callback']
end

#status_callback_method ⇒ String

Returns The HTTP method we use to call status_callback.

Returns:

  • (String) —

    The HTTP method we use to call status_callback



704
705
706
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 704

def status_callback_method
  @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



890
891
892
893
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 890

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Api.V2010.IncomingPhoneNumberInstance #{values}>"
end

#trunk_sid ⇒ String

Returns The SID of the Trunk that handles calls to the phone number.

Returns:

  • (String) —

    The SID of the Trunk that handles calls to the phone number



710
711
712
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 710

def trunk_sid
  @properties['trunk_sid']
end

#update(account_sid: :unset, api_version: :unset, friendly_name: :unset, sms_application_sid: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, status_callback: :unset, status_callback_method: :unset, voice_application_sid: :unset, voice_caller_id_lookup: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset, emergency_status: :unset, emergency_address_sid: :unset, trunk_sid: :unset, voice_receive_mode: :unset, identity_sid: :unset, address_sid: :unset, bundle_sid: :unset) ⇒ IncomingPhoneNumberInstance

Update the IncomingPhoneNumberInstance

Parameters:

  • account_sid (String) (defaults to: :unset) —

    The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resource to update. For more information, see [Exchanging Numbers Between Subaccounts](www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers).

  • api_version (String) (defaults to: :unset) —

    The API version to use for incoming calls made to the phone number. The default is ‘2010-04-01`.

  • friendly_name (String) (defaults to: :unset) —

    A descriptive string that you created to describe this phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number.

  • sms_application_sid (String) (defaults to: :unset) —

    The SID of the application that should handle SMS messages sent to the number. If an ‘sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application.

  • sms_fallback_method (String) (defaults to: :unset) —

    The HTTP method that we should use to call ‘sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.

  • sms_fallback_url (String) (defaults to: :unset) —

    The URL that we should call when an error occurs while requesting or executing the TwiML defined by ‘sms_url`.

  • sms_method (String) (defaults to: :unset) —

    The HTTP method that we should use to call ‘sms_url`. Can be: `GET` or `POST` and defaults to `POST`.

  • sms_url (String) (defaults to: :unset) —

    The URL we should call when the phone number receives an incoming SMS message.

  • status_callback (String) (defaults to: :unset) —

    The URL we should call using the ‘status_callback_method` to send status information to your application.

  • status_callback_method (String) (defaults to: :unset) —

    The HTTP method we should use to call ‘status_callback`. Can be: `GET` or `POST` and defaults to `POST`.

  • voice_application_sid (String) (defaults to: :unset) —

    The SID of the application we should use to handle phone calls to the phone number. If a ‘voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.

  • voice_caller_id_lookup (Boolean) (defaults to: :unset) —

    Whether to lookup the caller’s name from the CNAM database and post it to your app. Can be: ‘true` or `false` and defaults to `false`.

  • voice_fallback_method (String) (defaults to: :unset) —

    The HTTP method that we should use to call ‘voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.

  • voice_fallback_url (String) (defaults to: :unset) —

    The URL that we should call when an error occurs retrieving or executing the TwiML requested by ‘url`.

  • voice_method (String) (defaults to: :unset) —

    The HTTP method that we should use to call ‘voice_url`. Can be: `GET` or `POST` and defaults to `POST`.

  • voice_url (String) (defaults to: :unset) —

    The URL that we should call to answer a call to the phone number. The ‘voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.

  • emergency_status (incoming_phone_number.EmergencyStatus) (defaults to: :unset) —

    The configuration status parameter that determines whether the phone number is enabled for emergency calling.

  • emergency_address_sid (String) (defaults to: :unset) —

    The SID of the emergency address configuration to use for emergency calling from this phone number.

  • trunk_sid (String) (defaults to: :unset) —

    The SID of the Trunk we should use to handle phone calls to the phone number. If a ‘trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.

  • voice_receive_mode (incoming_phone_number.VoiceReceiveMode) (defaults to: :unset) —

    The configuration parameter for the phone number to receive incoming voice calls or faxes. Can be: ‘fax` or `voice` and defaults to `voice`.

  • identity_sid (String) (defaults to: :unset) —

    The SID of the Identity resource that we should associate with the phone number. Some regions require an identity to meet local regulations.

  • address_sid (String) (defaults to: :unset) —

    The SID of the Address resource we should associate with the phone number. Some regions require addresses to meet local regulations.

  • bundle_sid (String) (defaults to: :unset) —

    The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.

Returns:



839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 839

def update(account_sid: :unset, api_version: :unset, friendly_name: :unset, sms_application_sid: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, status_callback: :unset, status_callback_method: :unset, voice_application_sid: :unset, voice_caller_id_lookup: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset, emergency_status: :unset, emergency_address_sid: :unset, trunk_sid: :unset, voice_receive_mode: :unset, identity_sid: :unset, address_sid: :unset, bundle_sid: :unset)
  context.update(
      account_sid: ,
      api_version: api_version,
      friendly_name: friendly_name,
      sms_application_sid: sms_application_sid,
      sms_fallback_method: sms_fallback_method,
      sms_fallback_url: sms_fallback_url,
      sms_method: sms_method,
      sms_url: sms_url,
      status_callback: status_callback,
      status_callback_method: status_callback_method,
      voice_application_sid: voice_application_sid,
      voice_caller_id_lookup: voice_caller_id_lookup,
      voice_fallback_method: voice_fallback_method,
      voice_fallback_url: voice_fallback_url,
      voice_method: voice_method,
      voice_url: voice_url,
      emergency_status: emergency_status,
      emergency_address_sid: emergency_address_sid,
      trunk_sid: trunk_sid,
      voice_receive_mode: voice_receive_mode,
      identity_sid: identity_sid,
      address_sid: address_sid,
      bundle_sid: bundle_sid,
  )
end

#uri ⇒ String

Returns The URI of the resource, relative to ‘api.twilio.com`.

Returns:

  • (String) —

    The URI of the resource, relative to ‘api.twilio.com`



716
717
718
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 716

def uri
  @properties['uri']
end

#voice_application_sid ⇒ String

Returns The SID of the application that handles calls to the phone number.

Returns:

  • (String) —

    The SID of the application that handles calls to the phone number



722
723
724
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 722

def voice_application_sid
  @properties['voice_application_sid']
end

#voice_caller_id_lookup ⇒ Boolean

Returns Whether to lookup the caller’s name.

Returns:

  • (Boolean) —

    Whether to lookup the caller’s name



728
729
730
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 728

def voice_caller_id_lookup
  @properties['voice_caller_id_lookup']
end

#voice_fallback_method ⇒ String

Returns The HTTP method used with voice_fallback_url.

Returns:

  • (String) —

    The HTTP method used with voice_fallback_url



734
735
736
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 734

def voice_fallback_method
  @properties['voice_fallback_method']
end

#voice_fallback_url ⇒ String

Returns The URL we call when an error occurs in TwiML.

Returns:

  • (String) —

    The URL we call when an error occurs in TwiML



740
741
742
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 740

def voice_fallback_url
  @properties['voice_fallback_url']
end

#voice_method ⇒ String

Returns The HTTP method used with the voice_url.

Returns:

  • (String) —

    The HTTP method used with the voice_url



746
747
748
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 746

def voice_method
  @properties['voice_method']
end

#voice_url ⇒ String

Returns The URL we call when the phone number receives a call.

Returns:

  • (String) —

    The URL we call when the phone number receives a call



752
753
754
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 752

def voice_url
  @properties['voice_url']
end