All URIs are relative to https://api.twilio.com
| Method | HTTP request | Description |
|---|---|---|
| create_message | POST /2010-04-01/Accounts/{AccountSid}/Messages.json | |
| delete_message | DELETE /2010-04-01/Accounts/{AccountSid}/Messages/{Sid}.json | |
| fetch_message | GET /2010-04-01/Accounts/{AccountSid}/Messages/{Sid}.json | |
| list_message | GET /2010-04-01/Accounts/{AccountSid}/Messages.json | |
| update_message | POST /2010-04-01/Accounts/{AccountSid}/Messages/{Sid}.json |
crate::models::ApiPeriodV2010PeriodAccountPeriodMessage create_message(account_sid, to, status_callback, application_sid, max_price, provide_feedback, attempt, validity_period, force_delivery, content_retention, address_retention, smart_encoded, persistent_action, shorten_urls, schedule_type, send_at, send_as_mms, content_variables, risk_check, from, messaging_service_sid, body, media_url, content_sid)
Send a message
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| account_sid | String | The SID of the Account creating the Message resource. | [required] | |
| to | String | The recipient's phone number in E.164 format (for SMS/MMS) or channel address, e.g. whatsapp:+15552229999. |
[required] | |
| status_callback | Option<String> | The URL of the endpoint to which Twilio sends Message status callback requests. URL must contain a valid hostname and underscores are not allowed. If you include this parameter with the messaging_service_sid, Twilio uses this URL instead of the Status Callback URL of the Messaging Service. |
||
| application_sid | Option<String> | The SID of the associated TwiML Application. If this parameter is provided, the status_callback parameter of this request is ignored; Message status callback requests are sent to the TwiML App's message_status_callback URL. |
||
| max_price | Option<f32> | The maximum price in US dollars that you are willing to pay for this Message's delivery. The value can have up to four decimal places. When the max_price parameter is provided, the cost of a message is checked before it is sent. If the cost exceeds max_price, the message is not sent and the Message status is failed. |
||
| provide_feedback | Option<bool> | Boolean indicating whether or not you intend to provide delivery confirmation feedback to Twilio (used in conjunction with the Message Feedback subresource). Default value is false. |
||
| attempt | Option<i32> | Total number of attempts made (including this request) to send the message regardless of the provider used | ||
| validity_period | Option<i32> | The maximum length in seconds that the Message can remain in Twilio's outgoing message queue. If a queued Message exceeds the validity_period, the Message is not sent. Accepted values are integers from 1 to 14400. Default value is 14400. A validity_period greater than 5 is recommended. Learn more about the validity period |
||
| force_delivery | Option<bool> | Reserved | ||
| content_retention | Option<crate::models::MessageEnumContentRetention> | |||
| address_retention | Option<crate::models::MessageEnumAddressRetention> | |||
| smart_encoded | Option<bool> | Whether to detect Unicode characters that have a similar GSM-7 character and replace them. Can be: true or false. |
||
| persistent_action | Option<Vec> | Rich actions for non-SMS/MMS channels. Used for sending location in WhatsApp messages. | ||
| shorten_urls | Option<bool> | For Messaging Services with Link Shortening configured only: A Boolean indicating whether or not Twilio should shorten links in the body of the Message. Default value is false. If true, the messaging_service_sid parameter must also be provided. |
||
| schedule_type | Option<crate::models::MessageEnumScheduleType> | |||
| send_at | Option<String> | The time that Twilio will send the message. Must be in ISO 8601 format. | ||
| send_as_mms | Option<bool> | If set to true, Twilio delivers the message as a single MMS message, regardless of the presence of media. |
||
| content_variables | Option<String> | For Content Editor/API only: Key-value pairs of Template variables and their substitution values. content_sid parameter must also be provided. If values are not defined in the content_variables parameter, the Template's default placeholder values are used. |
||
| risk_check | Option<crate::models::MessageEnumRiskCheck> | |||
| from | Option<String> | The sender's Twilio phone number (in E.164 format), alphanumeric sender ID, Wireless SIM, short code, or channel address (e.g., whatsapp:+15554449999). The value of the from parameter must be a sender that is hosted within Twilio and belongs to the Account creating the Message. If you are using messaging_service_sid, this parameter can be empty (Twilio assigns a from value from the Messaging Service's Sender Pool) or you can provide a specific sender from your Sender Pool. |
||
| messaging_service_sid | Option<String> | The SID of the Messaging Service you want to associate with the Message. When this parameter is provided and the from parameter is omitted, Twilio selects the optimal sender from the Messaging Service's Sender Pool. You may also provide a from parameter if you want to use a specific Sender from the Sender Pool. |
||
| body | Option<String> | The text content of the outgoing message. Can be up to 1,600 characters in length. SMS only: If the body contains more than 160 GSM-7 characters (or 70 UCS-2 characters), the message is segmented and charged accordingly. For long body text, consider using the send_as_mms parameter. |
||
| media_url | Option<Vec> | The URL of media to include in the Message content. jpeg, jpg, gif, and png file types are fully supported by Twilio and content is formatted for delivery on destination devices. The media size limit is 5 MB for supported file types (jpeg, jpg, png, gif) and 500 KB for other types of accepted media. To send more than one image in the message, provide multiple media_url parameters in the POST request. You can include up to ten media_url parameters per message. International and carrier limits apply. |
||
| content_sid | Option<String> | For Content Editor/API only: The SID of the Content Template to be used with the Message, e.g., HXXXXXXXXXXXXXXXXXXXXXXXXXXXXX. If this parameter is not provided, a Content Template is not used. Find the SID in the Console on the Content Editor page. For Content API users, the SID is found in Twilio's response when creating the Template or by fetching your Templates. |
crate::models::ApiPeriodV2010PeriodAccountPeriodMessage
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_message(account_sid, sid)
Deletes a Message resource from your account
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| account_sid | String | The SID of the Account associated with the Message resource | [required] | |
| sid | String | The SID of the Message resource you wish to delete | [required] |
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::ApiPeriodV2010PeriodAccountPeriodMessage fetch_message(account_sid, sid)
Fetch a specific Message
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| account_sid | String | The SID of the Account associated with the Message resource | [required] | |
| sid | String | The SID of the Message resource to be fetched | [required] |
crate::models::ApiPeriodV2010PeriodAccountPeriodMessage
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::ListMessageResponse list_message(account_sid, to, from, date_sent, date_sent_less_than, date_sent_greater_than, page_size, page, page_token)
Retrieve a list of Message resources associated with a Twilio Account
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| account_sid | String | The SID of the Account associated with the Message resources. | [required] | |
| to | Option<String> | Filter by recipient. For example: Set this to parameter to +15558881111 to retrieve a list of Message resources with to properties of +15558881111 |
||
| from | Option<String> | Filter by sender. For example: Set this from parameter to +15552229999 to retrieve a list of Message resources with from properties of +15552229999 |
||
| date_sent | Option<String> | Filter by Message sent_date. Accepts GMT dates in the following formats: YYYY-MM-DD (to find Messages with a specific sent_date), <=YYYY-MM-DD (to find Messages with sent_dates on and before a specific date), and >=YYYY-MM-DD (to find Messages with sent_dates on and after a specific date). |
||
| date_sent_less_than | Option<String> | Filter by Message sent_date. Accepts GMT dates in the following formats: YYYY-MM-DD (to find Messages with a specific sent_date), <=YYYY-MM-DD (to find Messages with sent_dates on and before a specific date), and >=YYYY-MM-DD (to find Messages with sent_dates on and after a specific date). |
||
| date_sent_greater_than | Option<String> | Filter by Message sent_date. Accepts GMT dates in the following formats: YYYY-MM-DD (to find Messages with a specific sent_date), <=YYYY-MM-DD (to find Messages with sent_dates on and before a specific date), and >=YYYY-MM-DD (to find Messages with sent_dates on and after a specific date). |
||
| page_size | Option<i32> | How many resources to return in each list page. The default is 50, and the maximum is 1000. | ||
| page | Option<i32> | The page index. This value is simply for client state. | ||
| page_token | Option<String> | The page token. This is provided by the API. |
crate::models::ListMessageResponse
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::ApiPeriodV2010PeriodAccountPeriodMessage update_message(account_sid, sid, body, status)
Update a Message resource (used to redact Message body text and to cancel not-yet-sent messages)
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| account_sid | String | The SID of the Account that created the Message resources to update. | [required] | |
| sid | String | The SID of the Message resource to be updated | [required] | |
| body | Option<String> | The new body of the Message resource. To redact the text content of a Message, this parameter's value must be an empty string |
||
| status | Option<crate::models::MessageEnumUpdateStatus> |
crate::models::ApiPeriodV2010PeriodAccountPeriodMessage
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]