Class: Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberList::LocalInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberList::LocalInstance
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the Account that created the resource.
-
#address_requirements ⇒ local.AddressRequirement
Whether the phone number requires an Address registered with Twilio.
-
#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.
-
#beta ⇒ Boolean
Whether the phone number is new to the Twilio platform.
-
#bundle_sid ⇒ String
The SID of the Bundle resource associated with number.
-
#capabilities ⇒ String
Indicate if a phone can receive calls or messages.
-
#date_created ⇒ Time
The RFC 2822 date and time in GMT that the resource was created.
-
#date_updated ⇒ Time
The RFC 2822 date and time in GMT that the resource was last updated.
-
#emergency_address_sid ⇒ String
The emergency address configuration to use for emergency calling.
-
#emergency_address_status ⇒ local.EmergencyAddressStatus
State of the emergency address configuration for the phone number.
-
#emergency_status ⇒ local.EmergencyStatus
Displays if emergency calling is enabled for this number.
-
#friendly_name ⇒ String
The string that you assigned to describe the resource.
-
#identity_sid ⇒ String
The SID of the Identity resource associated with number.
-
#initialize(version, payload, account_sid: nil) ⇒ LocalInstance
constructor
Initialize the LocalInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#origin ⇒ String
The phone number's origin.
-
#phone_number ⇒ String
The phone number in E.164 format.
-
#sid ⇒ String
The unique string that identifies the resource.
-
#sms_application_sid ⇒ String
The SID of the Application resource to handle SMS messages.
-
#sms_fallback_method ⇒ String
The HTTP method used with sms_fallback_url.
-
#sms_fallback_url ⇒ String
The URL that we call when an error occurs while retrieving or executing the TwiML.
-
#sms_method ⇒ String
The HTTP method to use with sms_url.
-
#sms_url ⇒ String
The URL we call when the phone number receives an incoming SMS message.
-
#status ⇒ String
The status.
-
#status_callback ⇒ String
The URL 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.
-
#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 to lookup the caller's name.
-
#voice_fallback_method ⇒ String
The HTTP method used with voice_fallback_url.
-
#voice_fallback_url ⇒ String
The URL we call when an error occurs in TwiML.
-
#voice_method ⇒ String
The HTTP method used with the voice_url.
-
#voice_receive_mode ⇒ local.VoiceReceiveMode
The voice_receive_mode.
-
#voice_url ⇒ String
The URL we call when this phone number receives a call.
Constructor Details
#initialize(version, payload, account_sid: nil) ⇒ LocalInstance
Initialize the LocalInstance
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 298 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 that created the resource.
342 343 344 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 342 def account_sid @properties['account_sid'] end |
#address_requirements ⇒ local.AddressRequirement
Returns Whether the phone number requires an Address registered with Twilio.
354 355 356 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 354 def address_requirements @properties['address_requirements'] end |
#address_sid ⇒ String
Returns The SID of the Address resource associated with the phone number.
348 349 350 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 348 def address_sid @properties['address_sid'] end |
#api_version ⇒ String
Returns The API version used to start a new TwiML session.
360 361 362 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 360 def api_version @properties['api_version'] end |
#beta ⇒ Boolean
Returns Whether the phone number is new to the Twilio platform.
366 367 368 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 366 def beta @properties['beta'] end |
#bundle_sid ⇒ String
Returns The SID of the Bundle resource associated with number.
534 535 536 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 534 def bundle_sid @properties['bundle_sid'] end |
#capabilities ⇒ String
Returns Indicate if a phone can receive calls or messages.
372 373 374 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 372 def capabilities @properties['capabilities'] end |
#date_created ⇒ Time
Returns The RFC 2822 date and time in GMT that the resource was created.
378 379 380 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 378 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.
384 385 386 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 384 def date_updated @properties['date_updated'] end |
#emergency_address_sid ⇒ String
Returns The emergency address configuration to use for emergency calling.
522 523 524 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 522 def emergency_address_sid @properties['emergency_address_sid'] end |
#emergency_address_status ⇒ local.EmergencyAddressStatus
Returns State of the emergency address configuration for the phone number.
528 529 530 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 528 def emergency_address_status @properties['emergency_address_status'] end |
#emergency_status ⇒ local.EmergencyStatus
Returns Displays if emergency calling is enabled for this number.
516 517 518 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 516 def emergency_status @properties['emergency_status'] end |
#friendly_name ⇒ String
Returns The string that you assigned to describe the resource.
390 391 392 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 390 def friendly_name @properties['friendly_name'] end |
#identity_sid ⇒ String
Returns The SID of the Identity resource associated with number.
396 397 398 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 396 def identity_sid @properties['identity_sid'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
552 553 554 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 552 def inspect "<Twilio.Api.V2010.LocalInstance>" end |
#origin ⇒ String
Returns The phone number's origin. Can be twilio or hosted.
408 409 410 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 408 def origin @properties['origin'] end |
#phone_number ⇒ String
Returns The phone number in E.164 format.
402 403 404 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 402 def phone_number @properties['phone_number'] end |
#sid ⇒ String
Returns The unique string that identifies the resource.
414 415 416 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 414 def sid @properties['sid'] end |
#sms_application_sid ⇒ String
Returns The SID of the Application resource to handle SMS messages.
420 421 422 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 420 def sms_application_sid @properties['sms_application_sid'] end |
#sms_fallback_method ⇒ String
Returns The HTTP method used with sms_fallback_url.
426 427 428 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 426 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.
432 433 434 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 432 def sms_fallback_url @properties['sms_fallback_url'] end |
#sms_method ⇒ String
Returns The HTTP method to use with sms_url.
438 439 440 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 438 def sms_method @properties['sms_method'] end |
#sms_url ⇒ String
Returns The URL we call when the phone number receives an incoming SMS message.
444 445 446 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 444 def sms_url @properties['sms_url'] end |
#status ⇒ String
Returns The status.
540 541 542 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 540 def status @properties['status'] end |
#status_callback ⇒ String
Returns The URL to send status information to your application.
450 451 452 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 450 def status_callback @properties['status_callback'] end |
#status_callback_method ⇒ String
Returns The HTTP method we use to call status_callback.
456 457 458 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 456 def status_callback_method @properties['status_callback_method'] end |
#to_s ⇒ Object
Provide a user friendly representation
546 547 548 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 546 def to_s "<Twilio.Api.V2010.LocalInstance>" end |
#trunk_sid ⇒ String
Returns The SID of the Trunk that handles calls to the phone number.
462 463 464 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 462 def trunk_sid @properties['trunk_sid'] end |
#uri ⇒ String
Returns The URI of the resource, relative to `api.twilio.com`.
468 469 470 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 468 def uri @properties['uri'] end |
#voice_application_sid ⇒ String
Returns The SID of the application that handles calls to the phone number.
480 481 482 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 480 def voice_application_sid @properties['voice_application_sid'] end |
#voice_caller_id_lookup ⇒ Boolean
Returns Whether to lookup the caller's name.
486 487 488 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 486 def voice_caller_id_lookup @properties['voice_caller_id_lookup'] end |
#voice_fallback_method ⇒ String
Returns The HTTP method used with voice_fallback_url.
492 493 494 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 492 def voice_fallback_method @properties['voice_fallback_method'] end |
#voice_fallback_url ⇒ String
Returns The URL we call when an error occurs in TwiML.
498 499 500 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 498 def voice_fallback_url @properties['voice_fallback_url'] end |
#voice_method ⇒ String
Returns The HTTP method used with the voice_url.
504 505 506 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 504 def voice_method @properties['voice_method'] end |
#voice_receive_mode ⇒ local.VoiceReceiveMode
Returns The voice_receive_mode.
474 475 476 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 474 def voice_receive_mode @properties['voice_receive_mode'] end |
#voice_url ⇒ String
Returns The URL we call when this phone number receives a call.
510 511 512 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 510 def voice_url @properties['voice_url'] end |