GET api/v1/systems/{systemPhoneNumber}/mailboxes/{mailboxNumber}/folders/{folderName}/messages/{messageId}/media/{mediaType}
Provides the media for the given message ID in the requested media type format
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| systemPhoneNumber |
A system phone number on the app containing the message |
string |
Required |
| mailboxNumber |
A mailbox number on the app containing the message |
integer |
Required |
| folderName |
A folder name in the mailbox on the app containing the message |
string |
Required |
| messageId |
The ID of the message such as A1234 for an audio message, or I1234 for an image (fax) message |
string |
Required |
| mediaType |
The desired media type format such as wav or pdf |
MediaType |
Required |
Body Parameters
None.
Response Information
Resource Description
A media byte array will be returned if all parameters are correct. 400 will be returned if any of the parameters are invalid. 402 status code will be returned if system number is on hold. 403 will be returned if the user does not have access to the account or mailbox specified.
Collection of byteResponse Formats
application/json, text/json, application/xml, text/xml
Sample:
<Binary Data>