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:



21
22
23
24
25
26
27
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 21

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, validity_period: :unset, max_rate: :unset, force_delivery: :unset, provider_sid: :unset, content_retention: :unset, address_retention: :unset, smart_encoded: :unset, from: :unset, messaging_service_sid: :unset, body: :unset, media_url: :unset) ⇒ MessageInstance

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

Parameters:

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

    The destination phone number for SMS/MMS or a [Channel user address](www.twilio.com/docs/sms/channels#channel-addresses) for other 3rd party channels. Destination phone numbers should be formatted with a ‘+’ and country code e.g., ‘+16175551212` ([E.164](www.twilio.com/docs/glossary/what-e164) format).

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

    A URL where Twilio will POST each time your message status changes to one of the following: ‘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`(see more details [below](#statuscallback-request-parameters)). If you include this parameter in addition to a `MessagingServiceSid`, Twilio will override the Status Callback URL of the [Messaging Service](www.twilio.com/docs/sms/services/api). URLs must contain a valid hostname – underscores are not allowed.

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

    Twilio will POST a ‘MessageSid` as well as `MessageStatus=sent` or `MessageStatus=failed` to the URL in the `MessageStatusCallback` property of this [application](www.twilio.com/docs/usage/api/applications). If the `StatusCallback` parameter is also passed, the application’s ‘MessageStatusCallback` parameter will take precedence.

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

    The total maximum price up to the fourth decimal (0.0001) in US dollars acceptable for the message to be delivered. *All messages will be queued for delivery regardless of the price point.* A POST request will later be made to your Status Callback URL with a status change of ‘Sent` or `Failed`. When the price of the message is greater than this value, the message will fail and not be sent. When `MaxPrice` is not set, all prices for the message are accepted.

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

    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). This parameter is `false` by default.

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

    The number of seconds that the message can remain in a Twilio queue. After exceeding this time limit, the message will fail and a POST request will later be made to your Status Callback URL. Valid values are between 1 and 14400 seconds (the default). Please note that Twilio cannot guarantee that a message will not be queued by the carrier after they accept the message. We do not recommend setting validity periods of less than 5 seconds.

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

    The max_rate

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

    The force_delivery

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

    The provider_sid

  • content_retention (message.ContentRetention) (defaults to: :unset) —

    The content_retention

  • address_retention (message.AddressRetention) (defaults to: :unset) —

    The address_retention

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

    The smart_encoded

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

    A Twilio phone number (in [E.164](www.twilio.com/docs/glossary/what-e164) format), [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) enabled for the type of message you wish to send. Phone numbers or [short codes](www.twilio.com/docs/sms/api/short-codes) purchased from Twilio work here. You cannot (for example) spoof messages from your own cell phone number. *Do not use this parameter if you are using ‘MessagingServiceSid`.*

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

    The 34-character unique ID of the [Messaging Service](www.twilio.com/docs/sms/services#send-a-message-with-copilot) you want to associate with this Message. Set this parameter to use the [Messaging Service Settings and Copilot Features](www.twilio.com/console/sms/services) you have configured. When only this parameter is set, Twilio will use your enabled Copilot Features to select the ‘From` phone number for delivery. *Do not pass this value if you are using `From`.*

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

    The text of the message you want to send, limited to 1600 characters.

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

    The URL containing the media you wish to send with the message. ‘gif` , `png` and `jpeg` content is currently supported and will be formatted correctly on the recipient’s device. [Other types](www.twilio.com/docs/sms/accepted-mime-types) are also accepted by the API. The media size limit is 5MB. If you wish to send more than one image in the message body, please provide multiple ‘MediaUrl` values in the POST request. You may include up to 10 MediaUrls per message. *Sending images via SMS is currently only possible in the US and Canada*

Returns:



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 107

def create(to: nil, status_callback: :unset, application_sid: :unset, max_price: :unset, provide_feedback: :unset, validity_period: :unset, max_rate: :unset, force_delivery: :unset, provider_sid: :unset, content_retention: :unset, address_retention: :unset, smart_encoded: :unset, from: :unset, messaging_service_sid: :unset, body: :unset, media_url: :unset)
  data = Twilio::Values.of({
      'To' => to,
      'From' => from,
      'MessagingServiceSid' => messaging_service_sid,
      'Body' => body,
      'MediaUrl' => Twilio.serialize_list(media_url) { |e| e },
      'StatusCallback' => status_callback,
      'ApplicationSid' => application_sid,
      'MaxPrice' => max_price,
      'ProvideFeedback' => provide_feedback,
      'ValidityPeriod' => validity_period,
      'MaxRate' => max_rate,
      'ForceDelivery' => force_delivery,
      'ProviderSid' => provider_sid,
      'ContentRetention' => content_retention,
      'AddressRetention' => address_retention,
      'SmartEncoded' => smart_encoded,
  })

  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.



201
202
203
204
205
206
207
208
209
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 201

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



248
249
250
251
252
253
254
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 248

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_before: :unset, date_sent: :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) —

    Only show messages to this phone number.

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

    Only show messages from this phone number or alphanumeric sender ID.

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

    Filter by date sent

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

    Filter by date sent

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

    Filter by date sent

  • 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



153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 153

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

#page(to: :unset, from: :unset, date_sent_before: :unset, date_sent: :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) —

    Only show messages to this phone number.

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

    Only show messages from this phone number or alphanumeric sender ID.

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

    Filter by date sent

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

    Filter by date sent

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

    Filter by date sent

  • 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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 224

def page(to: :unset, from: :unset, date_sent_before: :unset, date_sent: :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_before),
      'DateSent' => Twilio.serialize_iso8601_datetime(date_sent),
      'DateSent>' => Twilio.serialize_iso8601_datetime(date_sent_after),
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  MessagePage.new(@version, response, @solution)
end

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

Streams MessageInstance 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) —

    Only show messages to this phone number.

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

    Only show messages from this phone number or alphanumeric sender ID.

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

    Filter by date sent

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

    Filter by date sent

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

    Filter by date sent

  • 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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 182

def stream(to: :unset, from: :unset, date_sent_before: :unset, date_sent: :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_before: date_sent_before,
      date_sent: date_sent,
      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



258
259
260
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 258

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