Class: Twilio::REST::Api::V2010::AccountContext::MessageInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, sid: nil) ⇒ MessageInstance

Initialize the MessageInstance

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

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

    The SID of the Call resource to fetch.



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 421

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' =>   ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) associated with the Message resource.

Returns:



520
521
522
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 520

def 
    @properties['account_sid']
end

#api_version ⇒ String

Returns The API version used to process the Message.

Returns:

  • (String) —

    The API version used to process the Message



574
575
576
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 574

def api_version
    @properties['api_version']
end

#body ⇒ String

Returns The text content of the message.

Returns:

  • (String) —

    The text content of the message



466
467
468
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 466

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

Returns:



457
458
459
460
461
462
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 457

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

#date_created ⇒ Time

Returns The [RFC 2822](datatracker.ietf.org/doc/html/rfc2822#section-3.3) timestamp (in GMT) of when the Message resource was created.

Returns:



556
557
558
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 556

def date_created
    @properties['date_created']
end

#date_sent ⇒ Time

Returns The [RFC 2822](datatracker.ietf.org/doc/html/rfc2822#section-3.3) timestamp (in GMT) of when the Message was sent. For an outgoing message, this is when Twilio sent the message. For an incoming message, this is when Twilio sent the HTTP request to your incoming message webhook URL.

Returns:

  • (Time) —

    The [RFC 2822](datatracker.ietf.org/doc/html/rfc2822#section-3.3) timestamp (in GMT) of when the Message was sent. For an outgoing message, this is when Twilio sent the message. For an incoming message, this is when Twilio sent the HTTP request to your incoming message webhook URL.



550
551
552
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 550

def date_sent
    @properties['date_sent']
end

#date_updated ⇒ Time

Returns The [RFC 2822](datatracker.ietf.org/doc/html/rfc2822#section-3.3) timestamp (in GMT) of when the Message resource was last updated.

Returns:



496
497
498
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 496

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the MessageInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



587
588
589
590
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 587

def delete

    context.delete
end

#direction ⇒ Direction

Returns:

  • (Direction) 


478
479
480
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 478

def direction
    @properties['direction']
end

#error_code ⇒ String

Returns The [error code](www.twilio.com/docs/api/errors) returned if the Message ‘status` is `failed` or `undelivered`. If no error was encountered, the value is `null`. The value returned in this field for a specific error cause is subject to change as Twilio improves errors. Users should not use the `error_code` and `error_message` fields programmatically.

Returns:

  • (String) —

    The [error code](www.twilio.com/docs/api/errors) returned if the Message ‘status` is `failed` or `undelivered`. If no error was encountered, the value is `null`. The value returned in this field for a specific error cause is subject to change as Twilio improves errors. Users should not use the `error_code` and `error_message` fields programmatically.



562
563
564
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 562

def error_code
    @properties['error_code']
end

#error_message ⇒ String

Returns The description of the ‘error_code` if the Message `status` is `failed` or `undelivered`. If no error was encountered, the value is `null`. The value returned in this field for a specific error cause is subject to change as Twilio improves errors. Users should not use the `error_code` and `error_message` fields programmatically.

Returns:

  • (String) —

    The description of the ‘error_code` if the Message `status` is `failed` or `undelivered`. If no error was encountered, the value is `null`. The value returned in this field for a specific error cause is subject to change as Twilio improves errors. Users should not use the `error_code` and `error_message` fields programmatically.



508
509
510
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 508

def error_message
    @properties['error_message']
end

#feedback ⇒ feedback

Access the feedback

Returns:



619
620
621
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 619

def feedback
    context.feedback
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance

Returns:



595
596
597
598
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 595

def fetch

    context.fetch
end

#from ⇒ String

Returns 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`). For incoming messages, this is the number or channel address of the sender. For outgoing messages, this value is a Twilio phone number, alphanumeric sender ID, short code, or channel address from which the message is sent.

Returns:



484
485
486
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 484

def from
    @properties['from']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



639
640
641
642
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 639

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

#media ⇒ media

Access the media

Returns:



626
627
628
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 626

def media
    context.media
end

#messaging_service_sid ⇒ String

Returns The SID of the [Messaging Service](www.twilio.com/docs/messaging/api/service-resource) associated with the Message resource. A unique default value is assigned if a Messaging Service is not used.

Returns:



538
539
540
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 538

def messaging_service_sid
    @properties['messaging_service_sid']
end

#num_media ⇒ String

Returns The number of media files associated with the Message resource.

Returns:

  • (String) —

    The number of media files associated with the Message resource.



526
527
528
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 526

def num_media
    @properties['num_media']
end

#num_segments ⇒ String

Returns The number of segments that make up the complete message. SMS message bodies that exceed the [character limit](www.twilio.com/docs/glossary/what-sms-character-limit) are segmented and charged as multiple messages. Note: For messages sent via a Messaging Service, ‘num_segments` is initially `0`, since a sender hasn’t yet been assigned.

Returns:

  • (String) —

    The number of segments that make up the complete message. SMS message bodies that exceed the [character limit](www.twilio.com/docs/glossary/what-sms-character-limit) are segmented and charged as multiple messages. Note: For messages sent via a Messaging Service, ‘num_segments` is initially `0`, since a sender hasn’t yet been assigned.



472
473
474
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 472

def num_segments
    @properties['num_segments']
end

#price ⇒ String

Returns The amount billed for the message in the currency specified by ‘price_unit`. The `price` is populated after the message has been sent/received, and may not be immediately availalble. View the [Pricing page](www.twilio.com/en-us/pricing) for more details.

Returns:

  • (String) —

    The amount billed for the message in the currency specified by ‘price_unit`. The `price` is populated after the message has been sent/received, and may not be immediately availalble. View the [Pricing page](www.twilio.com/en-us/pricing) for more details.



502
503
504
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 502

def price
    @properties['price']
end

#price_unit ⇒ String

Returns The currency in which ‘price` is measured, in [ISO 4127](www.iso.org/iso/home/standards/currency_codes.htm) format (e.g. `usd`, `eur`, `jpy`).

Returns:



568
569
570
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 568

def price_unit
    @properties['price_unit']
end

#sid ⇒ String

Returns The unique, Twilio-provided string that identifies the Message resource.

Returns:

  • (String) —

    The unique, Twilio-provided string that identifies the Message resource.



544
545
546
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 544

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


532
533
534
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 532

def status
    @properties['status']
end

#subresource_uris ⇒ Hash

Returns A list of related resources identified by their URIs relative to ‘api.twilio.com`.

Returns:

  • (Hash) —

    A list of related resources identified by their URIs relative to ‘api.twilio.com`



580
581
582
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 580

def subresource_uris
    @properties['subresource_uris']
end

#to ⇒ String

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

Returns:



490
491
492
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 490

def to
    @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



632
633
634
635
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 632

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

Parameters:

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

    The new ‘body` of the Message resource. To redact the text content of a Message, this parameter’s value must be an empty string

  • status (UpdateStatus) (defaults to: :unset)

Returns:



605
606
607
608
609
610
611
612
613
614
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 605

def update(
    body: :unset, 
    status: :unset
)

    context.update(
        body: body, 
        status: status, 
    )
end

#uri ⇒ String

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

Returns:

  • (String) —

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



514
515
516
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 514

def uri
    @properties['uri']
end