Skip to main content
stopDialOut(options) Has no effect if the session ID is not found.

Parameters

sessionId
string
required
The UUID identifying the dial-out session to stop. This is the session.sessionId returned by startDialOut().

Return value

Returns Promise<void>.

Errors

  • NOT_ALLOWED — SIP/PSTN is not enabled for the room.
  • NOT_FOUND — No active dial-out session found with the given sessionId.

Example

const { session } = await call.startDialOut({ phoneNumber: '+12268077097' });

// Later, stop it
await call.stopDialOut({ sessionId: session.sessionId });

See also