Events

View as Markdown

Events

onStateChanged

  • Call.listen({ onStateChanged: Callback })

Emitted when the state of the call changes. Your event handler will be called with an instance of the CallState object.

Parameters

call
CallStateRequired

A Call object containing the call state. See CallState.

onCollectEnded

  • Call.listen({ onCollectEnded: Callback })

Emitted when a collect session has ended. Your event handler will be called with an instance of the CallCollect object.

Parameters

collect
CallCollectRequired

A CallCollect object.

onCollectFailed

  • Call.listen({ onCollectFailed: Callback })

Emitted when a collect session has failed. Your event handler will be called with an instance of the CallCollect object.

Parameters

collect
CallCollectRequired

A CallCollect object.

onCollectInputStarted

  • Call.listen({ onCollectInputStarted: Callback })

Emitted when a collect session has started. Your event handler will be called with an instance of the CallCollect object.

Parameters

collect
CallCollectRequired

A CallCollect object.

onCollectStarted

  • Call.listen({ onCollectStarted: Callback })

Emitted when a collect session has started. Your event handler will be called with an instance of the CallCollect object.

Parameters

collect
CallCollectRequired

A CallCollect object.

onCollectUpdated

  • Call.listen({ onCollectUpdated: Callback })

Emitted when the state of a collect session has changed. Your event handler will be called with an instance of the CallCollect object.

Parameters

collect
CallCollectRequired

A CallCollect object.

onDetectEnded

  • Call.listen({ onDetectEnded: Callback })

Emitted when a call detection session has ended. Your event handler will be called with an instance of the CallDetect object.

Parameters

detect
CallDetectRequired

A CallDetect object.

onDetectStarted

  • Call.listen({ onDetectStarted: Callback })

Emitted when a call detection session has started. Your event handler will be called with an instance of the CallDetect object.

Parameters

detect
CallDetectRequired

A CallDetect object.

onDetectUpdated

  • Call.listen({ onDetectUpdated: Callback })

Emitted when the state of a call detection session has changed. Your event handler will be called with an instance of the CallDetect object.

Parameters

detect
CallDetectRequired

A CallDetect object.

onPlaybackEnded

  • Call.listen({ onPlaybackEnded: Callback })

Emitted when a playback has ended. Your event handler will be called with an instance of the CallPlayback object.

Parameters

playback
CallPlaybackRequired

A CallPlayback object.

onPlaybackFailed

Call.listen({ onPlaybackFailed: Callback })

Emitted when a playback has failed. Your event handler will be called with an instance of the CallPlayback object.

Parameters

playback
CallPlaybackRequired

A CallPlayback object.

onPlaybackStarted

  • Call.listen({ onPlaybackStarted: Callback })

Emitted when a playback has started. Your event handler will be called with an instance of the CallPlayback object.

Parameters

playback
CallPlaybackRequired

A CallPlayback object.

onPlaybackUpdated

  • Call.listen({ onPlaybackUpdated: Callback })

Emitted when the state of a playback has changed. Your event handler will be called with an instance of the CallPlayback object.

Parameters

playback
CallPlaybackRequired

A CallPlayback object.

onPromptEnded

  • Call.listen({ onPromptEnded: Callback })

Emitted when a prompt has ended. Your event handler will be called with an instance of the CallPrompt object.

Parameters

prompt
CallPromptRequired

A CallPrompt object.

onPromptFailed

  • Call.listen({ onPromptFailed: Callback })

Emitted when a prompt has failed. Your event handler will be called with an instance of the CallPrompt object.

Parameters

prompt
CallPromptRequired

A CallPrompt object.

onPromptStarted

  • Call.listen({ onPromptStarted: Callback })

Emitted when a prompt has started. Your event handler will be called with an instance of the CallPrompt object.

Parameters

prompt
CallPromptRequired

A CallPrompt object.

onPromptUpdated

  • Call.listen({ onPromptUpdated: Callback })

Emitted when the state of a prompt has changed. Your event handler will be called with an instance of the CallPrompt object.

Parameters

prompt
CallPromptRequired

A CallPrompt object.

onRecordingEnded

  • Call.listen({ onRecordingEnded: Callback })

Emitted when a recording has ended. Your event handler will be called with an instance of the CallRecording object.

Parameters

recording
CallRecordingRequired

A CallRecording object.

onRecordingFailed

  • Call.listen( { onRecordingFailed: Callback })

Emitted when a recording has failed. Your event handler will be called with an instance of the CallRecording object.

Parameters

recording
CallRecordingRequired

A CallRecording object.

onRecordingStarted

  • Call.listen({ onRecordingStarted: Callback })

Emitted when a recording has started. Your event handler will be called with an instance of the CallRecording object.

Parameters

recording
CallRecordingRequired

A CallRecording object.

onRecordingUpdated

  • Call.listen({ onRecordingUpdated: Callback })

Emitted when the state of a recording has changed. Your event handler will be called with an instance of the CallRecording object.

Parameters

recording
CallRecordingRequired

A CallRecording object.

onTapEnded

  • Call.listen({ onTapEnded: Callback })

Emitted when a tap has ended. Your event handler will be called with an instance of the CallTap object.

Parameters

tap
CallTapRequired

A CallTap object.

onTapStarted

  • Call.listen({ onTapStarted: Callback })

Emitted when a tap has started. Your event handler will be called with an instance of the CallTap object.

Parameters

tap
CallTapRequired

A CallTap object.