Recordings

Create a Recording

Starts a recording resource for an active call. Use Update a Recording to pause, resume, or stop it; use the account-level Recordings collection to find saved media across calls.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.

Learn more about API scopes.

post/Accounts/{AccountSid}/Calls/{CallSid}/Recordings

Path parameters

AccountSidstring uuid required

Universal Unique Identifier.

The Project ID that uniquely identifies the Account.

CallSidstring uuid required

Universal Unique Identifier.

The unique identifier for the call.

Response

The request has succeeded.

sidstring uuid required

Universal Unique Identifier.

account_sidstring uuid required

Universal Unique Identifier.

api_versionstring required

The version of the SignalWire API.

call_sidstring uuid required

Universal Unique Identifier.

conference_sidstring uuid required

Universal Unique Identifier.

channel'1' | '2' required

The number of channels in a recording (singular key). Returns '1' for mono or '2' for stereo.

channels'1' | '2' required

The number of channels in a recording. Returns '1' for mono or '2' for stereo.

date_createdstring required

The date, in RFC 2822 format, this recording was created.

date_updatedstring required

The date, in RFC 2822 format, this recording was updated.

start_timestring nullable required

The time, in RFC 2822 format, this recording started.

end_timestring nullable required

The time, in RFC 2822 format, this recording ended.

durationinteger required

The length, in seconds, of the recording.

pricestring nullable required

The cost for the recording.

price_unitstring required

The currency of the price of the recording.

source'DialVerb' | 'Conference' | 'OutBoundApi' | 'Trunking' | 'RecordVerb' | 'StartCallRecordingApi' | 'StartConferenceRecording' required

Recording source.

status'queued' | 'in-progress' | 'paused' | 'resumed' | 'completed' | 'absent' | 'stopped' required

Recording status.

error_codestring nullable required

Further details about a failed recording.

uristring required

The URI of the recording.

encryption_detailsstring nullable required

Encryption details. Always null.

trimstring required

Whether leading and trailing silence is trimmed from a recording.

Example response

{
  "api_version": "2010-04-01",
  "channel": "1",
  "channels": "1",
  "date_created": "Tue, 25 Sep 2018 23:00:00 +0000",
  "date_updated": "Wed, 26 Sep 2018 23:00:04 +0000",
  "start_time": "Tue, 25 Sep 2018 23:00:00 +0000",
  "end_time": "Wed, 26 Sep 2018 23:00:04 +0000",
  "duration": 4,
  "price": "-0.0025",
  "price_unit": "USD",
  "uri": "/api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Recordings/19e436af-5688-4307-b03b-bdb2b42b8142.json",
  "subresource_uris": {
    "transcriptions": "/api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Recordings/19e436af-5688-4307-b03b-bdb2b42b8142/Transcriptions.json"
  },
  "trim": "do-not-trim"
}

Changes

Changed in 9 of the 40 revisions of this API.30766

  • 2916d5e3072e46See the full diff
    • the response's property type changed from string to no type, and format from uuid to no format for status

      response-property-type-changed

    • the response's property format changed from uuid to no format for status

      response-property-type-changed

    • the response's property format changed from uuid to no format for status

      response-property-type-changed

    • the response's property type changed from string to no type, and format from uuid to no format for status

      response-property-type-changed

    • added to the response property allOf list for the response status

      response-property-all-of-added

    • added to the response property allOf list for the response status

      response-property-all-of-added

    • added to the response property anyOf list for the response status

      response-property-any-of-added

    • added to the response property anyOf list for the response status

      response-property-any-of-added

    • removed subschema #1 from the response property anyOf list for the response status

      response-property-any-of-removed

    • removed subschema #1 from the response property anyOf list for the response status

      response-property-any-of-removed

  • 5344c0c93a4c17See the full diff
    • added 'unevaluatedProperties' constraint to the request body

      request-body-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the response body for the status

      response-body-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the response body for the status

      response-body-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the response body for the status

      response-body-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the response body for the status

      response-body-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the response body for the status

      response-body-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the response body for the status

      response-body-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the //// response property for the status

      response-property-unevaluated-properties-added

    • response property call_sid list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property conference_sid list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property encryption_details list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property end_time list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property error_code list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property price list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property start_time list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

  • d5fbaaddfa3e11629See the full diff
    • removed the enum value absent of the request property

      request-property-enum-value-removed

    • removed the enum value completed of the request property

      request-property-enum-value-removed

    • removed the enum value in-progress of the request property

      request-property-enum-value-removed

    • the request property format changed from no format to uri

      request-property-type-changed

    • the response property became nullable for the status

      response-property-became-nullable

    • the response property became nullable for the status

      response-property-became-nullable

    • the response property became nullable for the status

      response-property-became-nullable

    • the response property became nullable for the status

      response-property-became-nullable

    • the response property became nullable for the status

      response-property-became-nullable

    • the response's property type changed from number to string for status

      response-property-type-changed

    • the response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • added the new 1 enum value to the response property for the response status

      response-property-enum-value-added

    • added the new 2 enum value to the response property for the response status

      response-property-enum-value-added

    • added the new absent enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new completed enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new queued enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new resumed enum value to the //// response property for the response status

      response-property-enum-value-added

    • the request property default value mono was added

      request-property-default-value-added

    • the request property default value completed was added

      request-property-default-value-added

    • the request property default value changed from trim-silence to do-not-trim

      request-property-default-value-changed

    • added the non-success response with the status

      response-non-success-status-added

    • removed the non-success response with the status

      response-non-success-status-removed

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property ///// became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • removed the 1.00 enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the 2.00 enum value from the response property for the response status

      response-property-enum-value-removed

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    • added the required property to the response with the status

      response-required-property-added

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • api tag Recordings added

      api-tag-added

    • api tag Call Recordings removed

      api-tag-removed

  • 07f73f74a61d11See the full diff
    • removed the media type application/json from the request body

      request-body-media-type-removed

    • added the media type application/x-www-form-urlencoded to the request body

      request-body-media-type-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the response property became nullable for the status

      response-property-became-nullable

  • 3c88f14db21e5118See the full diff
    • removed the media type application/x-www-form-urlencoded from the request body

      request-body-media-type-removed

    • the response's property type changed from integer to number for status

      response-property-type-changed

    • the response's property type changed from string to no type for status

      response-property-type-changed

    • the response's property type changed from string to no type for status

      response-property-type-changed

    • the response's property type changed from object to no type for status

      response-property-type-changed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • api tag Call Recordings added

      api-tag-added

    • api tag Recordings removed

      api-tag-removed

    • added the media type application/json to the request body

      request-body-media-type-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

    • added to the response property allOf list for the response status

      response-property-all-of-added

    • added to the response property allOf list for the response status

      response-property-all-of-added

    • added to the response property allOf list for the response status

      response-property-all-of-added

    • removed the Conference enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the DialVerb enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the OutBoundApi enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the RecordVerb enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the StartCallRecordingApi enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the StartConferenceRecording enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the Trunking enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the in-progress enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the paused enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the stopped enum value from the response property for the response status

      response-property-enum-value-removed

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog