Record command

The Record command records a chosen call, you can select the call by its call ID. The records are stored at Ozeki Phone System\HttpRecordings

Parameters:

Parameter name Value Description Mandatory
CallId string value,
e.g. 6eg3ft
ID of the call to record audio from. By default it is known from the CallChanged notification. No
Format string value,
(mp3 or wav)
Record format supports mp3 or wav audio format, by default it is mp3. No
FinishedUrl int value,
e.g. http://yourapp.com/record_finished.php
This URL will be requested if the record is finished. This is where the RecordCompleted notification is sent. This notification contains a RecordURL parameter which is the path from where the record can be downloaded from. No

OzML simple example:

Records the call with call ID 6eg3ft in wav format. When the record is completed a RecordCompleted notification is sent to http://yourapp.com/record_finished.php.

<?xml version="1.0"?>
<Response>
  <Record FinishedUrl="http://yourapp.com/record_finished.php" Format="wav" CallId="6eg3ft">
  </Record>
</Response>

Detailed example:

First the speak engine says this: "Your call will be recorded." Then it records the call in wav format. When the record is completed a RecordCompleted notification is sent to http://yourapp.com/record_finished.php.

<?xml version="1.0"?>
<Response>
	<Speak CallId="6eg3ft" Party="all">Your call will be recorded.</Speak>
  	<Record CallId="6eg3ft" FinishedUrl="http://yourapp.com/record_finished.php" Format="wav">
  	</Record>
</Response>

Record command is used in OzML responses to these notification:

CallChanged, RecordCompleted

More information