Amazon Chime Developer Guide Amazon Chime Developer Guide Amazon Chime: Developer Guide Copyright © Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. Amazon Chime Developer Guide Table of Contents What is Amazon Chime? ..................................................................................................................... 1 Pricing ...................................................................................................................................... 1 Resources .................................................................................................................................. 1 Extending the Amazon Chime desktop client ......................................................................................... 2 User management ...................................................................................................................... 2 Invite multiple users ........................................................................................................... 2 Download user list ............................................................................................................. 2 Log out multiple users ........................................................................................................ 3 Update user personal PINs .................................................................................................. 3 Integrating chatbots ................................................................................................................... 3 Use chatbots with Amazon Chime ........................................................................................ 4 Amazon Chime events sent to chatbots .............................................................................. 10 Proxy phone sessions ................................................................................................................ 11 Webhooks ............................................................................................................................... 12 Troubleshooting webhook errors ........................................................................................ 13 Using the Amazon Chime SDK ........................................................................................................... 14 Amazon Chime SDK prerequisites ............................................................................................... 14 Amazon Chime SDK concepts .................................................................................................... 14 Amazon Chime SDK architecture ................................................................................................ 15 Amazon Chime SDK quotas ....................................................................................................... 16 Amazon Chime SDK system requirements .................................................................................... 16 Integrating with a client library .................................................................................................. 17 SIP integration ......................................................................................................................... 18 Amazon Chime SDK event notifications ....................................................................................... 19 Sending notifications to EventBridge .................................................................................. 19 Sending notifications to Amazon SQS and Amazon SNS ........................................................ 19 Granting the Amazon Chime SDK access to Amazon SQS and Amazon SNS .............................. 20 Amazon Chime SDK meetings ............................................................................................................ 22 Creating Meetings .................................................................................................................... 22 Media Regions ......................................................................................................................... 23 Choosing a media Region .................................................................................................. 23 Choosing the nearest media Region .................................................................................... 24 Network configuration .............................................................................................................. 25 Configuring for media and signaling ................................................................................... 25 Configuring for Amazon Voice Focus ................................................................................... 26 Creating Amazon Chime media capture pipelines ......................................................................... 26 Pipeline creation overview ................................................................................................. 26 Creating an S3 bucket ...................................................................................................... 27 Using Amazon Chime SDK live transcription ................................................................................ 27 System architecture .......................................................................................................... 28 Billing and usage .............................................................................................................. 28 Configuring your account .................................................................................................. 29 Choosing transcription options ........................................................................................... 29 Starting and stopping transcription .................................................................................... 31 Transcription parameters ................................................................................................... 34 Transcription events .......................................................................................................... 34 Transcription messages ..................................................................................................... 35 Delivery examples ............................................................................................................ 37 Using Amazon Chime SDK messaging ................................................................................................. 40 Messaging prerequisites ............................................................................................................ 40 Messaging concepts .................................................................................................................. 40 Messaging architecture .............................................................................................................. 41 Message types ......................................................................................................................... 42 Messaging quotas ..................................................................................................................... 42 iii Amazon Chime Developer Guide Getting started ........................................................................................................................ 42 Creating an AppInstance ................................................................................................... 43 Creating an AppInstanceUser ............................................................................................. 43 Making SDK calls from a backend service ............................................................................ 43 Authenticating end-user client applications ......................................................................... 45 Creating channels ............................................................................................................. 47 Sending messages ............................................................................................................ 48 Using websockets to receive messages ................................................................................ 48 Configuring attachments ................................................................................................... 51 Understanding system messages ................................................................................................ 51 Example IAM roles .................................................................................................................... 52 Understanding authorization by role ........................................................................................... 54 AppInstanceAdmin ............................................................................................................ 55 ChannelModerator ............................................................................................................ 56 Member .........................................................................................................................