Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14107861793.8 KB

Get information about a specific bot alias.

get/bots/{botId}/botaliases/{botAliasId}/

Path parameters

botAliasIdstring required

The identifier of the bot alias to describe.

botIdstring required

The identifier of the bot associated with the bot alias to describe.

Response

Success

botAliasIdstring

The identifier of the bot alias.

botAliasNamestring

The name of the bot alias.

descriptionstring

The description of the bot alias.

botVersionstring

The version of the bot associated with the bot alias.

botAliasLocaleSettingsobject

The locale settings that are unique to the alias.

botAliasStatus'Creating' | 'Available' | 'Deleting' | 'Failed'

The current status of the alias. When the alias is <code>Available</code>, the alias is ready for use with your bot.

botIdstring

The identifier of the bot associated with the bot alias.

creationDateTimestring date-time

A timestamp of the date and time that the alias was created.

lastUpdatedDateTimestring date-time

A timestamp of the date and time that the alias was last updated.