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

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

Instance Method Summary collapse

Constructor Details

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

Initialize the TollFreeInstance

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

  • sid (String) —

    The SID of the Call resource to fetch.



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

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:



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

def 
    @properties['account_sid']
end

#address_requirements ⇒ AddressRequirement

Returns:

  • (AddressRequirement) 


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

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.



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

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.



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

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



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

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.



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

def bundle_sid
    @properties['bundle_sid']
end

#capabilities ⇒ ApiV2010AccountIncomingPhoneNumberCapabilities

Returns:

  • (ApiV2010AccountIncomingPhoneNumberCapabilities) 


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

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:



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

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:



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

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.



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

def emergency_address_sid
    @properties['emergency_address_sid']
end

#emergency_address_status ⇒ EmergencyAddressStatus

Returns:

  • (EmergencyAddressStatus) 


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

def emergency_address_status
    @properties['emergency_address_status']
end

#emergency_status ⇒ EmergencyStatus

Returns:

  • (EmergencyStatus) 


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

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.



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

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.



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

def identity_sid
    @properties['identity_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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



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

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:



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

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.



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

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.



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

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



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

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



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

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



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

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.



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

def sms_url
    @properties['sms_url']
end

#status ⇒ String

Returns:

  • (String) 


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

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.



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

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



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

def status_callback_method
    @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

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



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

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.



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

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



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

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



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

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



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

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



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

def voice_method
    @properties['voice_method']
end

#voice_receive_mode ⇒ VoiceReceiveMode

Returns:

  • (VoiceReceiveMode) 


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

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.



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

def voice_url
    @properties['voice_url']
end