Twilio.Resources.Api.V2010.Message (twilio_elixir v0.1.1)

Copy Markdown View Source

A Message resource represents an inbound or outbound message.

SID prefix: SM|MM

Parent: /Accounts/{Sid}.json

Sub-resources

  • feedback — /2010-04-01/Accounts/{account_sid}/Messages/{message_sid}/Feedback.json
  • media — /2010-04-01/Accounts/{account_sid}/Messages/{message_sid}/Media.json

Properties

FieldDescription

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

account_sidThe SID of the Account associated with the Message resource
api_versionThe API version used to process the Message
bodyThe text content of the message. PII: standard

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| date_created | The RFC 2822 timestamp (in GMT) of when the Message resource was created. Format: date-time-rfc-2822 |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| date_sent | The RFC 2822 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.. Format: date-time-rfc-2822 |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| date_updated | The RFC 2822 timestamp (in GMT) of when the Message resource was last updated. Format: date-time-rfc-2822 |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| direction | The direction of the message. Can be: inbound for incoming messages, outbound-api for messages created by the REST API, outbound-call for messages created during a call, or outbound-reply for messages created in response to an incoming message.. Values: inbound, outbound-api, outbound-call, outbound-reply |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| error_code | The error code 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. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| error_message | 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. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| from | The sender's phone number (in E.164 format), alphanumeric sender ID, Wireless SIM, short code, or channel address (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.. Format: phone-number. PII: standard |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

messaging_service_sidThe SID of the Messaging Service associated with the Message resource. A unique default value is assigned if a Messaging Service is not used.
num_mediaThe number of media files associated with the Message resource.

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| num_segments | The number of segments that make up the complete message. SMS message bodies that exceed the 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. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| price | 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 for more details. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

price_unitThe currency in which price is measured, in ISO 4127 format (e.g. usd, eur, jpy).. Format: currency
sidThe unique, Twilio-provided string that identifies the Message resource.

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| status | The status of the Message. Possible values: accepted, scheduled, canceled, queued, sending, sent, failed, delivered, undelivered, receiving, received, or read (WhatsApp only). For more information, See detailed descriptions.. Values: queued, sending, sent, failed, delivered, undelivered, receiving, received, accepted, scheduled, read, partially_delivered, canceled |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| subresource_uris | A list of related resources identified by their URIs relative to https://api.twilio.com. Format: uri-map |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

toThe recipient's phone number (in E.164 format) or channel address (e.g. whatsapp:+15552229999). PII: standard
uriThe URI of the Message resource, relative to https://api.twilio.com.

Summary

Types

t()

Functions

object_name()
sid_prefix()

Types

t()

@type t() :: %Twilio.Resources.Api.V2010.Message{
  account_sid: String.t() | nil,
  api_version: String.t() | nil,
  body: String.t() | nil,
  date_created: String.t() | nil,
  date_sent: String.t() | nil,
  date_updated: String.t() | nil,
  direction: String.t(),
  error_code: integer() | nil,
  error_message: String.t() | nil,
  from: String.t() | nil,
  messaging_service_sid: String.t() | nil,
  num_media: String.t() | nil,
  num_segments: String.t() | nil,
  price: String.t() | nil,
  price_unit: String.t() | nil,
  sid: String.t() | nil,
  status: String.t(),
  subresource_uris: map() | nil,
  to: String.t() | nil,
  uri: String.t() | nil
}

Functions

object_name()

sid_prefix()