Update recording on a call

Updates recording resource for particular call.

POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings/{recording_sid}.json

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.texml.accounts.calls.recordings.recordingSidJson(
  '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
  { account_sid: 'account_sid', call_sid: 'call_sid' },
);

console.log(response.account_sid);

200

{
  "account_sid": "61bf923e-5e4d-4595-a110-56190ea18a1b",
  "call_sid": "v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA",
  "conference_sid": "cd5a70f4-759b-4d5e-9c06-88c00f16f3c1",
  "channels": 1,
  "date_created": "2023-08-11T19:12:11Z",
  "date_updated": "2023-08-11T19:12:11Z",
  "start_time": "2023-08-11T19:12:11Z",
  "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"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

account_sid · string · required

The id of the account the resource belongs to.

call_sid · string · required

The CallSid that identifies the call to update.

recording_sid · string<uuid> · required

Uniquely identifies the recording by id.

Example:

"6a09cdc3-8948-47f0-aa62-74ac943d6c58"

Body

application/x-www-form-urlencoded

Update call recording on a call.

Status · enum<string>

Available options: in-progress, paused, stopped

Example:

"paused"

Response

200

application/json

Successful call recording create response

account_sid · string

Example:

"61bf923e-5e4d-4595-a110-56190ea18a1b"

call_sid · string

Example:

"v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA"

conference_sid · string<uuid> | null

Example:

"cd5a70f4-759b-4d5e-9c06-88c00f16f3c1"

channels · enum<integer> · default: 2

Available options: 1, 2

Example:

1

date_created · string<date-time>

Example:

"2023-08-11T19:12:11Z"

date_updated · string<date-time>

Example:

"2023-08-11T19:12:11Z"

start_time · string<date-time>

Example:

"2023-08-11T19:12:11Z"

price · string | null

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

Example:

"0.10"

price_unit · string | null

The unit in which the price is given.

Example:

"USD"

duration · string | null

The duration of this recording, given in seconds.

Example:

"12"

sid · string

Identifier of a resource.

Example:

"e9cea0be-7dbd-4b98-98b1-c0089d9d43b0"

source · enum<string>

Defines how the recording was created.

Available options: StartCallRecordingAPI, StartConferenceRecordingAPI, OutboundAPI, DialVerb, Conference, RecordVerb, Trunking

error_code · string | null

Example:

null

track · enum<string>

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

Available options: inbound, outbound, both

Example:

"inbound"

uri · string

The relative URI for this recording resource.

Example:

"/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls/v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA/Recordings/b08f0fa1-a32c-4218-b3b5-9cf78941ccac.json"