Skip to main content
Use startRecording() to begin recording within the current embedded session.
Applies to Web Component, Window API, and PostMessage. Examples on this page use the Web Component API shape.

​
Usage

await api.startRecording();

​
Prerequisites

  • User must be authenticated.
  • An interaction must exist.
  • The application must be in an interview or session context.

​
Input validation

  • None

​
Possible errors

  • NOT_READY: Not in interview context or no interaction exists.
  • UNAUTHORIZED: User not authenticated.
  • NOT_FOUND: Interaction not found.
  • INTERNAL_ERROR: Failed to connect to the recording service.

​
Returns

void