Skip to content

Latest commit

 

History

History
54 lines (48 loc) · 3.58 KB

CallRecordingMetadata.md

File metadata and controls

54 lines (48 loc) · 3.58 KB
Raw

Bandwidth::CallRecordingMetadata

Properties

Name Type Description Notes
application_id String The id of the application associated with the call. [optional]
account_id String The user account associated with the call. [optional]
call_id String The call id associated with the event. [optional]
parent_call_id String (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present. [optional]
recording_id String The unique ID of this recording [optional]
to String The phone number that received the call, in E.164 format (e.g. +15555555555). [optional]
from String The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). [optional]
transfer_caller_id String The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). [optional]
transfer_to String The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). [optional]
duration String The duration of the recording in ISO-8601 format [optional]
direction CallDirectionEnum [optional]
channels Integer Always `1` for conference recordings; multi-channel recordings are not supported on conferences. [optional]
start_time Time Time the call was started, in ISO 8601 format. [optional]
end_time Time The time that the recording ended in ISO-8601 format [optional]
file_format FileFormatEnum [optional]
status String The current status of the process. For recording, current possible values are 'processing', 'partial', 'complete', 'deleted', and 'error'. For transcriptions, current possible values are 'none', 'processing', 'available', 'error', 'timeout', 'file-size-too-big', and 'file-size-too-small'. Additional states may be added in the future, so your application must be tolerant of unknown values. [optional]
media_url String The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. [optional]
transcription RecordingTranscriptionMetadata [optional]
recording_name String A name to identify this recording. [optional]

Example

require 'bandwidth-sdk'

instance = Bandwidth::CallRecordingMetadata.new(
  application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
  account_id: 9900000,
  call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
  parent_call_id: c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d,
  recording_id: r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833,
  to: +15555555555,
  from: +15555555555,
  transfer_caller_id: +15555555555,
  transfer_to: +15555555555,
  duration: PT13.67S,
  direction: null,
  channels: 1,
  start_time: 2022-06-17T22:19:40.375Z,
  end_time: 2022-06-17T22:20Z,
  file_format: null,
  status: completed,
  media_url: https://voice.bandwidth.com/api/v2/accounts/9900000/conferences/conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9/recordings/r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833/media,
  transcription: null,
  recording_name: my-recording-name
)