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.



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
320
321
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb', line 281

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:



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

def 
    @properties['account_sid']
end

#address_requirements ⇒ AddressRequirement

Returns:

  • (AddressRequirement) 


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

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.



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

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.



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

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



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

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.



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

def bundle_sid
    @properties['bundle_sid']
end

#capabilities ⇒ ApiV2010AccountIncomingPhoneNumberCapabilities

Returns:

  • (ApiV2010AccountIncomingPhoneNumberCapabilities) 


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

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:



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

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:



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

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.



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

def emergency_address_sid
    @properties['emergency_address_sid']
end

#emergency_address_status ⇒ EmergencyAddressStatus

Returns:

  • (EmergencyAddressStatus) 


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

def emergency_address_status
    @properties['emergency_address_status']
end

#emergency_status ⇒ EmergencyStatus

Returns:

  • (EmergencyStatus) 


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

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.



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

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.



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

def identity_sid
    @properties['identity_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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.



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

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:



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

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.



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

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.



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

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



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

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



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

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



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

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.



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

def sms_url
    @properties['sms_url']
end

#status ⇒ String

Returns:

  • (String) 


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

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.



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

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



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

def status_callback_method
    @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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.



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

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



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

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.



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

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



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

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



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

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



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

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



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

def voice_method
    @properties['voice_method']
end

#voice_receive_mode ⇒ VoiceReceiveMode

Returns:

  • (VoiceReceiveMode) 


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

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.



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

def voice_url
    @properties['voice_url']
end