FreedomVOICE - XML/JSON Services

getMailboxName

https://weblinkapi.freedomvoice.com/mailbox/getMailboxName

Get the name for the mailbox given.

Parameter	Value
rpcSID:
mailbox:
JSON Response:

setMailboxName

https://weblinkapi.freedomvoice.com/mailbox/setMailboxName

Set the name for the mailbox given.

Parameter	Value
rpcSID:
mailbox:
name:
JSON Response:

setMailboxPIN

https://weblinkapi.freedomvoice.com/mailbox/setMailboxPIN

Set the pin for the mailbox given.

Parameter	Value
rpcSID:
mailbox:
pin:
JSON Response:

getMailboxEmailAddresses

https://weblinkapi.freedomvoice.com/mailbox/getMailboxEmailAddresses

Get all email addresses for the mailbox given.

Parameter	Value
rpcSID:
mailbox:
JSON Response:

setMailboxEmailAddresses

https://weblinkapi.freedomvoice.com/mailbox/setMailboxEmailAddresses

Set the email addresses for the mailbox given.

Parameter	Value
rpcSID:
mailbox:
emailAddresses *:
emailAddresses *:
emailAddresses *:
JSON Response:

getMailboxInfoWithUnviewedMessageCounts

https://weblinkapi.freedomvoice.com/mailbox/getMailboxInfoWithUnviewedMessageCounts

Get mailbox info for the passed in mailboxes. Do not pass in the mailboxList parameter.

Parameter	Value
rpcSID:
mailboxList *:
mailboxList *:
mailboxList *:
JSON Response:

getFolderUnviewedMessageCount

https://weblinkapi.freedomvoice.com/mailbox/getFolderUnviewedMessageCount

Get the unread count for the given mailbox/folder combination.

Parameter	Value
rpcSID:
mailbox:
folder:
JSON Response:

getFolderList

https://weblinkapi.freedomvoice.com/mailbox/getFolderList

Get a lsit of all folders with their names and number of hold days.

Parameter	Value
rpcSID:
mailbox:
JSON Response:

renameFolder

https://weblinkapi.freedomvoice.com/mailbox/renameFolder

Rename the given folder. Only custom folders can be renamed.

Parameter	Value
rpcSID:
mailbox:
oldFolderName:
newFolderName:
JSON Response:

addFolder

https://weblinkapi.freedomvoice.com/mailbox/addFolder

Add a custom folder.

Parameter	Value
rpcSID:
mailbox:
folderName:
JSON Response:

deleteFolder

https://weblinkapi.freedomvoice.com/mailbox/deleteFolder

Delete a custom folder.

Parameter	Value
rpcSID:
mailbox:
folderName:
JSON Response:

listMessages

https://weblinkapi.freedomvoice.com/mailbox/listMessages

Get a list of all messages in the passed in mailbox/folder.

Parameter	Value
rpcSID:
mailbox:
folder:
pageNumber:
reverseSort:
itemsPerPage:
JSON Response:

getNonUserCallForwardingList

https://weblinkapi.freedomvoice.com/mailbox/getNonUserCallForwardingList

Get a call forwarding list for a non-user mailbox.

Parameter	Value
rpcSID:
mailbox:
JSON Response:

setNonUserCallForwardingList

https://weblinkapi.freedomvoice.com/mailbox/setNonUserCallForwardingList

This is a POST only method. The callForwardingList parameter must be either valid XML or JSON that matches the format returned by getNonUserCallForwardingList.

Parameter	Value
rpcSID:
mailbox:
format:
callForwardingList:
JSON Response:

getNonUserMailboxProperties

https://weblinkapi.freedomvoice.com/mailbox/getNonUserMailboxProperties

Get the mailbox properties including pinNumber, timeZone and daylightSavings.

Parameter	Value
rpcSID:
mailbox:
JSON Response:

setNonUserMailboxProperties

https://weblinkapi.freedomvoice.com/mailbox/setNonUserMailboxProperties

Set mailbox properties including pinNumber, timeZone and daylightSavings. You can set all properties other than the PIN number by leaving all PIN related fields blank.

Parameter	Value
rpcSID:
mailbox:
oldPinNumber:
pinNumber:
confirmPinNumber:
timeZone:
daylightSavings:
JSON Response:

getUserCallForwardingList

https://weblinkapi.freedomvoice.com/mailbox/getUserCallForwardingList

Get a call forwarding list for a user-based mailbox. To change the pinNumber you must pass in all of pinNumber, oldPinNumber and confirmPinNumber.

Parameter	Value
rpcSID:
mailbox:
JSON Response:

getMessageDeliveryType

https://weblinkapi.freedomvoice.com/mailbox/getMessageDeliveryType

Returns delivery types of either: Attachment, NoAttachment or NoAttachmentWithLink.

Parameter	Value
rpcSID:
mailbox:
JSON Response:

setMessageDeliveryType

https://weblinkapi.freedomvoice.com/mailbox/setMessageDeliveryType

Set the messageDeliveryType for the given mailbox. type must be one of: Attachment, NoAttachment or NoAttachmentWithLink.

Parameter	Value
rpcSID:
mailbox:
type:
JSON Response:

getTrashAfterForwarding

https://weblinkapi.freedomvoice.com/mailbox/getTrashAfterForwarding

Get whether messages will be trashed after forwarding or not.

Parameter	Value
rpcSID:
mailbox:
JSON Response:

setTrashAfterForwarding

https://weblinkapi.freedomvoice.com/mailbox/setTrashAfterForwarding

Set whether messages will be trashed after forwarding or not. You must send true or false.

Parameter	Value
rpcSID:
mailbox:
shouldTrash:
JSON Response:

getCallWhisper

https://weblinkapi.freedomvoice.com/mailbox/getCallWhisper

Get whether call whisper is on for the given mailbox.

Parameter	Value
rpcSID:
mailbox:
JSON Response:

setCallWhisper

https://weblinkapi.freedomvoice.com/mailbox/setCallWhisper

Get whether call whisper is on for the given mailbox. You must sent true or false.

Parameter	Value
rpcSID:
mailbox:
shouldWhisper:
JSON Response:

getFaxForward

https://weblinkapi.freedomvoice.com/mailbox/getFaxForward

Returns either an empty string if fax forward is off or the fax number it is forwarding to.

Parameter	Value
rpcSID:
mailbox:
JSON Response:

setFaxForward

https://weblinkapi.freedomvoice.com/mailbox/setFaxForward

Pass in an empty string to remove fax forward for the given mailbox

Parameter	Value
rpcSID:
mailbox:
faxNumber:
JSON Response:

getCallerIdShouldDisplayDNIS

https://weblinkapi.freedomvoice.com/mailbox/getCallerIdShouldDisplayDNIS

If true, the incoming and outgoing callerId display will show the main DNIS on the account. Otherwise the phones phone number will be displayed

Parameter	Value
rpcSID:
mailbox:
JSON Response:

setCallerIdShouldDisplayDNIS

https://weblinkapi.freedomvoice.com/mailbox/setCallerIdShouldDisplayDNIS

Pass in true to show the DNIS or false to show the phones phone number.

Parameter	Value
rpcSID:
mailbox:
shouldDisplayDNIS:
JSON Response:

getCallQueueStatus

https://weblinkapi.freedomvoice.com/mailbox/getCallQueueStatus

Gets the status of the call queue for the given mailbox. Polling this function should happen in no less than 5 second increments.

Parameter	Value
rpcSID:
mailbox:
JSON Response:

sendUploadedFax

https://weblinkapi.freedomvoice.com/mailbox/sendUploadedFax

Sends the base64 encoded updated document to the specified phone numbers.

Parameter	Value
rpcSID:
mailbox:
toPhoneNumbers *:
toPhoneNumbers *:
toPhoneNumbers *:
filename:
base64EncodedFileData:
JSON Response:

FreedomVOICE Systems XML/JSON Interface

Mailbox