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.

Request Information

URI Parameters

Name	Description	Type	Additional information
systemPhoneNumber		string	Required

Body Parameters

CallReservationSetting

Name	Description	Type	Additional information
ExpectedCallerIdNumber	The client's phone number the switchboard expects to receive a call from	string	None.
PresentationPhoneNumber	The desired outbound caller id to present to the callee, must be one of the numbers provided by API PresentationPhoneNumber	string	None.
DestinationPhoneNumber	The phone number that should be called	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ExpectedCallerIdNumber": "8005551212",
  "PresentationPhoneNumber": "8005553434",
  "DestinationPhoneNumber": "8005556767"
}

application/xml, text/xml

Sample:

<CallReservationSetting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FreedomVoice.WebLink.Models.Settings">
  <DestinationPhoneNumber>8005556767</DestinationPhoneNumber>
  <ExpectedCallerIdNumber>8005551212</ExpectedCallerIdNumber>
  <PresentationPhoneNumber>8005553434</PresentationPhoneNumber>
</CallReservationSetting>

application/x-www-form-urlencoded

Sample:

ExpectedCallerIdNumber=8005551212&PresentationPhoneNumber=8005553434&DestinationPhoneNumber=8005556767

Response Information

Resource Description

200 status code will be returned for successful reservation along with switchboard number to dial. 400 status code will be returned if any of the provided values aren't valid phone numbers or if the phone number contains formatting. 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.

CreateCallReservationSetting

Name	Description	Type	Additional information
SwitchboardPhoneNumber	The number to call to use the switchboard reservation and have a call placed to the specified recipient such that they are presented with the caller id selected	string	None.

Response Formats

application/json, text/json

Sample:

{
  "SwitchboardPhoneNumber": "8005551212"
}

application/xml, text/xml

Sample:

<CreateCallReservationSetting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FreedomVoice.WebLink.Models.RequestDTOs">
  <SwitchboardPhoneNumber>8005551212</SwitchboardPhoneNumber>
</CreateCallReservationSetting>