This API method allows you to programmatically search for previously sent or received SMS messages.
Your account and property must be enabled for SMS. Please contact client services to have SMS enabled.
|PropertySid||string||The secure identifier of the Property for which to search SMS messages for.|
|Date_From||timestamp||Include SMS messages from this date and time (inclusive). Specified as seconds since the epoch and as UTC.|
|Date_To||timestamp||Include SMS messages until this date and time (exclusive). Specified as seconds since the epoch and as UTC.|
|Status||string||The status of the SMS message.|
Received. See below table for definitions of each possible value.
|Direction||string||The direction of the SMS message. Options: |
|Results_Count||integer||Limit the number of objects to be returned. Default is |
|Results_Skip||integer||Number of results to skip, can be used as a cursor for pagination of results.|Example: Searching SMS messages with just date from and to specified.
Example: Searching SMS messages with all search filters.
200 - OK
On successful retrieval of the SMS messages, a
200 OK is returned with a JSON formatted array of
Messages Resource objects.
Note that all
timestamp fields are specified as seconds since the unix epoch and all represented within UTC.
Message Resource Parameters
|MessageSid||string||The message secure identifier which uniquely identifies the message.|
|AccountSid||string||The account secure identifier associated with the message.|
|PropertySid||string||The property secure identifier associated with the message.|
|From||string||The alphanumeric or E164 formatted sender ID of the message.|
|To||string||The E164 formatted recipient of the SMS message.|
|Text||string||The content of the SMS message.|
|DeliveryReceipt||boolean||Set to |
true if a delivery receipt was requested and
|NumSegments||integer||The number of message segments.|
|Status||string||The message status. See below table for definitions of each possible value.|
|Direction||string||The direction of the message (as a response to this request always |
Transmit. Possible values:
|Scheduled||timestamp||Timestamp of when the message is/was scheduled to be sent.|
|Created||timestamp||Timestamp of when the message resource was created.|
|Submitted||timestamp||Timestamp of when the message was submitted to the SMS Center.|
|Delivered||timestamp||Timestamp of when the message delivery occurred.|
|Received||timestamp||Timestamp of when an inbound message was received.|
|ErrorCode||string||Error code (if message submission or delivery failed).|Example: An example response to the successful search of SMS messages.
Description of possible status values
|Processing||The message has been received by our system and is being processed.|
|Submitted||The message has been submitted successfully to the SMS Center.|
|Delivered||The message has been delivered successfully (if delivery receipts are activated).|
|Failed||The message has failed (submission to the SMS Center was not possible within a reasonable time limit).|
|Received||The message has been received (for inbound messages).|
400 - Error
For error codes and messages, please refer to the REST API Error Codes page.