Amazon Chime
Most of these APIs are no longer supported and will not be updated. We recommend using the latest versions in the Amazon Chime SDK API reference , in the…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Most of these APIs are no longer supported and will not be updated. We recommend using the latest versions in the
Amazon Chime SDK API reference , in the Amazon Chime SDK.
Using the latest versions requires migrating to dedicated namespaces. For more information, refer to
Migrating from the Amazon Chime namespace in the
Amazon Chime SDK Developer Guide .
The Amazon Chime application programming interface (API) is designed so administrators can
perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice
Connectors. This guide provides detailed information about the Amazon Chime API,
including operations, types, inputs and outputs, and error codes.
You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls for Amazon Chime. We recommend using an AWS SDK or the
AWS CLI. The page for each API action contains a See Also section that includes links to information about using the action with a language-specific
AWS SDK or the AWS CLI.
Using an AWS SDK
You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the
AWS Developer Center .
Using the AWS CLI
Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see
Installing the AWS Command Line Interface
in the AWS Command Line Interface User Guide . For a list of available Amazon Chime commands, see the
Amazon Chime commands in the
AWS CLI Command Reference .
Using REST APIs
If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports Signature Version 4. For more information, see
Signature Version 4 Signing Process
in the Amazon Web Services General Reference .
When making REST API calls, use the service name chime and REST endpoint https://service.chime.aws.amazon.com .
Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see
Identity and Access Management for Amazon Chime
in the Amazon Chime Administration Guide .
Endpoints 48
- GETGet user
/accounts/:AccountId/users/:UserIdRetrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN. To retrieve user details with an email… - POSTUpdate user
/accounts/:AccountId/users/:UserIdUpdates user details for a specified user ID. Currently, only LicenseType updates are supported for this action. - GETGet account
/accounts/:AccountIdRetrieves details for the specified Amazon Chime account, such as account type and supported licenses. - POSTUpdate account
/accounts/:AccountIdUpdates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action. - DELETEDelete account
/accounts/:AccountIdDeletes the specified Amazon Chime account. You must suspend all users before deleting Team account. You can use the BatchSuspendUser action to dodo. For… - GETList room memberships
/accounts/:AccountId/rooms/:RoomId/memberships?max-results=0&next-token=stringLists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names. - POSTCreate room membership
/accounts/:AccountId/rooms/:RoomId/membershipsAdds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a… - GETList phone numbers
/phone-numbers?status=string&product-type=string&filter-name=string&filter-value=string&max-results=0&next-token=stringLists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group. - POSTBatch update phone number
/phone-numbers?operation=batch-updateUpdates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem . For example, you can… - GETList users
/accounts/:AccountId/users?user-email=string&user-type=string&max-results=0&next-token=stringLists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to. - POSTInvite users
/accounts/:AccountId/users?operation=addSends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action. - GETList accounts
/accounts?name=string&user-email=string&next-token=string&max-results=0Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account… - POSTCreate account
/accountsCreates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information… - GETList bots
/accounts/:AccountId/bots?max-results=0&next-token=stringLists the bots associated with the administrator's Amazon Chime Enterprise account ID. - POSTCreate bot
/accounts/:AccountId/botsCreates a bot for an Amazon Chime Enterprise account. - POSTCreate meeting dial out
/meetings/:MeetingId/dial-outsUses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone… - GETList phone number orders
/phone-number-orders?next-token=string&max-results=0Lists the phone number orders for the administrator's Amazon Chime account. - POSTCreate phone number order
/phone-number-ordersCreates an order for phone numbers to be provisioned. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers… - GETList rooms
/accounts/:AccountId/rooms?member-id=string&max-results=0&next-token=stringLists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of… - POSTCreate room
/accounts/:AccountId/roomsCreates a chat room for the specified Amazon Chime Enterprise account. - GETGet events configuration
/accounts/:AccountId/bots/:BotId/events-configurationGets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN. - PUTPut events configuration
/accounts/:AccountId/bots/:BotId/events-configurationCreates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN.… - DELETEDelete events configuration
/accounts/:AccountId/bots/:BotId/events-configurationDeletes the events configuration that allows a bot to receive outgoing events. - GETGet phone number
/phone-numbers/:PhoneNumberIdRetrieves details for the specified phone number ID, such as associations, capabilities, and product type. - POSTUpdate phone number
/phone-numbers/:PhoneNumberIdUpdates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For… - DELETEDelete phone number
/phone-numbers/:PhoneNumberIdMoves the specified phone number into the Deletion queue . A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can… - GETGet room
/accounts/:AccountId/rooms/:RoomIdRetrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account. - POSTUpdate room
/accounts/:AccountId/rooms/:RoomIdUpdates room details, such as the room name, for a room in an Amazon Chime Enterprise account. - DELETEDelete room
/accounts/:AccountId/rooms/:RoomIdDeletes a chat room in an Amazon Chime Enterprise account. - POSTUpdate room membership
/accounts/:AccountId/rooms/:RoomId/memberships/:MemberIdUpdates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a… - DELETEDelete room membership
/accounts/:AccountId/rooms/:RoomId/memberships/:MemberIdRemoves a member from a chat room in an Amazon Chime Enterprise account. - GETGet account settings
/accounts/:AccountId/settingsRetrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings. For more information about these settings,… - PUTUpdate account settings
/accounts/:AccountId/settingsUpdates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For… - GETGet bot
/accounts/:AccountId/bots/:BotIdRetrieves details for the specified bot, such as bot email address, bot type, status, and display name. - POSTUpdate bot
/accounts/:AccountId/bots/:BotIdUpdates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account. - GETGet global settings
/settingsRetrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings. - PUTUpdate global settings
/settingsUpdates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings. - GETGet phone number order
/phone-number-orders/:PhoneNumberOrderIdRetrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status. - GETGet phone number settings
/settings/phone-numberRetrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name. - PUTUpdate phone number settings
/settings/phone-numberUpdates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling… - GETGet retention settings
/accounts/:AccountId/retention-settingsGets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention… - PUTPut retention settings
/accounts/:AccountId/retention-settingsPuts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account.… - GETGet user settings
/accounts/:AccountId/users/:UserId/settingsRetrieves settings for the specified user ID, such as any associated phone number settings. - PUTUpdate user settings
/accounts/:AccountId/users/:UserId/settingsUpdates the settings for the specified user, such as phone number settings. - GETList supported phone number countries
/phone-number-countries?product-type=stringLists supported phone number countries. - POSTRedact conversation message
/accounts/:AccountId/conversations/:ConversationId/messages/:MessageId?operation=redactRedacts the specified message from the specified Amazon Chime conversation. - POSTRedact room message
/accounts/:AccountId/rooms/:RoomId/messages/:MessageId?operation=redactRedacts the specified message from the specified Amazon Chime channel. - GETSearch available phone numbers
/search?type=phone-numbers&area-code=string&city=string&country=string&state=string&toll-free-prefix=string&phone-number-type=string&max-results=0&next-token=stringSearches for phone numbers that can be ordered. For US numbers, provide at least one of the following search filters: AreaCode , City , State , or…
API details
- Base URL
https://chime.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 48 operations on 25 pathsGET 21POST 16PUT 6DELETE 5
- Description format
- AWS Smithy model, API version
2018-05-01 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Chime in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Chime collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get user” (GET /accounts/:AccountId/users/:UserId), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Chime?
Most of these APIs are no longer supported and will not be updated. We recommend using the latest versions in the Amazon Chime SDK API reference , in the… It is listed under Communication and has 48 endpoints.
Who publishes the Amazon Chime?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Chime?
Requests go to https://chime.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Chime?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Chime have?
48 operations on 25 paths (21 GET, 16 POST, 6 PUT, 5 DELETE).
Is forking the Amazon Chime free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.