Skip to navigation
Compatibility REST APIMessage Media

List Message Media

View as MarkdownOpen in Claude

Lists the MMS attachments associated with one message. Each attachment is a separate media resource that can be retrieved or deleted by SID. Fax Media contains fax documents and is a separate collection.

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.

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)

Path parameters

AccountSidstringRequiredformat: "uuid"
The unique identifier of the project that sent or received this message.
MessageSidstringRequiredformat: "uuid"
A unique ID that identifies this specific message.

Query parameters

DateCreatedstringOptional

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

DateCreated<stringOptional

Only return media created before this date, formatted as YYYY-MM-DD in UTC.

DateCreated>stringOptional

Only return media created after this date, formatted as YYYY-MM-DD in UTC.

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.
media_listlist of objects
List of media.

Errors

400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error