List all Messages
List all messages.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Messaging.
Learn more about API scopes.
Path parameters
Universal Unique Identifier.
The unique identifier of the project that sent or received this message.
Query parameters
Only return messages sent on this particular date, formatted as YYYY-MM-DD in UTC.
Only return messages sent before this date, formatted as YYYY-MM-DD in UTC.
Only return messages sent after this date, formatted as YYYY-MM-DD in UTC.
The phone number in E.164 format. For inbound messages, this will be the remote phone number who sent the message. For outbound messages, this will be one of your SignalWire phone numbers.
The phone number in E.164 format that received the message. For inbound messages, this is one of your SignalWire phone numbers; for outbound messages, this is the remote phone number that received the message.
Message status.
Current status of the message.
The page number to retrieve. Default is 0.
The number of items per page. Default is 50, maximum is 1000.
The token for cursor-based pagination. Must start with 'PA' or 'PB'.
Response
The request has succeeded.
Example response
{
"uri": "/api/laml/2010-04-01/Accounts/ea108133-d6b3-407c-9536-9fad8a929a6a/Messages?Page=0&PageSize=50",
"first_page_uri": "/api/laml/2010-04-01/Accounts/ea108133-d6b3-407c-9536-9fad8a929a6a/Messages?Page=0&PageSize=50",
"next_page_uri": "/api/laml/2010-04-01/Accounts/ea108133-d6b3-407c-9536-9fad8a929a6a/Messages?Page=1&PageSize=50&PageToken=PA0a059168ead041af",
"page_size": 50,
"messages": [
{
"api_version": "2010-04-01",
"body": "Hello World!",
"num_segments": 1,
"num_media": 1,
"date_created": "Mon, 13 Aug 2018 21:38:46 +0000",
"date_sent": "Mon, 13 Aug 2018 21:38:46 +0000",
"date_updated": "Mon, 13 Aug 2018 21:38:46 +0000",
"error_code": "30001",
"error_message": "Queue overflow",
"from": "+15551234567",
"price": 0.005,
"price_unit": "USD",
"to": "+15557654321",
"uri": "/api/laml/2010-04-01/Accounts/ea108133-d6b3-407c-9536-9fad8a929a6a/Messages/0a059168-ead0-41af-9d1f-343dae832527.json",
"subresource_uris": {
"media": "/api/laml/2010-04-01/Accounts/ea108133-d6b3-407c-9536-9fad8a929a6a/Messages/0a059168-ead0-41af-9d1f-343dae832527/Media.json"
}
}
]
}