Events

View as Markdown

Events

call.created

  • call.created(call)

A call was created.

Parameters

NameTypeDescription
callCallStateA object containing the call state.

call.ringing

  • call.ringing(call)

A call is ringing.

Parameters

NameTypeDescription
callCallStateA object containing the call state.

call.answered

  • call.answered(call)

A call was answered.

Parameters

NameTypeDescription
callCallStateA object containing the call state.

call.ending

  • call.ending(call)

A call is ending.

Parameters

NameTypeDescription
callCallStateA object containing the call state.

call.ended

  • call.ended(call)

A call ended.

Parameters

NameTypeDescription
callCallStateA object containing the call state.

collect.ended

  • collect.ended(collect)

A collect ended.

Parameters

NameTypeDescription
collectCallCollectA collect object.

collect.failed

  • collect.failed(collect)

A collect failed.

Parameters

NameTypeDescription
collectCallCollectA collect object.

collect.startOfInput

  • collect.startOfInput(collect)

User input began in a collect.

Parameters

NameTypeDescription
collectCallCollectA collect object.

collect.started

  • collect.started(collect)

A collect started.

Parameters

NameTypeDescription
collectCallCollectA collect object.

collect.updated

  • collect.updated(collect)

The state of a collect changed.

Parameters

NameTypeDescription
collectCallCollectA collect object.

playback.ended

  • playback.ended(playback)

A playback ended.

Parameters

NameTypeDescription
playbackCallPlaybackA playback object.

playback.started

  • playback.started(playback)

A playback has started.

Parameters

NameTypeDescription
playbackCallPlaybackA playback object.

playback.updated

  • playback.updated(playback)

The state of a playback changed.

Parameters

NameTypeDescription
playbackCallPlaybackA playback object.

prompt.ended

  • prompt.ended(prompt)

A prompt has ended.

Parameters

NameTypeDescription
promptCallPromptA prompt object.

prompt.failed

  • prompt.failed(prompt)

A prompt has failed.

Parameters

NameTypeDescription
promptCallPromptA prompt object.

prompt.started

  • prompt.started(prompt)

A prompt started.

Parameters

NameTypeDescription
promptCallPromptA prompt object.

prompt.updated

  • prompt.updated(prompt)

The state of a prompt changed.

Parameters

NameTypeDescription
promptCallPromptA prompt object.

recording.ended

  • recording.ended(recording)

A recording ended.

Parameters

NameTypeDescription
recordingCallRecordingA recording object.

recording.failed

  • recording.failed(recording)

A recording failed.

Parameters

NameTypeDescription
recordingCallRecordingA recording object.

recording.started

  • recording.started(recording)

A recording started.

Parameters

NameTypeDescription
recordingCallRecordingA recording object.

recording.updated

  • recording.updated(recording)

The state of a recording changed.

Parameters

NameTypeDescription
recordingCallRecordingA recording object.

tap.ended

  • tap.ended(tap)

A tap ended.

Parameters

NameTypeDescription
tapCallTapA tap object.

tap.started

  • tap.started(tap)

A tap started.

Parameters

NameTypeDescription
tapCallTapA tap object.