Skip to content

Latest commit

 

History

History
47 lines (40 loc) · 3.48 KB

ConferenceRecordingAvailableCallback.md

File metadata and controls

47 lines (40 loc) · 3.48 KB

ConferenceRecordingAvailableCallback

The Conference Recording Available event is sent after a conference recording has been processed. It indicates that the recording is available for download.

Properties

Name Type Description Notes
eventType 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] [default to undefined]
eventTime string 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] [default to undefined]
conferenceId string The unique, Bandwidth-generated ID of the conference that was recorded [optional] [default to undefined]
name string The user-specified name of the conference that was recorded [optional] [default to undefined]
accountId string The user account associated with the call. [optional] [default to undefined]
recordingId string The unique ID of this recording [optional] [default to undefined]
channels number Always `1` for conference recordings; multi-channel recordings are not supported on conferences. [optional] [default to undefined]
startTime string Time the call was started, in ISO 8601 format. [optional] [default to undefined]
endTime string The time that the recording ended in ISO-8601 format [optional] [default to undefined]
duration string The duration of the recording in ISO-8601 format [optional] [default to undefined]
fileFormat FileFormatEnum [optional] [default to undefined]
mediaUrl string The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. [optional] [default to undefined]
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] [default to undefined]
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] [default to undefined]

Example

import { ConferenceRecordingAvailableCallback } from 'bandwidth-sdk';

const instance: ConferenceRecordingAvailableCallback = {
    eventType,
    eventTime,
    conferenceId,
    name,
    accountId,
    recordingId,
    channels,
    startTime,
    endTime,
    duration,
    fileFormat,
    mediaUrl,
    tag,
    status,
};

[Back to Model list] [Back to API list] [Back to README]