GET api/v1/systems/{systemPhoneNumber}/mailboxes/{mailboxNumber}/folders/{folderName}/messages?PageSize={PageSize}&PageNumber={PageNumber}&SortAsc={SortAsc}

Provides a messages list for a given folder

Request Information

URI Parameters

Name	Description	Type	Additional information
systemPhoneNumber	A system phone number on the app containing the messages	string	Required
mailboxNumber	A mailbox number on the app containing the messages	integer	Required
folderName	A folder name in the mailbox on the app containing the messages	string	Required
PageSize	The requested page size	integer	None.
PageNumber	The page number	integer	None.
SortAsc	Set to true to reverse the sort, descending is default	boolean	None.

Body Parameters

None.

Response Information

Resource Description

Returns information for each message, such as ID, Label, Unread status, etc. (but not media data). 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 Message

Name	Description	Type	Additional information
Id	Id number of the message	string	None.
Type	Type of the message, fax, voicemail, or recording	MessageType	None.
Name	The name of the message	string	None.
Length	Length of the message in pages for fax or seconds for audio	integer	None.
SourceName	Name of the person that send the message	string	None.
SourceNumber	Number of the person that send the message	string	None.
ReceivedOn	Date the message was received	date	None.
Unread	If the message is unread or not	boolean	None.
Mailbox	The mailbox that the message is in	integer	None.
Folder	The folder that the message is in	string	None.
Transcription	The transcription of the message	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "I565456465",
    "Type": "Fax",
    "Name": "Message20",
    "Length": 11,
    "SourceName": "John Doe",
    "SourceNumber": "8512345678",
    "ReceivedOn": "2014-07-17T08:22:01",
    "Unread": false,
    "Mailbox": 82,
    "Folder": "New",
    "Transcription": null
  },
  {
    "Id": "A1234569873",
    "Type": "Voicemail",
    "Name": "Message201",
    "Length": 11,
    "SourceName": "John Doe",
    "SourceNumber": "8587654321",
    "ReceivedOn": "2014-08-17T08:22:01",
    "Unread": true,
    "Mailbox": 85,
    "Folder": "Saved",
    "Transcription": null
  }
]

application/xml, text/xml

Sample:

<ArrayOfMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FreedomVoice.WebLink.Models">
  <Message>
    <ApplicationNumber i:nil="true" />
    <CurrentAttempt>1</CurrentAttempt>
    <Folder>New</Folder>
    <Id>I565456465</Id>
    <Length>11</Length>
    <Mailbox>82</Mailbox>
    <MaxAttempts>1</MaxAttempts>
    <Name>Message20</Name>
    <ReceivedOn>2014-07-17T08:22:01</ReceivedOn>
    <SourceName>John Doe</SourceName>
    <SourceNumber>8512345678</SourceNumber>
    <Status>Inactive</Status>
    <Transcription i:nil="true" />
    <Type>Fax</Type>
    <Unread>false</Unread>
  </Message>
  <Message>
    <ApplicationNumber i:nil="true" />
    <CurrentAttempt>1</CurrentAttempt>
    <Folder>Saved</Folder>
    <Id>A1234569873</Id>
    <Length>11</Length>
    <Mailbox>85</Mailbox>
    <MaxAttempts>1</MaxAttempts>
    <Name>Message201</Name>
    <ReceivedOn>2014-08-17T08:22:01</ReceivedOn>
    <SourceName>John Doe</SourceName>
    <SourceNumber>8587654321</SourceNumber>
    <Status>Inactive</Status>
    <Transcription i:nil="true" />
    <Type>Voicemail</Type>
    <Unread>true</Unread>
  </Message>
</ArrayOfMessage>