{"startRecording":} object

Allows Tropo applications to begin recording the current session. The resulting recording may then be sent via FTP or an HTTP POST/Multipart Form.

Fields

format
Data Type: 
String
Default: 
audio/wav
Optional

This specifies the format for the audio recording; it can be 'audio/wav', 'audio/mp3' or 'audio/au'.

method
Data Type: 
String
Default: 
POST
Optional

When submitting recordings via HTTP, this parameter determines the method used. This can be 'POST' (which is the default) or 'PUT' . When sending via POST, the name of the form field is "filename".

url
Data Type: 
String
Default: (none) Required

This is the destination URL to send the recording. This can be an FTP destination, like so:

ftp://ftp.myServer.com/files/myRecording.wav

You can build your username and password directly inline with the URL, or you can define them with the individual "username" and "password" fields.

Please note this needs to be a fully realized URL, i.e. "http://website.com/folder/subfolder" vs "/folder/subfolder". If you don't have a complete URL, the file won't send at all or at the very least won't send correctly (0 byte file and similar unusable content).

username
Data Type: 
String
Default: (none) Optional

Defines the username for either HTTP Basic Auth or an FTP login.

Note: If the user and password field in the URL contains one of these characters : or @ or /, the character must be encoded.

password
Data Type: 
String
Default: (none) Optional

Defines the password for either HTTP Basic Auth or an FTP login.

Note: If the user and password field in the URL contains one of these characters : or @ or /, the character must be encoded.

transcriptionEmailFormat
Data Type: 
String
Default: 
plain
Optional

Specifies the encoding used when delivering transcriptions via e-mail. Values can be "plain" or "encoded".

transcriptionID
Data Type: 
String
Default: 
none
Optional

User definable ID that can be included when the transcription is posted to transcriptionOutURI.

transcriptionOutURI
Data Type: 
String
Default: 
none
Optional

The e-mail address or HTTP URL to send the transcription results to; the transcription arrives as the content of the HTTP POST, as opposed to a header, named field or variable, and is not sent as form data.

Note: Email addresses must be prefaced with mailto: if used (mailto:you@example.com)

Examples

Example with stopRecording

{
   "tropo":[
      {
         "startRecording":{
            "name":"myrecording",
            "url":"http://example.com/getrecord.php"
         }
      },
      {
         "say":[
            {
               "value":"I am now recording!"
            }
         ]
      },
      {
         "stopRecording":null
      }
   ]
}