Using chatbots with Amazon Chime - Amazon Chime

You must be an Amazon Chime system administrator to complete the steps in this guide. If you need help with the Amazon Chime desktop client, web app, or mobile app, see Getting support in the Amazon Chime User Guide.

Using chatbots with Amazon Chime

If you administer an Amazon Chime Enterprise account, you can create up to 10 chatbots for integration with Amazon Chime. Chatbots can only be used in chat rooms created by members of your account. Only chat room administrators can add chatbots to a chat room. After a chatbot is added to a chat room, members of the chat room can interact with the bot using commands provided by the bot creator. For more information, see Using chatbots in the Amazon Chime User Guide.

You can also use the Amazon Chime API operation to enable or stop chatbots for your Amazon Chime account. For more information, see Update chatbots.

Note

You can't delete chatbots. To stop a chatbot from being used in your account, use the Amazon Chime UpdateBot API operation in the Amazon Chime API Reference. When you stop a chatbot, chat room administrators can remove it from a chat room, but they cannot add it to a chat room. Users who @mention a stopped chatbot in a chat room receive an error message.

Before you start the procedure to integrate chatbots with Amazon Chime, complete the following prerequisites:

  • Create a chatbot.

  • Create the outbound endpoint for Amazon Chime to send events to your bot. Choose from an AWS Lambda function ARN or an HTTPS endpoint. For more information about Lambda, see the AWS Lambda Developer Guide.

We recommend the following best practices when assigning DNS for your HTTPS endpoint:

  • Use a DNS subdomain that is dedicated to the bot endpoint.

  • Use only A-records to point to the bot endpoint.

  • Protect your DNS servers and DNS registrar account to prevent domain hijacking.

  • Use publicly valid TLS intermediate certificates that are dedicated to the bot endpoint.

  • Cryptographically verify the bot message signature before acting on a bot message.

After creating your chatbot, use the AWS Command Line Interface (AWS CLI) or the Amazon Chime API operation to complete the tasks described in the following sections.