Skip to content

Latest commit

 

History

History
44 lines (38 loc) · 3.24 KB

ConferenceRecordingAvailableCallback.md

File metadata and controls

44 lines (38 loc) · 3.24 KB
Raw

Bandwidth::ConferenceRecordingAvailableCallback

Properties

Name Type Description Notes
event_type String The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. [optional]
event_time Time The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. [optional]
conference_id String The unique, Bandwidth-generated ID of the conference that was recorded [optional]
name String The user-specified name of the conference that was recorded [optional]
account_id String The user account associated with the call. [optional]
recording_id String The unique ID of this recording [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]
duration String The duration of the recording in ISO-8601 format [optional]
file_format FileFormatEnum [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]
tag String (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. [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]

Example

require 'bandwidth-sdk'

instance = Bandwidth::ConferenceRecordingAvailableCallback.new(
  event_type: bridgeComplete,
  event_time: 2022-06-17T22:19:40.375Z,
  conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
  name: my-conference-name,
  account_id: 9900000,
  recording_id: r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833,
  channels: 1,
  start_time: 2022-06-17T22:19:40.375Z,
  end_time: 2022-06-17T22:20Z,
  duration: PT13.67S,
  file_format: null,
  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,
  tag: exampleTag,
  status: completed
)