MessageFeedback Resource
MessageFeedback is a subresource of a Message resource. Message Feedback represents the user-reported outcome of a message.
To better understand and optimize message deliverability, see sending Message Feedback to Twilio.
Looking for step-by-step instructions on tracking the delivery status of your sent messages? Follow our guide to Tracking Delivery Status in your programming language of choice.
MessageFeedback properties
Resource Properties in REST API format | |
---|---|
account_sid
|
The SID of the Account that created the MessageFeedback resource. |
message_sid
|
The SID of the Message resource for which the feedback was provided. |
outcome
|
Whether the feedback has arrived. Can be: |
date_created
|
The date and time in GMT that the resource was created specified in RFC 2822 format. |
date_updated
|
The date and time in GMT that the resource was last updated specified in RFC 2822 format. |
uri
|
The URI of the resource, relative to |
Outcome Values
The following are the possible values for the Outcome
parameter:
Outcome | Description |
---|---|
unconfirmed |
The message has not yet arrived at the Note that this may mean the message has Your application should not POST this value as is set by default when the initial HTTP POST includes |
confirmed | The message has arrived at the To phone number. Even if the message is delayed in delivery, you should still POST this value as soon as you have confirmed that the message was received. |
Create a MessageFeedback resource
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Feedback.json
To track message feedback, you must set ProvideFeedback=true
when you first create the Message. This will create a Message Feedback
instance with an Outcome
of unconfirmed
.
Once you confirm that your message arrived at its destination, you can update the Feedback instance. POST to the Message Feedback resource to update Outcome
to confirmed
.
Parameters
Parameters in REST API format | |
---|---|
account_sid
Path
|
The SID of the Account that will create the resource. |
message_sid
Path
|
The SID of the Message resource for which the feedback was provided. |
outcome
Optional
|
Whether the feedback has arrived. Can be: |
Example Usage
Set the ProvideFeedback
parameter to true
when you send the message.
curl -X POST 'https://api.twilio.com/2010-04-01/Accounts/ACa9b8c7d6e5f43120a9b8c7d6e5f43120/Messages.json' \ --data-urlencode 'To=+18085551234' \ --data-urlencode 'From=+16045559876' \ --data-urlencode 'Body=Your verification code is: 249205' \ --data-urlencode 'ProvideFeedback=true' \ -u ACa9b8c7d6e5f43120a9b8c7d6e5f43120:[AuthToken]
Save the message SID – you can find this in the API response of your sent message:
{"sid": "SM1f2e3d4c5b6a70891f2e3d4c5b6a7089", "date_created": "Thu, 14 Jul 2016 14:18:40 +0000", ...}
If the user receives the text message, POST to the Feedback subresource to set the message Outcome
to 'confirmed'.
curl -X POST 'https://api.twilio.com/2010-04-01/Accounts/ACa9b8c7d6e5f43120a9b8c7d6e5f43120/Messages/SM1f2e3d4c5b6a70891f2e3d4c5b6a7089/Feedback.json' \ --data-urlencode 'Outcome=confirmed' \ -u ACa9b8c7d6e5f43120a9b8c7d6e5f43120:[AuthToken]
Example 1
Helper Library Support
The Message Feedback endpoint is supported in our Next Generation Helper Libraries. This endpoint is not supported by our legacy helper libraries.
If you are using a legacy helper library, you can still use the Message Feedback API by POSTing directly to the REST endpoint.
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.