Sinch Voice Application Markup Language (SVAML)

SVAML is a call control markup language developed by Sinch. When your application or server receives a callback event from the Sinch platform, it can respond with a SVAML object to control the voice call. The SVAML object type is defined like this:

Array of objects (svaml.instruction)

The collection of instructions that can perform various tasks during the call. You can include as many instructions as necessary.

object (svaml.action)

The action that will control the call. Each SVAML object can only include one action.

SVAML Quick Reference

A SVAML object is made up of Actions and Instructions. A SVAML object must contain exactly one action but can have as many instructions as necessary.


ActionFunctionalityAllowed inICEACEPIE*
hangupEnds the callICE or ACE response
continueContinues the callACE response
connectPstnDictates how the PSTN call will be connectedICE Response
connectMxpDetermines whether the app-app call will be connectedICE response
connectConfConnects the call to a conferenceICE response
connectSipConnects the call to a SIP serverICE response
runMenuPlays a menu to the calleeICE or ACE response
parkPuts an incoming call on holdICE response
PIE* callbacks

PIE callbacks are not available for DATA calls; only PSTN and SIP calls.



Instructions must always accompany an action and will not work standalone.

playFilesPlays Interactive Voice Response (IVR) files
sayPlays a text-to-speech message
sendDtmfSend DTMF tones
setCookieSets a cookie that can be accessed throughout the call
startRecordingStarts call recording
stopRecordingStops call recording
answerForces the callee to answer the call.
PIE* callbacks

PIE callbacks are not available for DATA calls; only PSTN and SIP calls.

Was this page helpful?
Still have a question? Ask the community.