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 that created this IncomingPhoneNumber resource.

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

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


517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
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
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 517

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_receive_mode' => payload['voice_receive_mode'],
      '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'],
      'emergency_address_status' => payload['emergency_address_status'],
      'bundle_sid' => payload['bundle_sid'],
      'status' => payload['status'],
  }

  # 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


576
577
578
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 576

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.


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

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


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

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


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

def api_version
  @properties['api_version']
end

#assigned_add_ons ⇒ assigned_add_ons

Access the assigned_add_ons

Returns:


888
889
890
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 888

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


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

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


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

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


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

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:


567
568
569
570
571
572
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 567

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


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

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


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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the IncomingPhoneNumberInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


881
882
883
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 881

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


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

def emergency_address_sid
  @properties['emergency_address_sid']
end

#emergency_address_status ⇒ incoming_phone_number.EmergencyAddressStatus

Returns State of the emergency address configuration for the phone number.

Returns:

  • (incoming_phone_number.EmergencyAddressStatus) —

    State of the emergency address configuration for the phone number


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

def emergency_address_status
  @properties['emergency_address_status']
end

#emergency_status ⇒ incoming_phone_number.EmergencyStatus

Returns Displays if emergency calling is enabled for this number.

Returns:

  • (incoming_phone_number.EmergencyStatus) —

    Displays if emergency calling is enabled for this number.


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

def emergency_status
  @properties['emergency_status']
end

#fetch ⇒ IncomingPhoneNumberInstance

Fetch the IncomingPhoneNumberInstance

Returns:


874
875
876
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 874

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


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

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


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

def identity_sid
  @properties['identity_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


901
902
903
904
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 901

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.


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

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


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

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


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

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


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

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


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

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


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

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


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

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


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

def sms_url
  @properties['sms_url']
end

#status ⇒ String

Returns The status.

Returns:

  • (String) —

    The status


774
775
776
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 774

def status
  @properties['status']
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


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

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


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

def status_callback_method
  @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation


894
895
896
897
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 894

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


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

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 that created the IncomingPhoneNumber resource to update. For more information, see Exchanging Numbers Between Subaccounts.

  • 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 parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country.

  • 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:


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

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:


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

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


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

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


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

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


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

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


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

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


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

def voice_method
  @properties['voice_method']
end

#voice_receive_mode ⇒ incoming_phone_number.VoiceReceiveMode

Returns The voice_receive_mode.

Returns:

  • (incoming_phone_number.VoiceReceiveMode) —

    The voice_receive_mode


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

def voice_receive_mode
  @properties['voice_receive_mode']
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


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

def voice_url
  @properties['voice_url']
end