class Twilio::MessagesApi

Defined in:

twilio/api/messages_api.cr

Constant Summary

CREATE_MESSAGE_FEEDBACK_MAX_LENGTH_FOR_ACCOUNT_SID = 34
CREATE_MESSAGE_FEEDBACK_MAX_LENGTH_FOR_MESSAGE_SID = 34
CREATE_MESSAGE_FEEDBACK_MIN_LENGTH_FOR_ACCOUNT_SID = 34
CREATE_MESSAGE_FEEDBACK_MIN_LENGTH_FOR_MESSAGE_SID = 34
CREATE_MESSAGE_FEEDBACK_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
CREATE_MESSAGE_FEEDBACK_PATTERN_FOR_MESSAGE_SID = /^(SM|MM)[0-9a-fA-F]{32}$/
CREATE_MESSAGE_MAX_LENGTH_FOR_ACCOUNT_SID = 34
CREATE_MESSAGE_MAX_LENGTH_FOR_APPLICATION_SID = 34
CREATE_MESSAGE_MAX_LENGTH_FOR_CONTENT_SID = 34
CREATE_MESSAGE_MAX_LENGTH_FOR_MESSAGING_SERVICE_SID = 34
CREATE_MESSAGE_MIN_LENGTH_FOR_ACCOUNT_SID = 34
CREATE_MESSAGE_MIN_LENGTH_FOR_APPLICATION_SID = 34
CREATE_MESSAGE_MIN_LENGTH_FOR_CONTENT_SID = 34
CREATE_MESSAGE_MIN_LENGTH_FOR_MESSAGING_SERVICE_SID = 34
CREATE_MESSAGE_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
CREATE_MESSAGE_PATTERN_FOR_APPLICATION_SID = /^AP[0-9a-fA-F]{32}$/
CREATE_MESSAGE_PATTERN_FOR_CONTENT_SID = /^HX[0-9a-fA-F]{32}$/
CREATE_MESSAGE_PATTERN_FOR_MESSAGING_SERVICE_SID = /^MG[0-9a-fA-F]{32}$/
DELETE_MEDIA_MAX_LENGTH_FOR_ACCOUNT_SID = 34
DELETE_MEDIA_MAX_LENGTH_FOR_MESSAGE_SID = 34
DELETE_MEDIA_MAX_LENGTH_FOR_SID = 34
DELETE_MEDIA_MIN_LENGTH_FOR_ACCOUNT_SID = 34
DELETE_MEDIA_MIN_LENGTH_FOR_MESSAGE_SID = 34
DELETE_MEDIA_MIN_LENGTH_FOR_SID = 34
DELETE_MEDIA_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
DELETE_MEDIA_PATTERN_FOR_MESSAGE_SID = /^(SM|MM)[0-9a-fA-F]{32}$/
DELETE_MEDIA_PATTERN_FOR_SID = /^ME[0-9a-fA-F]{32}$/
DELETE_MESSAGE_MAX_LENGTH_FOR_ACCOUNT_SID = 34
DELETE_MESSAGE_MAX_LENGTH_FOR_SID = 34
DELETE_MESSAGE_MIN_LENGTH_FOR_ACCOUNT_SID = 34
DELETE_MESSAGE_MIN_LENGTH_FOR_SID = 34
DELETE_MESSAGE_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
DELETE_MESSAGE_PATTERN_FOR_SID = /^(SM|MM)[0-9a-fA-F]{32}$/
FETCH_MEDIA_MAX_LENGTH_FOR_ACCOUNT_SID = 34
FETCH_MEDIA_MAX_LENGTH_FOR_MESSAGE_SID = 34
FETCH_MEDIA_MAX_LENGTH_FOR_SID = 34
FETCH_MEDIA_MIN_LENGTH_FOR_ACCOUNT_SID = 34
FETCH_MEDIA_MIN_LENGTH_FOR_MESSAGE_SID = 34
FETCH_MEDIA_MIN_LENGTH_FOR_SID = 34
FETCH_MEDIA_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
FETCH_MEDIA_PATTERN_FOR_MESSAGE_SID = /^(SM|MM)[0-9a-fA-F]{32}$/
FETCH_MEDIA_PATTERN_FOR_SID = /^ME[0-9a-fA-F]{32}$/
FETCH_MESSAGE_MAX_LENGTH_FOR_ACCOUNT_SID = 34
FETCH_MESSAGE_MAX_LENGTH_FOR_SID = 34
FETCH_MESSAGE_MIN_LENGTH_FOR_ACCOUNT_SID = 34
FETCH_MESSAGE_MIN_LENGTH_FOR_SID = 34
FETCH_MESSAGE_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
FETCH_MESSAGE_PATTERN_FOR_SID = /^(SM|MM)[0-9a-fA-F]{32}$/
LIST_MEDIA_MAX_FOR_PAGE_SIZE = Int32.new("1000")
LIST_MEDIA_MAX_LENGTH_FOR_ACCOUNT_SID = 34
LIST_MEDIA_MAX_LENGTH_FOR_MESSAGE_SID = 34
LIST_MEDIA_MIN_FOR_PAGE_SIZE = Int32.new("1")
LIST_MEDIA_MIN_LENGTH_FOR_ACCOUNT_SID = 34
LIST_MEDIA_MIN_LENGTH_FOR_MESSAGE_SID = 34
LIST_MEDIA_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
LIST_MEDIA_PATTERN_FOR_MESSAGE_SID = /^(SM|MM)[0-9a-fA-F]{32}$/
LIST_MESSAGE_MAX_FOR_PAGE_SIZE = Int32.new("1000")
LIST_MESSAGE_MAX_LENGTH_FOR_ACCOUNT_SID = 34
LIST_MESSAGE_MIN_FOR_PAGE_SIZE = Int32.new("1")
LIST_MESSAGE_MIN_LENGTH_FOR_ACCOUNT_SID = 34
LIST_MESSAGE_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
UPDATE_MESSAGE_MAX_LENGTH_FOR_ACCOUNT_SID = 34
UPDATE_MESSAGE_MAX_LENGTH_FOR_SID = 34
UPDATE_MESSAGE_MIN_LENGTH_FOR_ACCOUNT_SID = 34
UPDATE_MESSAGE_MIN_LENGTH_FOR_SID = 34
UPDATE_MESSAGE_PATTERN_FOR_ACCOUNT_SID = /^AC[0-9a-fA-F]{32}$/
UPDATE_MESSAGE_PATTERN_FOR_SID = /^(SM|MM)[0-9a-fA-F]{32}$/

Constructors

Instance Method Summary

Constructor Detail

def self.new(api_client : Twilio::ApiClient = ApiClient.default) #

[View source]

Instance Method Detail

def account_sid : String #

[View source]
def account_sid=(account_sid : String) #

[View source]
def api_client : ApiClient #

[View source]
def api_client=(api_client : ApiClient) #

[View source]
def build_api_request_for_create_message(*, account_sid : String | Nil = @account_sid, to : String | Nil = nil, address_retention : Twilio::MessageEnumAddressRetention | Nil = nil, application_sid : String | Nil = nil, attempt : Int32 | Nil = nil, body : String | Nil = nil, content_retention : Twilio::MessageEnumAddressRetention | Nil = nil, content_sid : String | Nil = nil, content_variables : String | Nil = nil, force_delivery : Bool | Nil = nil, from : String | Nil = nil, max_price : Float64 | Nil = nil, media_url : Array(String) | Nil = nil, messaging_service_sid : String | Nil = nil, persistent_action : Array(String) | Nil = nil, provide_feedback : Bool | Nil = nil, schedule_type : Twilio::MessageEnumScheduleType | Nil = nil, send_as_mms : Bool | Nil = nil, send_at : Time | Nil = nil, shorten_urls : Bool | Nil = nil, smart_encoded : Bool | Nil = nil, status_callback : String | Nil = nil, validity_period : Int32 | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_create_message_feedback(*, account_sid : String | Nil = @account_sid, message_sid : String | Nil = nil, outcome : Twilio::MessageFeedbackEnumOutcome | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_delete_media(*, account_sid : String | Nil = @account_sid, message_sid : String | Nil = nil, sid : String | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_delete_message(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_fetch_media(*, account_sid : String | Nil = @account_sid, message_sid : String | Nil = nil, sid : String | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_fetch_message(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_list_media(*, account_sid : String | Nil = @account_sid, message_sid : String | Nil = nil, date_created : Time | Nil = nil, date_created_before : Time | Nil = nil, date_created_after : Time | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_list_message(*, account_sid : String | Nil = @account_sid, to : String | Nil = nil, from : String | Nil = nil, date_sent : Time | Nil = nil, date_sent_before : Time | Nil = nil, date_sent_after : Time | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_update_message(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, body : String | Nil = nil, status : Twilio::MessageEnumUpdateStatus | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def client_side_validation?(*args, **options) #

[View source]
def client_side_validation?(*args, **options, &) #

[View source]
def create_message(*, account_sid : String | Nil = @account_sid, to : String | Nil = nil, address_retention : Twilio::MessageEnumAddressRetention | Nil = nil, application_sid : String | Nil = nil, attempt : Int32 | Nil = nil, body : String | Nil = nil, content_retention : Twilio::MessageEnumAddressRetention | Nil = nil, content_sid : String | Nil = nil, content_variables : String | Nil = nil, force_delivery : Bool | Nil = nil, from : String | Nil = nil, max_price : Float64 | Nil = nil, media_url : Array(String) | Nil = nil, messaging_service_sid : String | Nil = nil, persistent_action : Array(String) | Nil = nil, provide_feedback : Bool | Nil = nil, schedule_type : Twilio::MessageEnumScheduleType | Nil = nil, send_as_mms : Bool | Nil = nil, send_at : Time | Nil = nil, shorten_urls : Bool | Nil = nil, smart_encoded : Bool | Nil = nil, status_callback : String | Nil = nil, validity_period : Int32 | Nil = nil) : Twilio::Message #

Send a message from the account used to make the request @required @param account_sid [String?] The SID of the Account that will create the resource. @required @param to [String?] The destination phone number in E.164 format for SMS/MMS or Channel user address for other 3rd-party channels. @optional @param address_retention [Twilio::MessageEnumAddressRetention?] @optional @param application_sid [String?] 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'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. @optional @param attempt [Int32?] Total number of attempts made ( including this ) to send out the message regardless of the provider used @optional @param body [String?] The text of the message you want to send. Can be up to 1,600 characters in length. @optional @param content_retention [Twilio::MessageEnumAddressRetention?] @optional @param content_sid [String?] The SID of the Content object returned at Content API content create time (https://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. @optional @param content_variables [String?] 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. @optional @param force_delivery [Bool?] Reserved @optional @param from [String?] A Twilio phone number in E.164 format, an alphanumeric sender ID, or a Channel Endpoint address that is enabled for the type of message you want to send. Phone numbers or 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. @optional @param max_price [Float64?] 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. @optional @param media_url [Array(String)?] 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 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. @optional @param messaging_service_sid [String?] The SID of the Messaging Service you want to associate with the Message. Set this parameter to use the Messaging Service Settings and Copilot Features 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. @optional @param persistent_action [Array(String)?] Rich actions for Channels Messages. @optional @param provide_feedback [Bool?] 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. This parameter is false by default. @optional @param schedule_type [Twilio::MessageEnumScheduleType?] @optional @param send_as_mms [Bool?] If set to True, Twilio will deliver the message as a single MMS message, regardless of the presence of media. @optional @param send_at [Time?] The time that Twilio will send the message. Must be in ISO 8601 format. @optional @param shorten_urls [Bool?] 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. @optional @param smart_encoded [Bool?] Whether to detect Unicode characters that have a similar GSM-7 character and replace them. Can be: true or false. @optional @param status_callback [String?] 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 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. URLs must contain a valid hostname and underscores are not allowed. @optional @param validity_period [Int32?] 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. @return [Twilio::Message]


[View source]
def create_message(*, account_sid : String | Nil = @account_sid, to : String | Nil = nil, address_retention : Twilio::MessageEnumAddressRetention | Nil = nil, application_sid : String | Nil = nil, attempt : Int32 | Nil = nil, body : String | Nil = nil, content_retention : Twilio::MessageEnumAddressRetention | Nil = nil, content_sid : String | Nil = nil, content_variables : String | Nil = nil, force_delivery : Bool | Nil = nil, from : String | Nil = nil, max_price : Float64 | Nil = nil, media_url : Array(String) | Nil = nil, messaging_service_sid : String | Nil = nil, persistent_action : Array(String) | Nil = nil, provide_feedback : Bool | Nil = nil, schedule_type : Twilio::MessageEnumScheduleType | Nil = nil, send_as_mms : Bool | Nil = nil, send_at : Time | Nil = nil, shorten_urls : Bool | Nil = nil, smart_encoded : Bool | Nil = nil, status_callback : String | Nil = nil, validity_period : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil #

Send a message from the account used to make the request @required @param account_sid [String?] The SID of the Account that will create the resource. @required @param to [String?] The destination phone number in E.164 format for SMS/MMS or Channel user address for other 3rd-party channels. @optional @param address_retention [Twilio::MessageEnumAddressRetention?] @optional @param application_sid [String?] 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'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. @optional @param attempt [Int32?] Total number of attempts made ( including this ) to send out the message regardless of the provider used @optional @param body [String?] The text of the message you want to send. Can be up to 1,600 characters in length. @optional @param content_retention [Twilio::MessageEnumAddressRetention?] @optional @param content_sid [String?] The SID of the Content object returned at Content API content create time (https://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. @optional @param content_variables [String?] 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. @optional @param force_delivery [Bool?] Reserved @optional @param from [String?] A Twilio phone number in E.164 format, an alphanumeric sender ID, or a Channel Endpoint address that is enabled for the type of message you want to send. Phone numbers or 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. @optional @param max_price [Float64?] 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. @optional @param media_url [Array(String)?] 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 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. @optional @param messaging_service_sid [String?] The SID of the Messaging Service you want to associate with the Message. Set this parameter to use the Messaging Service Settings and Copilot Features 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. @optional @param persistent_action [Array(String)?] Rich actions for Channels Messages. @optional @param provide_feedback [Bool?] 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. This parameter is false by default. @optional @param schedule_type [Twilio::MessageEnumScheduleType?] @optional @param send_as_mms [Bool?] If set to True, Twilio will deliver the message as a single MMS message, regardless of the presence of media. @optional @param send_at [Time?] The time that Twilio will send the message. Must be in ISO 8601 format. @optional @param shorten_urls [Bool?] 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. @optional @param smart_encoded [Bool?] Whether to detect Unicode characters that have a similar GSM-7 character and replace them. Can be: true or false. @optional @param status_callback [String?] 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 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. URLs must contain a valid hostname and underscores are not allowed. @optional @param validity_period [Int32?] 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. @return nil


[View source]
def create_message_feedback(*, account_sid : String | Nil = @account_sid, message_sid : String | Nil = nil, outcome : Twilio::MessageFeedbackEnumOutcome | Nil = nil) : Twilio::MessageMessageFeedback #

@required @param account_sid [String?] The SID of the Account that will create the resource. @required @param message_sid [String?] The SID of the Message resource for which the feedback was provided. @optional @param outcome [Twilio::MessageFeedbackEnumOutcome?] @return [Twilio::MessageMessageFeedback]


[View source]
def create_message_feedback(*, account_sid : String | Nil = @account_sid, message_sid : String | Nil = nil, outcome : Twilio::MessageFeedbackEnumOutcome | Nil = nil, &block : Crest::Response -> ) : Nil #

@required @param account_sid [String?] The SID of the Account that will create the resource. @required @param message_sid [String?] The SID of the Message resource for which the feedback was provided. @optional @param outcome [Twilio::MessageFeedbackEnumOutcome?] @return nil


[View source]
def create_message_feedback_with_http_info(*, account_sid : String | Nil = @account_sid, message_sid : String | Nil = nil, outcome : Twilio::MessageFeedbackEnumOutcome | Nil = nil) : Tuple(Twilio::MessageMessageFeedback, Int32, Hash(String, Array(String) | String)) #

@required @param account_sid [String?] The SID of the Account that will create the resource. @required @param message_sid [String?] The SID of the Message resource for which the feedback was provided. @optional @param outcome [Twilio::MessageFeedbackEnumOutcome?] @return [Tuple(Twilio::MessageMessageFeedback, Integer, Hash)] Twilio::MessageMessageFeedback, response status code and response headers


[View source]
def create_message_with_http_info(*, account_sid : String | Nil = @account_sid, to : String | Nil = nil, address_retention : Twilio::MessageEnumAddressRetention | Nil = nil, application_sid : String | Nil = nil, attempt : Int32 | Nil = nil, body : String | Nil = nil, content_retention : Twilio::MessageEnumAddressRetention | Nil = nil, content_sid : String | Nil = nil, content_variables : String | Nil = nil, force_delivery : Bool | Nil = nil, from : String | Nil = nil, max_price : Float64 | Nil = nil, media_url : Array(String) | Nil = nil, messaging_service_sid : String | Nil = nil, persistent_action : Array(String) | Nil = nil, provide_feedback : Bool | Nil = nil, schedule_type : Twilio::MessageEnumScheduleType | Nil = nil, send_as_mms : Bool | Nil = nil, send_at : Time | Nil = nil, shorten_urls : Bool | Nil = nil, smart_encoded : Bool | Nil = nil, status_callback : String | Nil = nil, validity_period : Int32 | Nil = nil) : Tuple(Twilio::Message, Int32, Hash(String, Array(String) | String)) #

Send a message from the account used to make the request @required @param account_sid [String?] The SID of the Account that will create the resource. @required @param to [String?] The destination phone number in E.164 format for SMS/MMS or Channel user address for other 3rd-party channels. @optional @param address_retention [Twilio::MessageEnumAddressRetention?] @optional @param application_sid [String?] 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'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. @optional @param attempt [Int32?] Total number of attempts made ( including this ) to send out the message regardless of the provider used @optional @param body [String?] The text of the message you want to send. Can be up to 1,600 characters in length. @optional @param content_retention [Twilio::MessageEnumAddressRetention?] @optional @param content_sid [String?] The SID of the Content object returned at Content API content create time (https://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. @optional @param content_variables [String?] 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. @optional @param force_delivery [Bool?] Reserved @optional @param from [String?] A Twilio phone number in E.164 format, an alphanumeric sender ID, or a Channel Endpoint address that is enabled for the type of message you want to send. Phone numbers or 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. @optional @param max_price [Float64?] 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. @optional @param media_url [Array(String)?] 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 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. @optional @param messaging_service_sid [String?] The SID of the Messaging Service you want to associate with the Message. Set this parameter to use the Messaging Service Settings and Copilot Features 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. @optional @param persistent_action [Array(String)?] Rich actions for Channels Messages. @optional @param provide_feedback [Bool?] 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. This parameter is false by default. @optional @param schedule_type [Twilio::MessageEnumScheduleType?] @optional @param send_as_mms [Bool?] If set to True, Twilio will deliver the message as a single MMS message, regardless of the presence of media. @optional @param send_at [Time?] The time that Twilio will send the message. Must be in ISO 8601 format. @optional @param shorten_urls [Bool?] 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. @optional @param smart_encoded [Bool?] Whether to detect Unicode characters that have a similar GSM-7 character and replace them. Can be: true or false. @optional @param status_callback [String?] 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 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. URLs must contain a valid hostname and underscores are not allowed. @optional @param validity_period [Int32?] 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. @return [Tuple(Twilio::Message, Integer, Hash)] Twilio::Message, response status code and response headers


[View source]
def debugging?(*args, **options) #

[View source]
def debugging?(*args, **options, &) #

[View source]
def delete_media(*, account_sid : String | Nil = @account_sid, message_sid : String | Nil = nil, sid : String | Nil = nil) : Nil #

Delete media from your account. Once delete, you will no longer be billed @required @param account_sid [String?] The SID of the Account that created the Media resource(s) to delete. @required @param message_sid [String?] The SID of the Message resource that this Media resource belongs to. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Media resource to delete @return [Nil]


[View source]
def delete_media(*, account_sid : String | Nil = @account_sid, message_sid : String | Nil = nil, sid : String | Nil = nil, &block : Crest::Response -> ) : Nil #

Delete media from your account. Once delete, you will no longer be billed @required @param account_sid [String?] The SID of the Account that created the Media resource(s) to delete. @required @param message_sid [String?] The SID of the Message resource that this Media resource belongs to. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Media resource to delete @return nil


[View source]
def delete_media_with_http_info(*, account_sid : String | Nil = @account_sid, message_sid : String | Nil = nil, sid : String | Nil = nil) : Tuple(Nil, Int32, Hash(String, Array(String) | String)) #

Delete media from your account. Once delete, you will no longer be billed @required @param account_sid [String?] The SID of the Account that created the Media resource(s) to delete. @required @param message_sid [String?] The SID of the Message resource that this Media resource belongs to. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Media resource to delete @return [Tuple(Nil, Integer, Hash)] Nil, response status code and response headers


[View source]
def delete_message(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Nil #

Deletes a message record from your account @required @param account_sid [String?] The SID of the Account that created the Message resources to delete. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Message resource to delete. @return [Nil]


[View source]
def delete_message(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, &block : Crest::Response -> ) : Nil #

Deletes a message record from your account @required @param account_sid [String?] The SID of the Account that created the Message resources to delete. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Message resource to delete. @return nil


[View source]
def delete_message_with_http_info(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Tuple(Nil, Int32, Hash(String, Array(String) | String)) #

Deletes a message record from your account @required @param account_sid [String?] The SID of the Account that created the Message resources to delete. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Message resource to delete. @return [Tuple(Nil, Integer, Hash)] Nil, response status code and response headers


[View source]
def fetch_media(*, account_sid : String | Nil = @account_sid, message_sid : String | Nil = nil, sid : String | Nil = nil) : Twilio::MessageMedia #

Fetch a single media instance belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Media resource(s) to fetch. @required @param message_sid [String?] The SID of the Message resource that this Media resource belongs to. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Media resource to fetch @return [Twilio::MessageMedia]


[View source]
def fetch_media(*, account_sid : String | Nil = @account_sid, message_sid : String | Nil = nil, sid : String | Nil = nil, &block : Crest::Response -> ) : Nil #

Fetch a single media instance belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Media resource(s) to fetch. @required @param message_sid [String?] The SID of the Message resource that this Media resource belongs to. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Media resource to fetch @return nil


[View source]
def fetch_media_with_http_info(*, account_sid : String | Nil = @account_sid, message_sid : String | Nil = nil, sid : String | Nil = nil) : Tuple(Twilio::MessageMedia, Int32, Hash(String, Array(String) | String)) #

Fetch a single media instance belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Media resource(s) to fetch. @required @param message_sid [String?] The SID of the Message resource that this Media resource belongs to. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Media resource to fetch @return [Tuple(Twilio::MessageMedia, Integer, Hash)] Twilio::MessageMedia, response status code and response headers


[View source]
def fetch_message(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Twilio::Message #

Fetch a message belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Message resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Message resource to fetch. @return [Twilio::Message]


[View source]
def fetch_message(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, &block : Crest::Response -> ) : Nil #

Fetch a message belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Message resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Message resource to fetch. @return nil


[View source]
def fetch_message_with_http_info(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Tuple(Twilio::Message, Int32, Hash(String, Array(String) | String)) #

Fetch a message belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Message resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Message resource to fetch. @return [Tuple(Twilio::Message, Integer, Hash)] Twilio::Message, response status code and response headers


[View source]
def list_media(*, account_sid : String | Nil = @account_sid, message_sid : String | Nil = nil, date_created : Time | Nil = nil, date_created_before : Time | Nil = nil, date_created_after : Time | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListMediaResponse #

Retrieve a list of Media resources belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Media resource(s) to read. @required @param message_sid [String?] The SID of the Message resource that this Media resource belongs to. @optional @param date_created [Time?] Only include media that was created on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read media that was created on this date. You can also specify an inequality, such as StartTime<=YYYY-MM-DD, to read media that was created on or before midnight of this date, and StartTime>=YYYY-MM-DD to read media that was created on or after midnight of this date. @optional @param date_created_before [Time?] Only include media that was created on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read media that was created on this date. You can also specify an inequality, such as StartTime<=YYYY-MM-DD, to read media that was created on or before midnight of this date, and StartTime>=YYYY-MM-DD to read media that was created on or after midnight of this date. @optional @param date_created_after [Time?] Only include media that was created on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read media that was created on this date. You can also specify an inequality, such as StartTime<=YYYY-MM-DD, to read media that was created on or before midnight of this date, and StartTime>=YYYY-MM-DD to read media that was created on or after midnight of this date. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Twilio::ListMediaResponse]


[View source]
def list_media(*, account_sid : String | Nil = @account_sid, message_sid : String | Nil = nil, date_created : Time | Nil = nil, date_created_before : Time | Nil = nil, date_created_after : Time | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil #

Retrieve a list of Media resources belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Media resource(s) to read. @required @param message_sid [String?] The SID of the Message resource that this Media resource belongs to. @optional @param date_created [Time?] Only include media that was created on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read media that was created on this date. You can also specify an inequality, such as StartTime<=YYYY-MM-DD, to read media that was created on or before midnight of this date, and StartTime>=YYYY-MM-DD to read media that was created on or after midnight of this date. @optional @param date_created_before [Time?] Only include media that was created on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read media that was created on this date. You can also specify an inequality, such as StartTime<=YYYY-MM-DD, to read media that was created on or before midnight of this date, and StartTime>=YYYY-MM-DD to read media that was created on or after midnight of this date. @optional @param date_created_after [Time?] Only include media that was created on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read media that was created on this date. You can also specify an inequality, such as StartTime<=YYYY-MM-DD, to read media that was created on or before midnight of this date, and StartTime>=YYYY-MM-DD to read media that was created on or after midnight of this date. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return nil


[View source]
def list_media_with_http_info(*, account_sid : String | Nil = @account_sid, message_sid : String | Nil = nil, date_created : Time | Nil = nil, date_created_before : Time | Nil = nil, date_created_after : Time | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListMediaResponse, Int32, Hash(String, Array(String) | String)) #

Retrieve a list of Media resources belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Media resource(s) to read. @required @param message_sid [String?] The SID of the Message resource that this Media resource belongs to. @optional @param date_created [Time?] Only include media that was created on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read media that was created on this date. You can also specify an inequality, such as StartTime<=YYYY-MM-DD, to read media that was created on or before midnight of this date, and StartTime>=YYYY-MM-DD to read media that was created on or after midnight of this date. @optional @param date_created_before [Time?] Only include media that was created on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read media that was created on this date. You can also specify an inequality, such as StartTime<=YYYY-MM-DD, to read media that was created on or before midnight of this date, and StartTime>=YYYY-MM-DD to read media that was created on or after midnight of this date. @optional @param date_created_after [Time?] Only include media that was created on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read media that was created on this date. You can also specify an inequality, such as StartTime<=YYYY-MM-DD, to read media that was created on or before midnight of this date, and StartTime>=YYYY-MM-DD to read media that was created on or after midnight of this date. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Tuple(Twilio::ListMediaResponse, Integer, Hash)] Twilio::ListMediaResponse, response status code and response headers


[View source]
def list_message(*, account_sid : String | Nil = @account_sid, to : String | Nil = nil, from : String | Nil = nil, date_sent : Time | Nil = nil, date_sent_before : Time | Nil = nil, date_sent_after : Time | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListMessageResponse #

Retrieve a list of messages belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Message resources to read. @optional @param to [String?] Read messages sent to only this phone number. @optional @param from [String?] Read messages sent from only this phone number or alphanumeric sender ID. @optional @param date_sent [Time?] 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. @optional @param date_sent_before [Time?] 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. @optional @param date_sent_after [Time?] 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. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Twilio::ListMessageResponse]


[View source]
def list_message(*, account_sid : String | Nil = @account_sid, to : String | Nil = nil, from : String | Nil = nil, date_sent : Time | Nil = nil, date_sent_before : Time | Nil = nil, date_sent_after : Time | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil #

Retrieve a list of messages belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Message resources to read. @optional @param to [String?] Read messages sent to only this phone number. @optional @param from [String?] Read messages sent from only this phone number or alphanumeric sender ID. @optional @param date_sent [Time?] 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. @optional @param date_sent_before [Time?] 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. @optional @param date_sent_after [Time?] 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. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return nil


[View source]
def list_message_with_http_info(*, account_sid : String | Nil = @account_sid, to : String | Nil = nil, from : String | Nil = nil, date_sent : Time | Nil = nil, date_sent_before : Time | Nil = nil, date_sent_after : Time | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListMessageResponse, Int32, Hash(String, Array(String) | String)) #

Retrieve a list of messages belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Message resources to read. @optional @param to [String?] Read messages sent to only this phone number. @optional @param from [String?] Read messages sent from only this phone number or alphanumeric sender ID. @optional @param date_sent [Time?] 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. @optional @param date_sent_before [Time?] 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. @optional @param date_sent_after [Time?] 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. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Tuple(Twilio::ListMessageResponse, Integer, Hash)] Twilio::ListMessageResponse, response status code and response headers


[View source]
def update_message(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, body : String | Nil = nil, status : Twilio::MessageEnumUpdateStatus | Nil = nil) : Twilio::Message #

To redact a message-body from a post-flight message record, post to the message instance resource with an empty body @required @param account_sid [String?] The SID of the Account that created the Message resources to update. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Message resource to update. @optional @param body [String?] The text of the message you want to send. Can be up to 1,600 characters long. @optional @param status [Twilio::MessageEnumUpdateStatus?] @return [Twilio::Message]


[View source]
def update_message(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, body : String | Nil = nil, status : Twilio::MessageEnumUpdateStatus | Nil = nil, &block : Crest::Response -> ) : Nil #

To redact a message-body from a post-flight message record, post to the message instance resource with an empty body @required @param account_sid [String?] The SID of the Account that created the Message resources to update. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Message resource to update. @optional @param body [String?] The text of the message you want to send. Can be up to 1,600 characters long. @optional @param status [Twilio::MessageEnumUpdateStatus?] @return nil


[View source]
def update_message_with_http_info(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, body : String | Nil = nil, status : Twilio::MessageEnumUpdateStatus | Nil = nil) : Tuple(Twilio::Message, Int32, Hash(String, Array(String) | String)) #

To redact a message-body from a post-flight message record, post to the message instance resource with an empty body @required @param account_sid [String?] The SID of the Account that created the Message resources to update. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Message resource to update. @optional @param body [String?] The text of the message you want to send. Can be up to 1,600 characters long. @optional @param status [Twilio::MessageEnumUpdateStatus?] @return [Tuple(Twilio::Message, Integer, Hash)] Twilio::Message, response status code and response headers


[View source]