CallError | SignalWire

Structured error emitted on call.errors$.

Provides actionable metadata so consumers can react without resorting to instanceof checks on raw Error objects.

Properties

callId

stringRequired

ID of the call that produced this error.

error

ErrorRequired

The underlying error.

fatal

booleanRequired

Whether the error terminates the call. When true, the call will automatically transition to 'failed' and be destroyed — no further action is needed from the consumer.

leg

'main' | 'screenshare' | 'additional-device'

Which peer connection failed, e.g. 'screenshare'. Auxiliary legs are never fatal, so a consumer can surface “screen share failed, call continues”. Absent for call- and session-level errors.

legId

string

ID of the failing leg. callId is always the call’s own ID, never the leg’s — use this one to identify the leg.

kind

CallErrorKindRequired

Semantic category of the error. See CallErrorKind.