Freedomvoice REST API documentation

Introduction

This document describes the REST API and resources provided by Freedomvoice. The REST APIs are for developers who want to integrate Freedomvoice into their application.

Authenticate user credentials providing a username/password.

API	Description
POST api/v1/login/	Authenticate user
POST api/v1/passwordReset/	Sends a email with a link to a password reset url for the username provided

Systems

API	Description
GET api/v1/systems/{systemPhoneNumber}/presentationPhoneNumbers/	Gets a list of phone numbers than can be used as the outbound caller id
POST api/v1/systems/{systemPhoneNumber}/createCallReservation/	Creates a reservation and returns a switchboard phone number for the client to call that initiates a phone call to the destination.
GET api/v1/systems/	Gets a list of phone numbers that represent the different applications for which a user has access

Mailboxes

API	Description
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
GET api/v1/systems/{systemPhoneNumber}/mailboxesWithCounts/	Provides info with counts on mailboxes for the application with the given system phone number that the user has access to

Folders

API	Description
GET api/v1/systems/{systemPhoneNumber}/mailboxes/{mailboxNumber}/folders/	Returns the folders of a mailbox with information on each folder given the default phone number and mailbox number.
GET api/v1/systems/{systemPhoneNumber}/mailboxes/{mailboxNumber}/foldersWithCounts/	Returns the folders of a mailbox with information on each folder with unread counts given the default phone number and mailbox number.

Messages

API	Description
GET api/v1/systems/{systemPhoneNumber}/mailboxes/{mailboxNumber}/folders/{folderName}/messages?PageSize={PageSize}&PageNumber={PageNumber}&SortAsc={SortAsc}/	Provides a messages list for a given folder
POST api/v1/systems/{systemPhoneNumber}/mailboxes/{mailboxNumber}/moveMessages/	Moves the given list of messages from their current folder to the selected destination folder
POST api/v1/systems/{systemPhoneNumber}/mailboxes/{mailboxNumber}/deleteMessages/	Deletes the given list of messages

Media

API	Description
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

Settings

API	Description
GET api/v1/settings/pollingInterval/	The requested rate to poll for data

Push

API	Description
POST api/v1/systems/{systemPhoneNumber}/push/subscribe/	Send message
POST api/v1/systems/{systemPhoneNumber}/push/unsubscribe/	Send message

TextMessages

API	Description
POST api/v1/systems/{systemPhoneNumber}/presentationPhoneNumber/{presentationPhoneNumber}/sms/	Send message

Сonversations

API	Description
GET api/v1/systems/{systemPhoneNumber}/presentationPhoneNumber/{presentationPhoneNumber}/conversations?from={from}&to={to}&start={start}&limit={limit}/	Get list of conversations between two numbers
GET api/v1/systems/{systemPhoneNumber}/presentationPhoneNumber/{presentationPhoneNumber}/conversation?toPhone={toPhone}/	Get conversation by the current number and the collocutor number
POST api/v1/systems/{systemPhoneNumber}/presentationPhoneNumber/{presentationPhoneNumber}/conversations/search/	Get list of conversations between two numbers
GET api/v1/systems/{systemPhoneNumber}/presentationPhoneNumber/{presentationPhoneNumber}/messages?conversationId={conversationId}&from={from}&to={to}&start={start}&limit={limit}/	Get list of messages by provided id of conversation
DELETE api/v1/systems/{systemPhoneNumber}/presentationPhoneNumber/{presentationPhoneNumber}/conversation/{conversationId}/	No documentation available.
PUT api/v1/systems/{systemPhoneNumber}/presentationPhoneNumber/{presentationPhoneNumber}/conversation/{conversationId}/message/	No documentation available.