StartRecordingRequest.md

StartRecordingRequest

Properties

Name	Type	Description	Notes
format	FormatEnum	The audio file format used when storing the call recording. Can be either `mp3` or `wav`.
channels	ChannelsEnum	When `dual`, final audio file will be stereo recorded with the first leg on channel A, and the rest on channel B.
clientState	String	Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.	[optional]
commandId	String	Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.	[optional]
playBeep	Boolean	If enabled, a beep sound will be played at the start of a recording.	[optional]
maxLength	Integer	Defines the maximum length for the recording in seconds. The minimum value is 0. The maximum value is 14400. The default value is 0 (infinite)	[optional]
timeoutSecs	Integer	The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected. The timer only starts when the speech is detected. Please note that call transcription is used to detect silence and the related charge will be applied. The minimum value is 0. The default value is 0 (infinite)	[optional]
recordingTrack	RecordingTrackEnum	The audio track to be recorded. Can be either `both`, `inbound` or `outbound`. If only single track is specified (`inbound`, `outbound`), `channels` configuration is ignored and it will be recorded as mono (single channel).	[optional]
trim	TrimEnum	When set to `trim-silence`, silence will be removed from the beginning and end of the recording.	[optional]
customFileName	String	The custom recording file name to be used instead of the default `call_leg_id`. Telnyx will still add a Unix timestamp suffix.	[optional]

Enum: FormatEnum

Name	Value
WAV	"wav"
MP3	"mp3"

Enum: ChannelsEnum

Name	Value
SINGLE	"single"
DUAL	"dual"

Enum: RecordingTrackEnum

Name	Value
BOTH	"both"
INBOUND	"inbound"
OUTBOUND	"outbound"

Enum: TrimEnum

Name	Value
TRIM_SILENCE	"trim-silence"