Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-17610178.5 KB

Removes session information for a specified bot, alias, and user ID.

You can use this operation to restart a conversation with a bot. When you remove a session, the entire history of the session is removed so that you can start again.

You don't need to delete a session. Sessions have a time limit and will expire. Set the session time limit when you create the bot. The default is 5 minutes, but you can specify anything between 1 minute and 24 hours.

If you specify a bot or alias ID that doesn't exist, you receive a BadRequestException.

If the locale doesn't exist in the bot, or if the locale hasn't been enables for the alias, you receive a BadRequestException.

delete/bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId}

Path parameters

botIdstring required

The identifier of the bot that contains the session data.

botAliasIdstring required

The alias identifier in use for the bot that contains the session data.

localeIdstring required

The locale where the session is in use.

sessionIdstring required

The identifier of the session to delete.

Response

Success

botIdstring

The identifier of the bot that contained the session data.

botAliasIdstring

The alias identifier in use for the bot that contained the session data.

localeIdstring

The locale where the session was used.

sessionIdstring

The identifier of the deleted session.