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

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

Instance Method Summary collapse

Constructor Details

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

Initialize the MobileInstance

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

  • sid (String) —

    The SID of the Call resource to fetch.



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 279

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:



324
325
326
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 324

def 
    @properties['account_sid']
end

#address_requirements ⇒ AddressRequirement

Returns:

  • (AddressRequirement) 


336
337
338
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 336

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.



330
331
332
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 330

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.



342
343
344
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 342

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`.



348
349
350
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 348

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.



516
517
518
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 516

def bundle_sid
    @properties['bundle_sid']
end

#capabilities ⇒ ApiV2010AccountIncomingPhoneNumberCapabilities

Returns:

  • (ApiV2010AccountIncomingPhoneNumberCapabilities) 


354
355
356
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 354

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:



360
361
362
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 360

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:



366
367
368
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 366

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.



504
505
506
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 504

def emergency_address_sid
    @properties['emergency_address_sid']
end

#emergency_address_status ⇒ EmergencyAddressStatus

Returns:

  • (EmergencyAddressStatus) 


510
511
512
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 510

def emergency_address_status
    @properties['emergency_address_status']
end

#emergency_status ⇒ EmergencyStatus

Returns:

  • (EmergencyStatus) 


498
499
500
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 498

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.



372
373
374
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 372

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.



378
379
380
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 378

def identity_sid
    @properties['identity_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

def inspect
    "<Twilio.Api.V2010.MobileInstance>"
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.



390
391
392
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 390

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:



384
385
386
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 384

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.



396
397
398
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 396

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.



402
403
404
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 402

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`.



408
409
410
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 408

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`.



414
415
416
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 414

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`.



420
421
422
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 420

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.



426
427
428
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 426

def sms_url
    @properties['sms_url']
end

#status ⇒ String

Returns:

  • (String) 


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

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.



432
433
434
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 432

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`.



438
439
440
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 438

def status_callback_method
    @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



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

def to_s
    "<Twilio.Api.V2010.MobileInstance>"
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.



444
445
446
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 444

def trunk_sid
    @properties['trunk_sid']
end

#uri ⇒ String

Returns The URI of the resource, relative to ‘api.twilio.com`.

Returns:

  • (String) —

    The URI of the resource, relative to ‘api.twilio.com`.



450
451
452
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 450

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.



462
463
464
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 462

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`.



468
469
470
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 468

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`.



474
475
476
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 474

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`.



480
481
482
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 480

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`.



486
487
488
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 486

def voice_method
    @properties['voice_method']
end

#voice_receive_mode ⇒ VoiceReceiveMode

Returns:

  • (VoiceReceiveMode) 


456
457
458
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 456

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.

Returns:

  • (String) —

    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.



492
493
494
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 492

def voice_url
    @properties['voice_url']
end