Class: Twilio::REST::Messaging::V1::ServiceInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/messaging/v1/service.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ ServiceInstance

Initialize the ServiceInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Service resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 466

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'friendly_name' => payload['friendly_name'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'inbound_request_url' => payload['inbound_request_url'],
        'inbound_method' => payload['inbound_method'],
        'fallback_url' => payload['fallback_url'],
        'fallback_method' => payload['fallback_method'],
        'status_callback' => payload['status_callback'],
        'sticky_sender' => payload['sticky_sender'],
        'mms_converter' => payload['mms_converter'],
        'smart_encoding' => payload['smart_encoding'],
        'scan_message_content' => payload['scan_message_content'],
        'fallback_to_long_code' => payload['fallback_to_long_code'],
        'area_code_geomatch' => payload['area_code_geomatch'],
        'synchronous_validation' => payload['synchronous_validation'],
        'validity_period' => payload['validity_period'] == nil ? payload['validity_period'] : payload['validity_period'].to_i,
        'url' => payload['url'],
        'links' => payload['links'],
        'usecase' => payload['usecase'],
        'us_app_to_person_registered' => payload['us_app_to_person_registered'],
        'use_inbound_webhook_on_number' => payload['use_inbound_webhook_on_number'],
    }

    # Context
    @instance_context = nil
    @params = { '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 the Service resource.

Returns:



520
521
522
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 520

def 
    @properties['account_sid']
end

#alpha_senders ⇒ alpha_senders

Access the alpha_senders

Returns:



755
756
757
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 755

def alpha_senders
    context.alpha_senders
end

#area_code_geomatch ⇒ Boolean

Returns Whether to enable [Area Code Geomatch](www.twilio.com/docs/messaging/services#area-code-geomatch) on the Service Instance.

Returns:



604
605
606
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 604

def area_code_geomatch
    @properties['area_code_geomatch']
end

#channel_senders ⇒ channel_senders

Access the channel_senders

Returns:



762
763
764
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 762

def channel_senders
    context.channel_senders
end

#context ⇒ ServiceContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



505
506
507
508
509
510
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 505

def context
    unless @instance_context
        @instance_context = ServiceContext.new(@version , @params['sid'])
    end
    @instance_context
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



532
533
534
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 532

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



538
539
540
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 538

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ServiceInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



653
654
655
656
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 653

def delete

    context.delete
end

#fallback_method ⇒ String

Returns The HTTP method we use to call ‘fallback_url`. Can be: `GET` or `POST`.

Returns:

  • (String) —

    The HTTP method we use to call ‘fallback_url`. Can be: `GET` or `POST`.



562
563
564
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 562

def fallback_method
    @properties['fallback_method']
end

#fallback_to_long_code ⇒ Boolean

Returns [OBSOLETE] Former feature used to fallback to long code sender after certain short code message failures.

Returns:

  • (Boolean) —
    OBSOLETE

    Former feature used to fallback to long code sender after certain short code message failures.



598
599
600
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 598

def fallback_to_long_code
    @properties['fallback_to_long_code']
end

#fallback_url ⇒ String

Returns The URL that we call using ‘fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service.

Returns:

  • (String) —

    The URL that we call using ‘fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service.



556
557
558
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 556

def fallback_url
    @properties['fallback_url']
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

Returns:



661
662
663
664
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 661

def fetch

    context.fetch
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.



526
527
528
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 526

def friendly_name
    @properties['friendly_name']
end

#inbound_method ⇒ String

Returns The HTTP method we use to call ‘inbound_request_url`. Can be `GET` or `POST`.

Returns:

  • (String) —

    The HTTP method we use to call ‘inbound_request_url`. Can be `GET` or `POST`.



550
551
552
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 550

def inbound_method
    @properties['inbound_method']
end

#inbound_request_url ⇒ String

Returns The URL we call using ‘inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `inbound_request_url` defined for the Messaging Service.

Returns:

  • (String) —

    The URL we call using ‘inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `inbound_request_url` defined for the Messaging Service.



544
545
546
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 544

def inbound_request_url
    @properties['inbound_request_url']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



775
776
777
778
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 775

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Messaging.V1.ServiceInstance #{values}>"
end

#links ⇒ Hash

Returns The absolute URLs of related resources.

Returns:

  • (Hash) —

    The absolute URLs of related resources.



628
629
630
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 628

def links
    @properties['links']
end

#mms_converter ⇒ Boolean

Returns Whether to enable the [MMS Converter](www.twilio.com/docs/messaging/services#mms-converter) for messages sent through the Service instance.

Returns:



580
581
582
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 580

def mms_converter
    @properties['mms_converter']
end

#phone_numbers ⇒ phone_numbers

Access the phone_numbers

Returns:



748
749
750
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 748

def phone_numbers
    context.phone_numbers
end

#scan_message_content ⇒ ScanMessageContent

Returns:

  • (ScanMessageContent) 


592
593
594
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 592

def scan_message_content
    @properties['scan_message_content']
end

#short_codes ⇒ short_codes

Access the short_codes

Returns:



734
735
736
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 734

def short_codes
    context.short_codes
end

#sid ⇒ String

Returns The unique string that we created to identify the Service resource.

Returns:

  • (String) —

    The unique string that we created to identify the Service resource.



514
515
516
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 514

def sid
    @properties['sid']
end

#smart_encoding ⇒ Boolean

Returns Whether to enable [Smart Encoding](www.twilio.com/docs/messaging/services#smart-encoding) for messages sent through the Service instance.

Returns:



586
587
588
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 586

def smart_encoding
    @properties['smart_encoding']
end

#status_callback ⇒ String

Returns The URL we call to [pass status updates](www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery.

Returns:



568
569
570
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 568

def status_callback
    @properties['status_callback']
end

#sticky_sender ⇒ Boolean

Returns Whether to enable [Sticky Sender](www.twilio.com/docs/messaging/services#sticky-sender) on the Service instance.

Returns:



574
575
576
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 574

def sticky_sender
    @properties['sticky_sender']
end

#synchronous_validation ⇒ Boolean

Returns Reserved.

Returns:

  • (Boolean) —

    Reserved.



610
611
612
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 610

def synchronous_validation
    @properties['synchronous_validation']
end

#to_s ⇒ Object

Provide a user friendly representation



768
769
770
771
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 768

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Messaging.V1.ServiceInstance #{values}>"
end

#update(friendly_name: :unset, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset, usecase: :unset, use_inbound_webhook_on_number: :unset) ⇒ ServiceInstance

Update the ServiceInstance

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    A descriptive string that you create to describe the resource. It can be up to 64 characters long.

  • inbound_request_url (String) (defaults to: :unset) —

    The URL we call using ‘inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `inbound_request_url` defined for the Messaging Service.

  • inbound_method (String) (defaults to: :unset) —

    The HTTP method we should use to call ‘inbound_request_url`. Can be `GET` or `POST` and the default is `POST`.

  • fallback_url (String) (defaults to: :unset) —

    The URL that we call using ‘fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service.

  • fallback_method (String) (defaults to: :unset) —

    The HTTP method we should use to call ‘fallback_url`. Can be: `GET` or `POST`.

  • status_callback (String) (defaults to: :unset) —

    The URL we should call to [pass status updates](www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery.

  • sticky_sender (Boolean) (defaults to: :unset) —

    Whether to enable [Sticky Sender](www.twilio.com/docs/messaging/services#sticky-sender) on the Service instance.

  • mms_converter (Boolean) (defaults to: :unset) —

    Whether to enable the [MMS Converter](www.twilio.com/docs/messaging/services#mms-converter) for messages sent through the Service instance.

  • smart_encoding (Boolean) (defaults to: :unset) —

    Whether to enable [Smart Encoding](www.twilio.com/docs/messaging/services#smart-encoding) for messages sent through the Service instance.

  • scan_message_content (ScanMessageContent) (defaults to: :unset)
  • fallback_to_long_code (Boolean) (defaults to: :unset) —
    OBSOLETE

    Former feature used to fallback to long code sender after certain short code message failures.

  • area_code_geomatch (Boolean) (defaults to: :unset) —

    Whether to enable [Area Code Geomatch](www.twilio.com/docs/messaging/services#area-code-geomatch) on the Service Instance.

  • validity_period (String) (defaults to: :unset) —

    How long, in seconds, messages sent from the Service are valid. Can be an integer from ‘1` to `14,400`.

  • synchronous_validation (Boolean) (defaults to: :unset) —

    Reserved.

  • usecase (String) (defaults to: :unset) —

    A string that describes the scenario in which the Messaging Service will be used. Possible values are ‘notifications`, `marketing`, `verification`, `discussion`, `poll`, `undeclared`.

  • use_inbound_webhook_on_number (Boolean) (defaults to: :unset) —

    A boolean value that indicates either the webhook url configured on the phone number will be used or ‘inbound_request_url`/`fallback_url` url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service.

Returns:



685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 685

def update(
    friendly_name: :unset, 
    inbound_request_url: :unset, 
    inbound_method: :unset, 
    fallback_url: :unset, 
    fallback_method: :unset, 
    status_callback: :unset, 
    sticky_sender: :unset, 
    mms_converter: :unset, 
    smart_encoding: :unset, 
    scan_message_content: :unset, 
    fallback_to_long_code: :unset, 
    area_code_geomatch: :unset, 
    validity_period: :unset, 
    synchronous_validation: :unset, 
    usecase: :unset, 
    use_inbound_webhook_on_number: :unset
)

    context.update(
        friendly_name: friendly_name, 
        inbound_request_url: inbound_request_url, 
        inbound_method: inbound_method, 
        fallback_url: fallback_url, 
        fallback_method: fallback_method, 
        status_callback: status_callback, 
        sticky_sender: sticky_sender, 
        mms_converter: mms_converter, 
        smart_encoding: smart_encoding, 
        scan_message_content: scan_message_content, 
        fallback_to_long_code: fallback_to_long_code, 
        area_code_geomatch: area_code_geomatch, 
        validity_period: validity_period, 
        synchronous_validation: synchronous_validation, 
        usecase: usecase, 
        use_inbound_webhook_on_number: use_inbound_webhook_on_number, 
    )
end

#url ⇒ String

Returns The absolute URL of the Service resource.

Returns:

  • (String) —

    The absolute URL of the Service resource.



622
623
624
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 622

def url
    @properties['url']
end

#us_app_to_person ⇒ us_app_to_person

Access the us_app_to_person

Returns:



741
742
743
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 741

def us_app_to_person
    context.us_app_to_person
end

#us_app_to_person_registered ⇒ Boolean

Returns Whether US A2P campaign is registered for this Service.

Returns:

  • (Boolean) —

    Whether US A2P campaign is registered for this Service.



640
641
642
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 640

def us_app_to_person_registered
    @properties['us_app_to_person_registered']
end

#us_app_to_person_usecases ⇒ us_app_to_person_usecases

Access the us_app_to_person_usecases

Returns:



727
728
729
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 727

def us_app_to_person_usecases
    context.us_app_to_person_usecases
end

#use_inbound_webhook_on_number ⇒ Boolean

Returns A boolean value that indicates either the webhook url configured on the phone number will be used or ‘inbound_request_url`/`fallback_url` url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service.

Returns:

  • (Boolean) —

    A boolean value that indicates either the webhook url configured on the phone number will be used or ‘inbound_request_url`/`fallback_url` url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service.



646
647
648
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 646

def use_inbound_webhook_on_number
    @properties['use_inbound_webhook_on_number']
end

#usecase ⇒ String

Returns A string that describes the scenario in which the Messaging Service will be used. Possible values are ‘notifications`, `marketing`, `verification`, `discussion`, `poll`, `undeclared`.

Returns:

  • (String) —

    A string that describes the scenario in which the Messaging Service will be used. Possible values are ‘notifications`, `marketing`, `verification`, `discussion`, `poll`, `undeclared`.



634
635
636
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 634

def usecase
    @properties['usecase']
end

#validity_period ⇒ String

Returns How long, in seconds, messages sent from the Service are valid. Can be an integer from ‘1` to `14,400`.

Returns:

  • (String) —

    How long, in seconds, messages sent from the Service are valid. Can be an integer from ‘1` to `14,400`.



616
617
618
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 616

def validity_period
    @properties['validity_period']
end