Jump to: navigation, search

Call Control

The following call control operations are available:

Operation Required Attributes Description Valid URIs
Dial destination—the phone number to dial. Creates a new phone call. /devices/{id}/calls—the device on which to create the phone call.
Answer n/a Answers a phone call. /me/calls/{id}—an interaction of type "call".
Hangup n/a Releases a phone call. /me/calls/{id}—an interaction of type "call".
Hold n/a Places the phone call on hold. /me/calls/{id}—an interaction of type "call".
Retrieve n/a Retrieves the phone call from hold. /me/calls/{id}—an interaction of type "call".
SingleStepTransfer destination—the number to transfer to. Transfers the phone call to the specified number. /me/calls/{id}—an interaction of type "call".
SingleStepConference destination—the number of the party to add to the conference. Initiates conference with the specified number. /me/calls/{id}—an interaction of type "call".
InitiateConference

destination—the number of the party to add to the conference.

'destination': {'phoneNumber': 'XXX'}

Initiates a conference with specified destination. /me/calls/{id}—an interaction of type "call".
CompleteConference consultCallUri Completes the conference and adds cosult call to it. consult call. /me/calls/{id}—an interaction of type "call".
SendDtmf digits—a string where each character is a digit (0-9). A dial tone will be produced for each of the digits. Sends request to produce dial tones for the specified digits. /me/calls/{id}—an interaction of type "call".
RemoveParticipantFromConference participant—the phone number of the participant to remove from the conference. Removes the specified participant from the conference. This will result in a "ParticipantsUpdated" notification which will contain the updated list of participants. /me/calls/{id}—an interaction of type "call".
MuteCall Mutes the call specified by the URI. /me/calls/{id}—an interaction of type "call".
UnmuteCall Unmutes the call specified by the URI. /me/calls/{id}—an interaction of type "call".
SwapCalls otherCallUri—the URI of the call to retrieve. Places the call on which this operation is called on hold and retrieves the call specified by otherCallUri. /me/calls/{id}—an interaction of type "call".
MergeWithOtherCall otherCallUri—the URI of the call to merge with. Merges the call on which this operation is called with the call specified by otherCallUri. /me/calls/{id}—an interaction of type "call".
InitiateTransfer destination — the destination party number for a transfer

'destination': {'phoneNumber': 'XXX'}

Initiates a transfer to the specified destination. /me/calls/{id} — an interaction of type "call".
CompleteTransfer consultCallUri – an optional parameter specifying the URI of a second call used to complete the transfer Completes a transfer /me/calls/{id} — an interaction of type "call".
This page was last edited on December 10, 2013, at 19:31.
Comments or questions about this documentation? Contact us for support!