Skip to content

Latest commit

 

History

History
15 lines (11 loc) · 1.65 KB

Play.md

File metadata and controls

15 lines (11 loc) · 1.65 KB

freeclimb.Model.Play

The Play command plays an audio file back to the caller. The audio file may be located at any location accessible via a URL. Play can exist as a stand-alone command or as a nested command. It does not allow barge-in unless nested within a GetSpeech command. The file will always be played to completion unless nested.

Properties

Name Type Description Notes
Command string Name of PerCL Command (this is automatically derived from mapping configuration and should not be manually supplied in any arguments) [optional]
File string RL of the audio file to be played to the caller. The URL can be the `recordingUrl` generated from the `RecordUtterance` or `StartRecordCall` PerCL commands.
Loop int Number of times the audio file is played. Specifying '0' causes the Play action to loop until the Call is hung up. [optional]
ConferenceId string ID of the Conference the audio should be rendered to. If this is not specified, the audio is by default rendered to the caller associated with the call leg that corresponds to the current PerCL execution context. The call leg associated with this command must be in the specified Conference or the command will return an error. [optional]
PrivacyMode bool Parameter `privacyMode` will not log the `text` as required by PCI compliance. [optional]

[Back to Model list] [Back to API list] [Back to README]