A recording object represents an audio recording generated during a call or conference using TeXML application. Recording objects track metadata such as format, duration, start and end times, and storage locations.
A recording can be created in the following situations:1. When an outbound call is initiated with record enabled via the REST APIAPI reference: Initiate an outbound callIf your application initiates an outbound call and specifies the record attribute, Telnyx automatically begins recording the call when it is answered.2. When a <Record> verb is executed in a TeXML scriptDocumentation: <Record>Whenever a <Record> verb is encountered in a TeXML response, Telnyx initiates audio capture for the call leg that executed the verb. Each execution produces a distinct recording object that captures the audio during the <Record> period3. When a <Dial> verb is executed with record attributes enabledDocumentation: <Dial>If a <Dial> verb includes recording parameters (e.g., to record the outbound leg created by the dial), Telnyx begins recording as soon as that outbound call leg is created.4. When a <Dial> to <Conference> is executed with record attributesDocumentation: <Conference>When a <Dial> connects a call into a <Conference> and recording attributes are provided, Telnyx initiates conference recording.5. When recording is started manually via the REST APIAPI reference: Request recording for a callThe recording may be triggered dynamically on any existing call by making a request to the start recording endpoint. When the request is executed, Telnyx creates a new recording object associated with that ongoing call.6. When a conference participant is dialed and joined via the REST API with recording enabledAPI reference: Dial a new conference participantIf a new participant is added to a conference using the REST API and recording is enabled for that action, Telnyx begins capturing audio for the participant or the entire conference session.
Recording objects can be retrieved through several query paths depending on how the recording was initiated:1. By Recording ID - API reference2. By Conference ID - API reference3. By Call ID - API reference
Once recording is active, your application can manage or modify the recording session using the REST API:1. Update or stop an ongoing recording on a call - API reference