Class: Twilio::REST::Api::V2010::AccountContext::MessageInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Api::V2010::AccountContext::MessageInstance
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/message.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) associated with the Message resource.
-
#api_version ⇒ String
The API version used to process the Message.
-
#body ⇒ String
The text content of the message.
-
#context ⇒ MessageContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The [RFC 2822](datatracker.ietf.org/doc/html/rfc2822#section-3.3) timestamp (in GMT) of when the Message resource was created.
-
#date_sent ⇒ Time
The [RFC 2822](datatracker.ietf.org/doc/html/rfc2822#section-3.3) timestamp (in GMT) of when the Message was sent.
-
#date_updated ⇒ Time
The [RFC 2822](datatracker.ietf.org/doc/html/rfc2822#section-3.3) timestamp (in GMT) of when the Message resource was last updated.
-
#delete ⇒ Boolean
Delete the MessageInstance.
- #direction ⇒ Direction
-
#error_code ⇒ String
The [error code](www.twilio.com/docs/api/errors) returned if the Message
statusisfailedorundelivered. -
#error_message ⇒ String
The description of the
error_codeif the Messagestatusisfailedorundelivered. -
#feedback ⇒ feedback
Access the feedback.
-
#fetch ⇒ MessageInstance
Fetch the MessageInstance.
-
#from ⇒ String
The sender’s phone number (in [E.164](en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](www.twilio.com/docs/sms/quickstart), [Wireless SIM](www.twilio.com/docs/iot/wireless/programmable-wireless-send-machine-machine-sms-commands), [short code](www.twilio.com/en-us/messaging/channels/sms/short-codes), or [channel address](www.twilio.com/docs/messaging/channels) (e.g., ‘whatsapp:+15554449999`).
-
#initialize(version, payload, account_sid: nil, sid: nil) ⇒ MessageInstance
constructor
Initialize the MessageInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#media ⇒ media
Access the media.
-
#messaging_service_sid ⇒ String
The SID of the [Messaging Service](www.twilio.com/docs/messaging/api/service-resource) associated with the Message resource.
-
#num_media ⇒ String
The number of media files associated with the Message resource.
-
#num_segments ⇒ String
The number of segments that make up the complete message.
-
#price ⇒ String
The amount billed for the message in the currency specified by
price_unit. -
#price_unit ⇒ String
The currency in which
priceis measured, in [ISO 4127](www.iso.org/iso/home/standards/currency_codes.htm) format (e.g.usd,eur,jpy). -
#sid ⇒ String
The unique, Twilio-provided string that identifies the Message resource.
- #status ⇒ Status
-
#subresource_uris ⇒ Hash
A list of related resources identified by their URIs relative to
https://api.twilio.com. -
#to ⇒ String
The recipient’s phone number (in [E.164](en.wikipedia.org/wiki/E.164) format) or [channel address](www.twilio.com/docs/messaging/channels) (e.g. ‘whatsapp:+15552229999`).
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(body: :unset, status: :unset) ⇒ MessageInstance
Update the MessageInstance.
-
#uri ⇒ String
The URI of the Message resource, relative to
https://api.twilio.com.
Constructor Details
#initialize(version, payload, account_sid: nil, sid: nil) ⇒ MessageInstance
Initialize the MessageInstance
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 746 def initialize(version, payload , account_sid: nil, sid: nil) super(version) # Marshaled Properties @properties = { 'body' => payload['body'], 'num_segments' => payload['num_segments'], 'direction' => payload['direction'], 'from' => payload['from'], 'to' => payload['to'], 'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']), 'price' => payload['price'], 'error_message' => payload['error_message'], 'uri' => payload['uri'], 'account_sid' => payload['account_sid'], 'num_media' => payload['num_media'], 'status' => payload['status'], 'messaging_service_sid' => payload['messaging_service_sid'], 'sid' => payload['sid'], 'date_sent' => Twilio.deserialize_rfc2822(payload['date_sent']), 'date_created' => Twilio.deserialize_rfc2822(payload['date_created']), 'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i, 'price_unit' => payload['price_unit'], 'api_version' => payload['api_version'], 'subresource_uris' => payload['subresource_uris'], } # Context @instance_context = nil @params = { 'account_sid' => account_sid ,'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
846 847 848 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 846 def account_sid @properties['account_sid'] end |
#api_version ⇒ String
900 901 902 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 900 def api_version @properties['api_version'] end |
#body ⇒ String
792 793 794 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 792 def body @properties['body'] end |
#context ⇒ MessageContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
783 784 785 786 787 788 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 783 def context unless @instance_context @instance_context = MessageContext.new(@version , @params['account_sid'], @params['sid']) end @instance_context end |
#date_created ⇒ Time
882 883 884 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 882 def date_created @properties['date_created'] end |
#date_sent ⇒ Time
876 877 878 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 876 def date_sent @properties['date_sent'] end |
#date_updated ⇒ Time
822 823 824 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 822 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the MessageInstance
913 914 915 916 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 913 def delete context.delete end |
#direction ⇒ Direction
804 805 806 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 804 def direction @properties['direction'] end |
#error_code ⇒ String
888 889 890 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 888 def error_code @properties['error_code'] end |
#error_message ⇒ String
834 835 836 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 834 def @properties['error_message'] end |
#feedback ⇒ feedback
Access the feedback
945 946 947 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 945 def feedback context.feedback end |
#fetch ⇒ MessageInstance
Fetch the MessageInstance
921 922 923 924 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 921 def fetch context.fetch end |
#from ⇒ String
810 811 812 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 810 def from @properties['from'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
965 966 967 968 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 965 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Api.V2010.MessageInstance #{values}>" end |
#media ⇒ media
Access the media
952 953 954 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 952 def media context.media end |
#messaging_service_sid ⇒ String
864 865 866 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 864 def messaging_service_sid @properties['messaging_service_sid'] end |
#num_media ⇒ String
852 853 854 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 852 def num_media @properties['num_media'] end |
#num_segments ⇒ String
798 799 800 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 798 def num_segments @properties['num_segments'] end |
#price ⇒ String
828 829 830 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 828 def price @properties['price'] end |
#price_unit ⇒ String
894 895 896 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 894 def price_unit @properties['price_unit'] end |
#sid ⇒ String
870 871 872 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 870 def sid @properties['sid'] end |
#status ⇒ Status
858 859 860 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 858 def status @properties['status'] end |
#subresource_uris ⇒ Hash
906 907 908 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 906 def subresource_uris @properties['subresource_uris'] end |
#to ⇒ String
816 817 818 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 816 def to @properties['to'] end |
#to_s ⇒ Object
Provide a user friendly representation
958 959 960 961 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 958 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Api.V2010.MessageInstance #{values}>" end |
#update(body: :unset, status: :unset) ⇒ MessageInstance
Update the MessageInstance
931 932 933 934 935 936 937 938 939 940 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 931 def update( body: :unset, status: :unset ) context.update( body: body, status: status, ) end |
#uri ⇒ String
840 841 842 |
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 840 def uri @properties['uri'] end |