List all Messages | SignalWire

{
  "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",
  "previous_page_uri": null,
  "page": 0,
  "page_size": 50,
  "messages": [
    {
      "account_sid": "ea108133-d6b3-407c-9536-9fad8a929a6a",
      "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",
      "direction": "inbound",
      "error_code": "30001",
      "error_message": "Queue overflow",
      "from": "+15551234567",
      "price": 0.005,
      "price_unit": "USD",
      "sid": "0a059168-ead0-41af-9d1f-343dae832527",
      "status": "queued",
      "to": "+15557654321",
      "messaging_service_sid": "b3877c40-da60-4998-90ad-b792e98472ms",
      "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"
      }
    }
  ]
}

Lists the account’s messages. Each message has a SID used for delivery inspection, redaction, deletion, or media access. The SignalWire REST Messages API sends and redacts JSON requests, while Message logs provide a read-only history.

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.

Lists the account's messages. Each message has a SID used for delivery inspection, redaction, deletion, or media access. The SignalWire REST [Messages API](/docs/apis/rest/messages/create-message) sends and redacts JSON requests, while [Message logs](/docs/apis/rest/message-logs/list-message-logs) provide a read-only history. #### 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](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

AccountSidstringRequiredformat: "uuid"

The unique identifier of the project that sent or received this message.

Query parameters

DateSentstringOptional

Only return messages sent on this particular date, formatted as YYYY-MM-DD in UTC.

DateSent<stringOptional

Only return messages sent before this date, formatted as YYYY-MM-DD in UTC.

DateSent>stringOptional

Only return messages sent after this date, formatted as YYYY-MM-DD in UTC.

FromstringOptional

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.

TostringOptional

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.

StatusenumOptional

Current status of the message.

PageintegerOptional>=0Defaults to 0

The page number to retrieve. Default is 0.

PageSizeintegerOptional1-1000Defaults to 50

The number of items per page. Default is 50, maximum is 1000.

PageTokenstringOptional

The token for cursor-based pagination. Must start with ‘PA’ or ‘PB’.

Response

The request has succeeded.

uristring

The URI of the current page.

first_page_uristring

The URI of the first page.

next_page_uristring or null

The URI of the next page, or null if there are no more pages.

previous_page_uristring or null

The URI of the previous page, or null if this is the first page.

pageinteger

The current page number.

page_sizeinteger

The number of items per page.

messageslist of objects

List of messages.

Errors

400

Bad Request Error

401

Unauthorized Error

422

Unprocessable Entity Error