Class: Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberInstance
- Inherits:
- 
      InstanceResource
      
        - Object
- InstanceResource
- Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberInstance
 
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb
Instance Method Summary collapse
- 
  
    
      #account_sid  ⇒ String 
    
    
  
  
  
  
  
  
  
  
  
    The SID of the [Account](www.twilio.com/docs/iam/api/account) that created this IncomingPhoneNumber resource. 
- #address_requirements ⇒ AddressRequirement
- 
  
    
      #address_sid  ⇒ String 
    
    
  
  
  
  
  
  
  
  
  
    The SID of the Address resource associated with the phone number. 
- 
  
    
      #api_version  ⇒ String 
    
    
  
  
  
  
  
  
  
  
  
    The API version used to start a new TwiML session. 
- 
  
    
      #assigned_add_ons  ⇒ assigned_add_ons 
    
    
  
  
  
  
  
  
  
  
  
    Access the assigned_add_ons. 
- 
  
    
      #beta  ⇒ Boolean 
    
    
  
  
  
  
  
  
  
  
  
    Whether the phone number is new to the Twilio platform. 
- 
  
    
      #bundle_sid  ⇒ String 
    
    
  
  
  
  
  
  
  
  
  
    The SID of the Bundle resource that you associate with the phone number. 
- #capabilities ⇒ ApiV2010AccountIncomingPhoneNumberCapabilities
- 
  
    
      #context  ⇒ IncomingPhoneNumberContext 
    
    
  
  
  
  
  
  
  
  
  
    Generate an instance context for the instance, the context is capable of performing various actions. 
- 
  
    
      #date_created  ⇒ Time 
    
    
  
  
  
  
  
  
  
  
  
    The date and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format. 
- 
  
    
      #date_updated  ⇒ Time 
    
    
  
  
  
  
  
  
  
  
  
    The date and time in GMT that the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format. 
- 
  
    
      #delete  ⇒ Boolean 
    
    
  
  
  
  
  
  
  
  
  
    Delete the IncomingPhoneNumberInstance. 
- 
  
    
      #emergency_address_sid  ⇒ String 
    
    
  
  
  
  
  
  
  
  
  
    The SID of the emergency address configuration that we use for emergency calling from this phone number. 
- #emergency_address_status ⇒ EmergencyAddressStatus
- #emergency_status ⇒ EmergencyStatus
- 
  
    
      #fetch  ⇒ IncomingPhoneNumberInstance 
    
    
  
  
  
  
  
  
  
  
  
    Fetch the IncomingPhoneNumberInstance. 
- 
  
    
      #friendly_name  ⇒ String 
    
    
  
  
  
  
  
  
  
  
  
    The string that you assigned to describe the resource. 
- 
  
    
      #identity_sid  ⇒ String 
    
    
  
  
  
  
  
  
  
  
  
    The SID of the Identity resource that we associate with the phone number. 
- 
  
    
      #initialize(version, payload, account_sid: nil, sid: nil)  ⇒ IncomingPhoneNumberInstance 
    
    
  
  
  
    constructor
  
  
  
  
  
  
  
    Initialize the IncomingPhoneNumberInstance. 
- 
  
    
      #inspect  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    Provide a detailed, user friendly representation. 
- 
  
    
      #origin  ⇒ String 
    
    
  
  
  
  
  
  
  
  
  
    The phone number’s origin. 
- 
  
    
      #phone_number  ⇒ String 
    
    
  
  
  
  
  
  
  
  
  
    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. 
- 
  
    
      #sid  ⇒ String 
    
    
  
  
  
  
  
  
  
  
  
    The unique string that that we created to identify this IncomingPhoneNumber resource. 
- 
  
    
      #sms_application_sid  ⇒ String 
    
    
  
  
  
  
  
  
  
  
  
    The SID of the application that handles SMS messages sent to the phone number. 
- 
  
    
      #sms_fallback_method  ⇒ String 
    
    
  
  
  
  
  
  
  
  
  
    The HTTP method we use to call ‘sms_fallback_url`. 
- 
  
    
      #sms_fallback_url  ⇒ String 
    
    
  
  
  
  
  
  
  
  
  
    The URL that we call when an error occurs while retrieving or executing the TwiML from ‘sms_url`. 
- 
  
    
      #sms_method  ⇒ String 
    
    
  
  
  
  
  
  
  
  
  
    The HTTP method we use to call ‘sms_url`. 
- 
  
    
      #sms_url  ⇒ String 
    
    
  
  
  
  
  
  
  
  
  
    The URL we call when the phone number receives an incoming SMS message. 
- #status ⇒ String
- 
  
    
      #status_callback  ⇒ String 
    
    
  
  
  
  
  
  
  
  
  
    The URL we call using the ‘status_callback_method` to send status information to your application. 
- 
  
    
      #status_callback_method  ⇒ String 
    
    
  
  
  
  
  
  
  
  
  
    The HTTP method we use to call ‘status_callback`. 
- 
  
    
      #to_s  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    Provide a user friendly representation. 
- 
  
    
      #trunk_sid  ⇒ String 
    
    
  
  
  
  
  
  
  
  
  
    The SID of the Trunk that handles calls to the phone number. 
- 
  
    
      #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. 
- 
  
    
      #uri  ⇒ String 
    
    
  
  
  
  
  
  
  
  
  
    The URI of the resource, relative to ‘api.twilio.com`. 
- 
  
    
      #voice_application_sid  ⇒ String 
    
    
  
  
  
  
  
  
  
  
  
    The SID of the application that handles calls to the phone number. 
- 
  
    
      #voice_caller_id_lookup  ⇒ Boolean 
    
    
  
  
  
  
  
  
  
  
  
    Whether we look up the caller’s caller-ID name from the CNAM database ($0.01 per look up). 
- 
  
    
      #voice_fallback_method  ⇒ String 
    
    
  
  
  
  
  
  
  
  
  
    The HTTP method we use to call ‘voice_fallback_url`. 
- 
  
    
      #voice_fallback_url  ⇒ String 
    
    
  
  
  
  
  
  
  
  
  
    The URL that we call when an error occurs retrieving or executing the TwiML requested by ‘url`. 
- 
  
    
      #voice_method  ⇒ String 
    
    
  
  
  
  
  
  
  
  
  
    The HTTP method we use to call ‘voice_url`. 
- #voice_receive_mode ⇒ VoiceReceiveMode
- 
  
    
      #voice_url  ⇒ String 
    
    
  
  
  
  
  
  
  
  
  
    The URL we call when the phone number receives a call. 
Constructor Details
#initialize(version, payload, account_sid: nil, sid: nil) ⇒ IncomingPhoneNumberInstance
Initialize the IncomingPhoneNumberInstance
| 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 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 490 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' => account_sid ,'sid' => sid || @properties['sid'] , } end | 
Instance Method Details
#account_sid ⇒ String
Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created this IncomingPhoneNumber resource.
| 549 550 551 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 549 def account_sid @properties['account_sid'] end | 
#address_requirements ⇒ AddressRequirement
| 561 562 563 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 561 def address_requirements @properties['address_requirements'] end | 
#address_sid ⇒ String
Returns The SID of the Address resource associated with the phone number.
| 555 556 557 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 555 def address_sid @properties['address_sid'] end | 
#api_version ⇒ String
Returns The API version used to start a new TwiML session.
| 567 568 569 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 567 def api_version @properties['api_version'] end | 
#assigned_add_ons ⇒ assigned_add_ons
Access the assigned_add_ons
| 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 Whether the phone number is new to the Twilio platform. Can be: ‘true` or `false`.
| 573 574 575 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 573 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.
| 741 742 743 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 741 def bundle_sid @properties['bundle_sid'] end | 
#capabilities ⇒ ApiV2010AccountIncomingPhoneNumberCapabilities
| 579 580 581 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 579 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
| 540 541 542 543 544 545 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 540 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 and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
| 585 586 587 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 585 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.
| 591 592 593 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 591 def date_updated @properties['date_updated'] end | 
#delete ⇒ Boolean
Delete the IncomingPhoneNumberInstance
| 754 755 756 757 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 754 def delete context.delete end | 
#emergency_address_sid ⇒ String
Returns The SID of the emergency address configuration that we use for emergency calling from this phone number.
| 729 730 731 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 729 def emergency_address_sid @properties['emergency_address_sid'] end | 
#emergency_address_status ⇒ EmergencyAddressStatus
| 735 736 737 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 735 def emergency_address_status @properties['emergency_address_status'] end | 
#emergency_status ⇒ EmergencyStatus
| 723 724 725 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 723 def emergency_status @properties['emergency_status'] end | 
#fetch ⇒ IncomingPhoneNumberInstance
Fetch the IncomingPhoneNumberInstance
| 762 763 764 765 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 762 def fetch context.fetch end | 
#friendly_name ⇒ String
Returns The string that you assigned to describe the resource.
| 597 598 599 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 597 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.
| 603 604 605 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 603 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 The phone number’s origin. ‘twilio` identifies Twilio-owned phone numbers and `hosted` identifies hosted phone numbers.
| 615 616 617 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 615 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.
| 609 610 611 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 609 def phone_number @properties['phone_number'] end | 
#sid ⇒ String
Returns The unique string that that we created to identify this IncomingPhoneNumber resource.
| 621 622 623 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 621 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.
| 627 628 629 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 627 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`.
| 633 634 635 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 633 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`.
| 639 640 641 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 639 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`.
| 645 646 647 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 645 def sms_method @properties['sms_method'] end | 
#sms_url ⇒ String
Returns The URL we call when the phone number receives an incoming SMS message.
| 651 652 653 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 651 def sms_url @properties['sms_url'] end | 
#status ⇒ String
| 747 748 749 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 747 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.
| 657 658 659 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 657 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`.
| 663 664 665 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 663 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 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.
| 669 670 671 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 669 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
| 793 794 795 796 797 798 799 800 801 802 803 804 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 831 832 833 834 835 836 837 838 839 840 841 842 843 844 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 793 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: 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`.
| 675 676 677 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 675 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.
| 687 688 689 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 687 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`.
| 693 694 695 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 693 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`.
| 699 700 701 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 699 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`.
| 705 706 707 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 705 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`.
| 711 712 713 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 711 def voice_method @properties['voice_method'] end | 
#voice_receive_mode ⇒ VoiceReceiveMode
| 681 682 683 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 681 def voice_receive_mode @properties['voice_receive_mode'] end | 
#voice_url ⇒ String
Returns The URL we call when the phone number receives a call. The ‘voice_url` will not be used if a `voice_application_sid` or a `trunk_sid` is set.
| 717 718 719 | # File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 717 def voice_url @properties['voice_url'] end |