Skip to main content

Request recording for a call

POST 
/texml/Accounts/:account_sid/Calls/:call_sid/Recordings.json

Starts recording with specified parameters for call idientified by call_sid.

Request​

Path Parameters

    account_sid stringrequired

    The id of the account the resource belongs to.

    call_sid stringrequired

    The CallSid that identifies the call to update.

Body

Starts call recording on a call.

    PlayBeep PlayBeep (boolean)

    Default value: true

    Whether to play a beep when recording is started.

    RecordingStatusCallbackEvent RecordingStatusCallbackEvent (string)

    The changes to the recording's state that should generate a call to RecoridngStatusCallback. Can be: in-progress, completed and absent. Separate multiple values with a space. Defaults to completed.

    RecordingStatusCallback uri

    Url where status callbacks will be sent.

    RecordingStatusCallbackMethod TexmlStatusCallbackMethod (string)

    Possible values: [GET, POST]

    Default value: POST

    HTTP method used to send status callbacks.

    RecordingChannels TexmlRecordingChannels (string)

    Possible values: [single, dual]

    Default value: dual

    When dual, final audio file has the first leg on channel A, and the rest on channel B. single mixes both tracks into a single channel.

    RecordingTrack RecordingTrack (string)

    Possible values: [inbound, outbound, both]

    The audio track to record for the call. The default is both.

Responses​

200: Successful call recording create response

Schema

    account_sid AccountSid (string)
    call_sid CallControlId (string)
    conference_sid uuidnullable
    channels TwimlRecordingChannels (integer)

    Possible values: [1, 2]

    Default value: 2

    date_created datetime-rfc2822
    date_updated datetime-rfc2822
    start_time datetime-rfc2822
    price TexmlRecordingPrice (string)nullable

    The price of this recording, the currency is specified in the price_unit field.

    price_unit TexmlPriceUnit (string)nullable

    The unit in which the price is given.

    duration TexmlRecordingDuration (string)nullable

    The duration of this recording, given in seconds.

    sid TexmlSid (string)

    Identifier of a resource.

    source RecordingSource (string)

    Possible values: [StartCallRecordingAPI, StartConferenceRecordingAPI, OutboundAPI, DialVerb, Conference, RecordVerb, Trunking]

    Defines how the recording was created.

    error_code TexmlErrorCode (string)nullable
    track RecordingTrack (string)

    Possible values: [inbound, outbound, both]

    The audio track to record for the call. The default is both.

    uri string

    The relative URI for this recording resource.

404: Resource not found

Schema

    errors

    object[]

  • Array [

    • detail string

  • ]

Request samples

curl -L -X POST 'https://api.telnyx.com/v2/texml/Accounts/:account_sid/Calls/:call_sid/Recordings.json' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "account_sid": "61bf923e-5e4d-4595-a110-56190ea18a1b",
  "call_sid": "v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA",
  "conference_sid": "cd5a70f4-759b-4d5e-9c06-88c00f16f3c1",
  "channels": 1,
  "date_created": "Fri, 11 Aug 2023 19:12:11 +0000",
  "date_updated": "Fri, 11 Aug 2023 19:12:11 +0000",
  "start_time": "Fri, 11 Aug 2023 19:12:11 +0000",
  "price": "0.10",
  "price_unit": "USD",
  "duration": "12",
  "sid": "e9cea0be-7dbd-4b98-98b1-c0089d9d43b0",
  "source": "StartCallRecordingAPI",
  "error_code": null,
  "track": "inbound",
  "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls/v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA/Recordings/b08f0fa1-a32c-4218-b3b5-9cf78941ccac.json"
}