Class: Twilio::REST::Api::V2010::AccountContext::MessageList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil) ⇒ MessageList

Initialize the MessageList

Parameters:

  • version (Version) —

    Version that contains the resource



27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 27

def initialize(version, account_sid: nil)
    super(version)
    # Path Solution
    @solution = { account_sid:  }
    @uri = "/Accounts/#{@solution[:account_sid]}/Messages.json"
    
end

Instance Method Details

#create(to: nil, status_callback: :unset, application_sid: :unset, max_price: :unset, provide_feedback: :unset, attempt: :unset, validity_period: :unset, force_delivery: :unset, content_retention: :unset, address_retention: :unset, smart_encoded: :unset, persistent_action: :unset, shorten_urls: :unset, schedule_type: :unset, send_at: :unset, send_as_mms: :unset, content_sid: :unset, content_variables: :unset, from: :unset, messaging_service_sid: :unset, body: :unset, media_url: :unset) ⇒ MessageInstance

Create the MessageInstance

Parameters:

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

    The destination phone number in [E.164](www.twilio.com/docs/glossary/what-e164) format for SMS/MMS or [Channel user address](www.twilio.com/docs/sms/channels#channel-addresses) for other 3rd-party channels.

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

    The URL we should call using the ‘status_callback_method` to send status information to your application. If specified, we POST these message status changes to the URL: `queued`, `failed`, `sent`, `delivered`, or `undelivered`. Twilio will POST its [standard request parameters](www.twilio.com/docs/sms/twiml#request-parameters) as well as some additional parameters including `MessageSid`, `MessageStatus`, and `ErrorCode`. If you include this parameter with the `messaging_service_sid`, we use this URL instead of the Status Callback URL of the [Messaging Service](www.twilio.com/docs/sms/services/api). URLs must contain a valid hostname and underscores are not allowed.

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

    The SID of the application that should receive message status. We POST a ‘message_sid` parameter and a `message_status` parameter with a value of `sent` or `failed` to the [application](www.twilio.com/docs/usage/api/applications)’s ‘message_status_callback`. If a `status_callback` parameter is also passed, it will be ignored and the application’s ‘message_status_callback` parameter will be used.

  • max_price (Float) (defaults to: :unset) —

    The maximum total price in US dollars that you will pay for the message to be delivered. Can be a decimal value that has up to 4 decimal places. All messages are queued for delivery and the message cost is checked before the message is sent. If the cost exceeds ‘max_price`, the message will fail and a status of `Failed` is sent to the status callback. If `MaxPrice` is not set, the message cost is not checked.

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

    Whether to confirm delivery of the message. Set this value to ‘true` if you are sending messages that have a trackable user action and you intend to confirm delivery of the message using the [Message Feedback API](www.twilio.com/docs/sms/api/message-feedback-resource). This parameter is `false` by default.

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

    Total number of attempts made ( including this ) to send out the message regardless of the provider used

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

    How long in seconds the message can remain in our outgoing message queue. After this period elapses, the message fails and we call your status callback. Can be between 1 and the default value of 14,400 seconds. After a message has been accepted by a carrier, however, we cannot guarantee that the message will not be queued after this period. We recommend that this value be at least 5 seconds.

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

    Reserved

  • content_retention (ContentRetention) (defaults to: :unset)
  • address_retention (AddressRetention) (defaults to: :unset)
  • smart_encoded (Boolean) (defaults to: :unset) —

    Whether to detect Unicode characters that have a similar GSM-7 character and replace them. Can be: ‘true` or `false`.

  • persistent_action (Array[String]) (defaults to: :unset) —

    Rich actions for Channels Messages.

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

    Determines the usage of Click Tracking. Setting it to ‘true` will instruct Twilio to replace all links in the Message with a shortened version based on the associated Domain Sid and track clicks on them. If this parameter is not set on an API call, we will use the value set on the Messaging Service. If this parameter is not set and the value is not configured on the Messaging Service used this will default to `false`.

  • schedule_type (ScheduleType) (defaults to: :unset)
  • send_at (Time) (defaults to: :unset) —

    The time that Twilio will send the message. Must be in ISO 8601 format.

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

    If set to True, Twilio will deliver the message as a single MMS message, regardless of the presence of media.

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

    The SID of the Content object returned at Content API content create time (www.twilio.com/docs/content-api/create-and-send-your-first-content-api-template#create-a-template). If this parameter is not specified, then the Content API will not be utilized.

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

    Key-value pairs of variable names to substitution values, used alongside a content_sid. If not specified, Content API will default to the default variables defined at create time.

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

    A Twilio phone number in [E.164](www.twilio.com/docs/glossary/what-e164) format, an [alphanumeric sender ID](www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), or a [Channel Endpoint address](www.twilio.com/docs/sms/channels#channel-addresses) that is enabled for the type of message you want to send. Phone numbers or [short codes](www.twilio.com/docs/sms/api/short-code) purchased from Twilio also work here. You cannot, for example, spoof messages from a private cell phone number. If you are using ‘messaging_service_sid`, this parameter must be empty.

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

    The SID of the [Messaging Service](www.twilio.com/docs/sms/services#send-a-message-with-copilot) you want to associate with the Message. Set this parameter to use the [Messaging Service Settings and Copilot Features](www.twilio.com/console/sms/services) you have configured and leave the ‘from` parameter empty. When only this parameter is set, Twilio will use your enabled Copilot Features to select the `from` phone number for delivery.

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

    The text of the message you want to send. Can be up to 1,600 characters in length.

  • media_url (Array[String]) (defaults to: :unset) —

    The URL of the media to send with the message. The media can be of type ‘gif`, `png`, and `jpeg` and will be formatted correctly on the recipient’s device. The media size limit is 5MB for supported file types (JPEG, PNG, GIF) and 500KB for [other types](www.twilio.com/docs/sms/accepted-mime-types) of accepted media. To send more than one image in the message body, provide multiple ‘media_url` parameters in the POST request. You can include up to 10 `media_url` parameters per message. You can send images in an SMS message in only the US and Canada.

Returns:



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 59

def create(
    to: nil, 
    status_callback: :unset, 
    application_sid: :unset, 
    max_price: :unset, 
    provide_feedback: :unset, 
    attempt: :unset, 
    validity_period: :unset, 
    force_delivery: :unset, 
    content_retention: :unset, 
    address_retention: :unset, 
    smart_encoded: :unset, 
    persistent_action: :unset, 
    shorten_urls: :unset, 
    schedule_type: :unset, 
    send_at: :unset, 
    send_as_mms: :unset, 
    content_sid: :unset, 
    content_variables: :unset, 
    from: :unset, 
    messaging_service_sid: :unset, 
    body: :unset, 
    media_url: :unset
)

    data = Twilio::Values.of({
        'To' => to,
        'StatusCallback' => status_callback,
        'ApplicationSid' => application_sid,
        'MaxPrice' => max_price,
        'ProvideFeedback' => provide_feedback,
        'Attempt' => attempt,
        'ValidityPeriod' => validity_period,
        'ForceDelivery' => force_delivery,
        'ContentRetention' => content_retention,
        'AddressRetention' => address_retention,
        'SmartEncoded' => smart_encoded,
        'PersistentAction' => Twilio.serialize_list(persistent_action) { |e| e },
        'ShortenUrls' => shorten_urls,
        'ScheduleType' => schedule_type,
        'SendAt' => Twilio.serialize_iso8601_datetime(send_at),
        'SendAsMms' => send_as_mms,
        'ContentSid' => content_sid,
        'ContentVariables' => content_variables,
        'From' => from,
        'MessagingServiceSid' => messaging_service_sid,
        'Body' => body,
        'MediaUrl' => Twilio.serialize_list(media_url) { |e| e },
    })

    payload = @version.create('POST', @uri, data: data)
    MessageInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
    )
end

#each ⇒ Object

When passed a block, yields MessageInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



180
181
182
183
184
185
186
187
188
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 180

def each
    limits = @version.read_limits

    page = self.page(page_size: limits[:page_size], )

    @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of MessageInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of MessageInstance



230
231
232
233
234
235
236
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 230

def get_page(target_url)
    response = @version.domain.request(
        'GET',
        target_url
    )
MessagePage.new(@version, response, @solution)
end

#list(to: :unset, from: :unset, date_sent: :unset, date_sent_before: :unset, date_sent_after: :unset, limit: nil, page_size: nil) ⇒ Array

Lists MessageInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.

Parameters:

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

    Read messages sent to only this phone number.

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

    Read messages sent from only this phone number or alphanumeric sender ID.

  • date_sent (Time) (defaults to: :unset) —

    The date of the messages to show. Specify a date as ‘YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.

  • date_sent_before (Time) (defaults to: :unset) —

    The date of the messages to show. Specify a date as ‘YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.

  • date_sent_after (Time) (defaults to: :unset) —

    The date of the messages to show. Specify a date as ‘YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 134

def list(to: :unset, from: :unset, date_sent: :unset, date_sent_before: :unset, date_sent_after: :unset, limit: nil, page_size: nil)
    self.stream(
        to: to,
        from: from,
        date_sent: date_sent,
        date_sent_before: date_sent_before,
        date_sent_after: date_sent_after,
        limit: limit,
        page_size: page_size
    ).entries
end

#page(to: :unset, from: :unset, date_sent: :unset, date_sent_before: :unset, date_sent_after: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of MessageInstance records from the API. Request is executed immediately.

Parameters:

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

    Read messages sent to only this phone number.

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

    Read messages sent from only this phone number or alphanumeric sender ID.

  • date_sent (Time) (defaults to: :unset) —

    The date of the messages to show. Specify a date as ‘YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.

  • date_sent_before (Time) (defaults to: :unset) —

    The date of the messages to show. Specify a date as ‘YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.

  • date_sent_after (Time) (defaults to: :unset) —

    The date of the messages to show. Specify a date as ‘YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.

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

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of MessageInstance



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 202

def page(to: :unset, from: :unset, date_sent: :unset, date_sent_before: :unset, date_sent_after: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        
        'To' => to,
        
        'From' => from,
        
        'DateSent' =>  Twilio.serialize_iso8601_datetime(date_sent),
        
        'DateSent<' =>  Twilio.serialize_iso8601_datetime(date_sent_before),
        
        'DateSent>' =>  Twilio.serialize_iso8601_datetime(date_sent_after),
        
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })

    response = @version.page('GET', @uri, params: params)

    MessagePage.new(@version, response, @solution)
end

#stream(to: :unset, from: :unset, date_sent: :unset, date_sent_before: :unset, date_sent_after: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

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

    Read messages sent to only this phone number.

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

    Read messages sent from only this phone number or alphanumeric sender ID.

  • date_sent (Time) (defaults to: :unset) —

    The date of the messages to show. Specify a date as ‘YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.

  • date_sent_before (Time) (defaults to: :unset) —

    The date of the messages to show. Specify a date as ‘YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.

  • date_sent_after (Time) (defaults to: :unset) —

    The date of the messages to show. Specify a date as ‘YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 162

def stream(to: :unset, from: :unset, date_sent: :unset, date_sent_before: :unset, date_sent_after: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        to: to,
        from: from,
        date_sent: date_sent,
        date_sent_before: date_sent_before,
        date_sent_after: date_sent_after,
        page_size: limits[:page_size], )

    @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



241
242
243
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 241

def to_s
    '#<Twilio.Api.V2010.MessageList>'
end