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:



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

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, force_delivery: :unset, smart_encoded: :unset, interactive_data: :unset, force_opt_in: :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 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 (String) (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). This parameter is `false` by default.

  • 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

  • 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`.

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

    A JSON string that represents an interactive message. An interactive message is a category of messages that includes a list picker, a time picker, and an Apple Pay request.

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

    Whether to forcefully whitelist a from:to pair. Can be: ‘true` or `false`.

  • 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-codes) 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 (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. [Other types](www.twilio.com/docs/sms/accepted-mime-types) of media are also accepted. The media size limit is 5MB. 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:



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 103

def create(to: nil, status_callback: :unset, application_sid: :unset, max_price: :unset, provide_feedback: :unset, validity_period: :unset, force_delivery: :unset, smart_encoded: :unset, interactive_data: :unset, force_opt_in: :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,
      'ForceDelivery' => force_delivery,
      'SmartEncoded' => smart_encoded,
      'InteractiveData' => interactive_data,
      'ForceOptIn' => force_opt_in,
  })

  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.



195
196
197
198
199
200
201
202
203
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 195

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



242
243
244
245
246
247
248
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 242

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

    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_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



147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 147

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

    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_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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 218

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

    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_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



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

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



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

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