Play command

The Play command is used to play a wav or mp3 sound to chosen parties of the conversation (caller, callee or all).

Command example usage:

It is used to play a sound file during a conversation for example if one of the parties are low in telephone credits it could say: "You have 1 dollar left in your phone account. Please recharge it as soon as possible!"

Parameters:

Parameter name Value Description Mandatory
Party string value
(caller, callee or all)		 The destination party to play the sound to. Yes
CallId string value,
e.g. H2Wwb		 The call ID of the call you want to run the Play command on. Defaultly it is known from the CallChanged notification. No
AudioFile string value
(URL or localhost addresse)		 The destination of the audio file. When a relative path is provided, it will be relative to ContentStorage/Static directory in Ozeki Phone System install directory. It can be HTTP URL as well where it's downloaded from and cached (based on the webserver settings). This parameter can be provided between the command nodes. Yes
Repeat bool value
(true or false)		 If you want to repeat the file set it to true else set it to false. It's default value is false. No

OzML simple example:

Plays hello.wav from ContentStorage/Static directory in Ozeki Phone System install directory to all participants of the phone call. 

<?xml version="1.0"?>
<Response>
  <Play Party="all">hello.wav</Play>
</Response>

Detailed example:

1st it plays hello.wav from ContentStorage/Static directory in Ozeki Phone System install directory to all participants of the phone call. Then says to all participants: "The callee will be transfered to number 1001." Then it transfers the callee to 1001. 

<?xml version="1.0"?>
<Response>
  <Play Party="all">hello.wav</Play>
  <Speak Party="all">The callee will be transfered to number 1001.</Speak>
  <BlindTransfer TransferorParty="callee" Target="1001"></BlindTransfer>
</Response>

Play command is used in OzML responses to this notification:

CallChanged
, RecordCompleted

More information