Class: Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberList::LocalInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil) ⇒ LocalInstance

Initialize the LocalInstance

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 Local resource.

  • sid (String) —

    The SID of the Call resource to fetch.



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 476

def initialize(version, payload , account_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'],
    }
end

Instance Method Details

#account_sid ⇒ String

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

Returns:



522
523
524
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 522

def 
    @properties['account_sid']
end

#address_requirements ⇒ AddressRequirement

Returns:

  • (AddressRequirement) 


534
535
536
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 534

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.



528
529
530
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 528

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.



540
541
542
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 540

def api_version
    @properties['api_version']
end

#beta ⇒ Boolean

Returns Whether the phone number is new to the Twilio platform. Can be: true or false.

Returns:

  • (Boolean) —

    Whether the phone number is new to the Twilio platform. Can be: true or false.



546
547
548
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 546

def beta
    @properties['beta']
end

#bundle_sid ⇒ String

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

Returns:

  • (String) —

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



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

def bundle_sid
    @properties['bundle_sid']
end

#capabilities ⇒ ApiV2010AccountIncomingPhoneNumberCapabilities

Returns:

  • (ApiV2010AccountIncomingPhoneNumberCapabilities) 


552
553
554
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 552

def capabilities
    @properties['capabilities']
end

#date_created ⇒ Time

Returns The date and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



558
559
560
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 558

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT that the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



564
565
566
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 564

def date_updated
    @properties['date_updated']
end

#emergency_address_sid ⇒ String

Returns The SID of the emergency address configuration that we use for emergency calling from this phone number.

Returns:

  • (String) —

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



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

def emergency_address_sid
    @properties['emergency_address_sid']
end

#emergency_address_status ⇒ EmergencyAddressStatus

Returns:

  • (EmergencyAddressStatus) 


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

def emergency_address_status
    @properties['emergency_address_status']
end

#emergency_status ⇒ EmergencyStatus

Returns:

  • (EmergencyStatus) 


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

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



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

def friendly_name
    @properties['friendly_name']
end

#identity_sid ⇒ String

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

Returns:

  • (String) —

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



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

def identity_sid
    @properties['identity_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

def inspect
    "<Twilio.Api.V2010.LocalInstance>"
end

#origin ⇒ String

Returns The phone number’s origin. twilio identifies Twilio-owned phone numbers and hosted identifies hosted phone numbers.

Returns:

  • (String) —

    The phone number’s origin. twilio identifies Twilio-owned phone numbers and hosted identifies hosted phone numbers.



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

def origin
    @properties['origin']
end

#phone_number ⇒ String

Returns The phone number in [E.164](www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.

Returns:



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

def phone_number
    @properties['phone_number']
end

#sid ⇒ String

Returns The unique string that that we created to identify the resource.

Returns:

  • (String) —

    The unique string that that we created to identify the resource.



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

def sid
    @properties['sid']
end

#sms_application_sid ⇒ String

Returns The SID of the application that handles SMS messages sent to the phone number. If an sms_application_sid is present, we ignore all ‘sms_*_url` values and use those of the application.

Returns:

  • (String) —

    The SID of the application that handles SMS messages sent to the phone number. If an sms_application_sid is present, we ignore all ‘sms_*_url` values and use those of the application.



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

def sms_application_sid
    @properties['sms_application_sid']
end

#sms_fallback_method ⇒ String

Returns The HTTP method we use to call sms_fallback_url. Can be: GET or POST.

Returns:

  • (String) —

    The HTTP method we use to call sms_fallback_url. Can be: GET or POST.



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

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 from sms_url.

Returns:

  • (String) —

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



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

def sms_fallback_url
    @properties['sms_fallback_url']
end

#sms_method ⇒ String

Returns The HTTP method we use to call sms_url. Can be: GET or POST.

Returns:

  • (String) —

    The HTTP method we use to call sms_url. Can be: GET or POST.



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

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.



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

def sms_url
    @properties['sms_url']
end

#status ⇒ String

Returns:

  • (String) 


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

def status
    @properties['status']
end

#status_callback ⇒ String

Returns The URL we call using the status_callback_method to send status information to your application.

Returns:

  • (String) —

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



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

def status_callback
    @properties['status_callback']
end

#status_callback_method ⇒ String

Returns The HTTP method we use to call status_callback. Can be: GET or POST.

Returns:

  • (String) —

    The HTTP method we use to call status_callback. Can be: GET or POST.



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

def status_callback_method
    @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



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

def to_s
    "<Twilio.Api.V2010.LocalInstance>"
end

#trunk_sid ⇒ String

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

Returns:

  • (String) —

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



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

def trunk_sid
    @properties['trunk_sid']
end

#uri ⇒ String

Returns The URI of the resource, relative to https://api.twilio.com.

Returns:

  • (String) —

    The URI of the resource, relative to https://api.twilio.com.



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

def uri
    @properties['uri']
end

#voice_application_sid ⇒ String

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

Returns:

  • (String) —

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



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

def voice_application_sid
    @properties['voice_application_sid']
end

#voice_caller_id_lookup ⇒ Boolean

Returns Whether we look up the caller’s caller-ID name from the CNAM database ($0.01 per look up). Can be: true or false.

Returns:

  • (Boolean) —

    Whether we look up the caller’s caller-ID name from the CNAM database ($0.01 per look up). Can be: true or false.



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

def voice_caller_id_lookup
    @properties['voice_caller_id_lookup']
end

#voice_fallback_method ⇒ String

Returns The HTTP method we use to call voice_fallback_url. Can be: GET or POST.

Returns:

  • (String) —

    The HTTP method we use to call voice_fallback_url. Can be: GET or POST.



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

def voice_fallback_method
    @properties['voice_fallback_method']
end

#voice_fallback_url ⇒ String

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

Returns:

  • (String) —

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



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

def voice_fallback_url
    @properties['voice_fallback_url']
end

#voice_method ⇒ String

Returns The HTTP method we use to call voice_url. Can be: GET or POST.

Returns:

  • (String) —

    The HTTP method we use to call voice_url. Can be: GET or POST.



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

def voice_method
    @properties['voice_method']
end

#voice_receive_mode ⇒ VoiceReceiveMode

Returns:

  • (VoiceReceiveMode) 


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

def voice_receive_mode
    @properties['voice_receive_mode']
end

#voice_url ⇒ String

Returns The URL we call when this phone number receives a call. The voice_url will not be used if a voice_application_sid or a trunk_sid is set.

Returns:

  • (String) —

    The URL we call when this phone number receives a call. The voice_url will not be used if a voice_application_sid or a trunk_sid is set.



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

def voice_url
    @properties['voice_url']
end