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 unique id of the [Account](www.twilio.com/docs/iam/api/account) responsible for this phone number.

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

    The incoming-phone-number Sid that uniquely identifies this resource



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
562
563
564
565
566
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 526

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'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The unique sid that identifies this account.

Returns:

  • (String) —

    The unique sid that identifies this account



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

def 
  @properties['account_sid']
end

#address_requirements ⇒ incoming_phone_number.AddressRequirement

Returns Indicates if the customer requires an address.

Returns:

  • (incoming_phone_number.AddressRequirement) —

    Indicates if the customer requires an address



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

def address_requirements
  @properties['address_requirements']
end

#address_sid ⇒ String

Returns Unique string that identifies the address associated with number.

Returns:

  • (String) —

    Unique string that identifies the address associated with number



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

def address_sid
  @properties['address_sid']
end

#api_version ⇒ String

Returns The Twilio REST API version to use.

Returns:

  • (String) —

    The Twilio REST API version to use



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

def api_version
  @properties['api_version']
end

#assigned_add_ons ⇒ assigned_add_ons

Access the assigned_add_ons

Returns:



866
867
868
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 866

def assigned_add_ons
  context.assigned_add_ons
end

#beta ⇒ Boolean

Returns Indicates if the phone number is a beta number.

Returns:

  • (Boolean) —

    Indicates if the phone number is a beta number



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

def beta
  @properties['beta']
end

#capabilities ⇒ String

Returns Indicate if a phone can receive calls or messages.

Returns:

  • (String) —

    Indicate if a phone can receive calls or messages



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

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:



572
573
574
575
576
577
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 572

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

#date_created ⇒ Time

Returns The date this resource was created.

Returns:

  • (Time) —

    The date this resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this resource was last updated.

Returns:

  • (Time) —

    The date this resource was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the IncomingPhoneNumberInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



859
860
861
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 859

def delete
  context.delete
end

#emergency_address_sid ⇒ String

Returns The emergency_address_sid.

Returns:

  • (String) —

    The emergency_address_sid



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

def emergency_address_sid
  @properties['emergency_address_sid']
end

#emergency_status ⇒ incoming_phone_number.EmergencyStatus

Returns The emergency_status.

Returns:

  • (incoming_phone_number.EmergencyStatus) —

    The emergency_status



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

def emergency_status
  @properties['emergency_status']
end

#fetch ⇒ IncomingPhoneNumberInstance

Fetch a IncomingPhoneNumberInstance

Returns:



852
853
854
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 852

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns A human readable description of this resouce.

Returns:

  • (String) —

    A human readable description of this resouce



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

def friendly_name
  @properties['friendly_name']
end

#identity_sid ⇒ String

Returns Unique string that identifies the identity associated with number.

Returns:

  • (String) —

    Unique string that identifies the identity associated with number



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

def identity_sid
  @properties['identity_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#origin ⇒ String

Returns Twilio owned phone numbers are marked as twilio while hosted phone numbers are marked as hosted.

Returns:

  • (String) —

    Twilio owned phone numbers are marked as twilio while hosted phone numbers are marked as hosted.



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

def origin
  @properties['origin']
end

#phone_number ⇒ String

Returns The incoming phone number.

Returns:

  • (String) —

    The incoming phone number



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

def phone_number
  @properties['phone_number']
end

#sid ⇒ String

Returns A string that uniquely identifies this resource.

Returns:

  • (String) —

    A string that uniquely identifies this resource



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

def sid
  @properties['sid']
end

#sms_application_sid ⇒ String

Returns Unique string that identifies the application.

Returns:

  • (String) —

    Unique string that identifies the application



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

def sms_application_sid
  @properties['sms_application_sid']
end

#sms_fallback_method ⇒ String

Returns HTTP method used with sms fallback url.

Returns:

  • (String) —

    HTTP method used with sms fallback url



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

def sms_fallback_method
  @properties['sms_fallback_method']
end

#sms_fallback_url ⇒ String

Returns URL Twilio will request if an error occurs in executing TwiML.

Returns:

  • (String) —

    URL Twilio will request if an error occurs in executing TwiML



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

def sms_fallback_url
  @properties['sms_fallback_url']
end

#sms_method ⇒ String

Returns HTTP method to use with sms url.

Returns:

  • (String) —

    HTTP method to use with sms url



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

def sms_method
  @properties['sms_method']
end

#sms_url ⇒ String

Returns URL Twilio will request when receiving an SMS.

Returns:

  • (String) —

    URL Twilio will request when receiving an SMS



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

def sms_url
  @properties['sms_url']
end

#status_callback ⇒ String

Returns URL Twilio will use to pass status parameters.

Returns:

  • (String) —

    URL Twilio will use to pass status parameters



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

def status_callback
  @properties['status_callback']
end

#status_callback_method ⇒ String

Returns HTTP method twilio will use with status callback.

Returns:

  • (String) —

    HTTP method twilio will use with status callback



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

def status_callback_method
  @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#trunk_sid ⇒ String

Returns Unique string to identify the trunk.

Returns:

  • (String) —

    Unique string to identify the trunk



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

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) ⇒ IncomingPhoneNumberInstance

Update the IncomingPhoneNumberInstance

Parameters:

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

    The unique 34 character id of the account to which you wish to transfer this phone number. See [Exchanging Numbers Between Subaccounts](www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers).

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

    Calls to this phone number will start a new TwiML session with this API version. Either ‘2010-04-01` or `2008-08-01`.

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

    A human readable descriptive text for this resource, up to 64 characters long. By default, the ‘FriendlyName` is a nicely formatted version of the phone number.

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

    The 34 character sid of the application Twilio should use to handle SMSs sent to this number. If a ‘SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application instead.

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

    The HTTP method that should be used to request the ‘SmsFallbackUrl`. Either `GET` or `POST`.

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

    A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by ‘SmsUrl`.

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

    The HTTP method Twilio will use when making requests to the ‘SmsUrl`. Either `GET` or `POST`.

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

    The URL that Twilio should request when somebody sends an SMS to the new phone number.

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

    The URL that Twilio will request to pass status parameters (such as call ended) to your application.

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

    The HTTP method Twilio will use to make requests to the ‘StatusCallback` URL. Either `GET` or `POST`.

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

    The 34 character sid of the application Twilio should use to handle phone calls to this number. If a ‘VoiceApplicationSid` is present, Twilio will ignore all of the voice urls above and use those set on the application instead. Setting a `VoiceApplicationSid` will automatically delete your `TrunkSid` and vice versa.

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

    Look up the caller’s caller-ID name from the CNAM database ($0.01 per look up). Either ‘true` or `false`.

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

    The HTTP method Twilio will use when requesting the ‘VoiceFallbackUrl`. Either `GET` or `POST`.

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

    A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by ‘VoiceUrl`.

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

    The HTTP method Twilio will use when requesting the above ‘Url`. Either `GET` or `POST`.

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

    The URL that Twilio should request when somebody dials the phone number. The VoiceURL will no longer be used if a ‘VoiceApplicationSid` or a `TrunkSid` is set.

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

    The configuration status parameter determining whether this phone number is enabled for emergency calling

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

    The 34 character sid of the EmergencyAddress configuration to leverage emergency calling for this phone number

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

    The 34 character sid of the Trunk Twilio should use to handle phone calls to this number. If a ‘TrunkSid` is present, Twilio will ignore all of the voice urls and voice applications above and use those set on the Trunk. Setting a `TrunkSid` will automatically delete your `VoiceApplicationSid` and vice versa.

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

    The configuration parameter for this phone number to receive incoming voice calls or faxes. Must be either ‘fax` or `voice`. Defaults to `voice`

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

    The 34 character sid of the identity Twilio should use to associate with the number. Identities are required in some regions to meet local regulations

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

    The 34 character sid of the address Twilio should associate with the number. If the number has address restrictions, only another address that satisfies the requirement can replace the existing one.

Returns:



822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 822

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)
  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,
  )
end

#uri ⇒ String

Returns The URI for this resource.

Returns:

  • (String) —

    The URI for this resource



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

def uri
  @properties['uri']
end

#voice_application_sid ⇒ String

Returns The unique sid of the application to handle this number.

Returns:

  • (String) —

    The unique sid of the application to handle this number



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

def voice_application_sid
  @properties['voice_application_sid']
end

#voice_caller_id_lookup ⇒ Boolean

Returns Look up the caller’s caller-ID.

Returns:

  • (Boolean) —

    Look up the caller’s caller-ID



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

def voice_caller_id_lookup
  @properties['voice_caller_id_lookup']
end

#voice_fallback_method ⇒ String

Returns HTTP method used with fallback_url.

Returns:

  • (String) —

    HTTP method used with fallback_url



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

def voice_fallback_method
  @properties['voice_fallback_method']
end

#voice_fallback_url ⇒ String

Returns URL Twilio will request when an error occurs in TwiML.

Returns:

  • (String) —

    URL Twilio will request when an error occurs in TwiML



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

def voice_fallback_url
  @properties['voice_fallback_url']
end

#voice_method ⇒ String

Returns HTTP method used with the voice url.

Returns:

  • (String) —

    HTTP method used with the voice url



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

def voice_method
  @properties['voice_method']
end

#voice_url ⇒ String

Returns URL Twilio will request when receiving a call.

Returns:

  • (String) —

    URL Twilio will request when receiving a call



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

def voice_url
  @properties['voice_url']
end