GET api/v1/systems/{systemPhoneNumber}/mailboxes

Provides info on mailboxes for the application with the given system phone number that the user has access to

Request Information

URI Parameters

Name	Description	Type	Additional information
systemPhoneNumber	A system phone number on the app containing the mailboxes	string	Required

Body Parameters

None.

Response Information

Resource Description

200 status code and mailbox info such as display name and mailbox number for each mailbox. 402 status code will be returned if system number is on hold. 403 status code will be returned if user doesn't have permission to use that system or presentation number.

Collection of Mailbox

Name	Description	Type	Additional information
MailboxNumber		integer	None.
DisplayName		string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "MailboxNumber": 80,
    "DisplayName": "New"
  },
  {
    "MailboxNumber": 80,
    "DisplayName": "Saved"
  }
]

application/xml, text/xml

Sample:

<ArrayOfMailbox xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FreedomVoice.WebLink.Models">
  <Mailbox>
    <DisplayName>New</DisplayName>
    <MailboxNumber>80</MailboxNumber>
  </Mailbox>
  <Mailbox>
    <DisplayName>Saved</DisplayName>
    <MailboxNumber>80</MailboxNumber>
  </Mailbox>
</ArrayOfMailbox>