Type alias EndCallToolOptions<UserData>

Type declaration

• Optional deleteRoom?: boolean

  Whether to delete the room when the user ends the call. Deleting the room disconnects all remote users, including SIP callers.

• Optional endInstructions?: string | null

  Tool output to the LLM for generating the tool response.

• Optional extraDescription?: string

  Additional description to add to the end call tool.

• Optional ignoreOnEnter?: boolean

  Hide the tool during onEnter so the model can't end the call while greeting.

• Optional onToolCalled?: ((event) => Promise<void> | void)

  Callback to call when the tool is called.

  • • (event): Promise<void> | void

    • Parameters

      • event: EndCallToolCalledEvent<UserData>

      Returns Promise<void> | void

• Optional onToolCompleted?: ((event) => Promise<void> | void)

  Callback to call when the tool is completed.

  • • (event): Promise<void> | void

    • Parameters

      • event: EndCallToolCompletedEvent<UserData>

      Returns Promise<void> | void