Integrate the SDK

Errors

When something fails in a session — while it starts, while it runs, or when a request you made is rejected — it reaches your code as one typed error. You catch it, explain it to the user in your own words, and branch on it; every code it can carry is listed below.

The error object

Every error is one object:

The phase tells you when the error happened — the same code can mean a failed start or a dropped connection mid-session:

Listen for errors

However a session fails, you never have to hunt for the error: the same object is delivered to three places, each suited to a different job — a callback for reacting the moment something fails, the session state for rendering, and the rejected promise for the code that asked. Use whichever fits the code you are writing.

• The onError callback — called the moment it happens. Log the error or send it to analytics from there:
  ReactAngularJavaScript

  tscopy

  const voice = useSpeechToForm({
    form: intakeForm,
    onError: (error) => showBanner(error.code, error.recoverable),
  });

• The session state — the error sits there as error and stays until the next start() succeeds. Render your message from there — describe is your own mapping from a code to your wording:
  ReactAngularJavaScript

  tsxcopy

  {voice.error && <p role="alert">{describe(voice.error.code)}</p>}

• The rejected promise — start() and end() reject with the same error, so an await where you call them catches it directly:
  ReactAngularJavaScript

  tsxcopy

  const onSpeak = async () => {
    try {
      await voice.start();
    } catch (error) {
      showBanner(error.code, error.recoverable);
    }
  };

Error codes

Grouped by what you should do about them. The codes are frozen: they will not change under you.