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



513
514
515
516
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
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 513

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



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

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



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

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



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

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



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

def api_version
  @properties['api_version']
end

#assigned_add_ons ⇒ assigned_add_ons

Access the assigned_add_ons

Returns:



849
850
851
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 849

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



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

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



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

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:



559
560
561
562
563
564
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 559

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



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the IncomingPhoneNumberInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



842
843
844
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 842

def delete
  context.delete
end

#emergency_address_sid ⇒ String

Returns The emergency_address_sid.

Returns:

  • (String) —

    The emergency_address_sid



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

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



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

def emergency_status
  @properties['emergency_status']
end

#fetch ⇒ IncomingPhoneNumberInstance

Fetch a IncomingPhoneNumberInstance

Returns:



835
836
837
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 835

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



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

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



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

def identity_sid
  @properties['identity_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



862
863
864
865
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 862

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.



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

def origin
  @properties['origin']
end

#phone_number ⇒ String

Returns The incoming phone number.

Returns:

  • (String) —

    The incoming phone number



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

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



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

def sid
  @properties['sid']
end

#sms_application_sid ⇒ String

Returns Unique string that identifies the application.

Returns:

  • (String) —

    Unique string that identifies the application



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

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



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

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



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

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



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

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



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

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



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

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



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

def status_callback_method
  @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



855
856
857
858
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 855

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



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

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 emergency_status

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

    The emergency_address_sid

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

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



805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 805

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



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

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



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

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



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

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



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

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



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

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



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

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



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

def voice_url
  @properties['voice_url']
end