View Source AWS.Chime (aws-elixir v1.0.7)
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.
definitions
Definitions
using-an-aws-sdk
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
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
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.
Link to this section Summary
Functions
Associates a phone number with the specified Amazon Chime user.
Associates the specified sign-in delegate groups with the specified Amazon Chime account.
Adds up to 50 members to a chat room in an Amazon Chime Enterprise account.
Moves phone numbers into the Deletion queue.
Suspends up to 50 users from a Team
or EnterpriseLWA
Amazon Chime
account.
Removes the suspension from up to 50 previously suspended users for the
specified Amazon
Chime EnterpriseLWA
account.
Updates phone number product types or calling names.
Updates user details within the UpdateUserRequestItem
object for up to 20
users for the specified Amazon Chime account.
Creates an Amazon Chime account under the administrator's AWS account.
Creates a bot for an Amazon Chime Enterprise account.
Uses 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 network (PSTN) and join them into a Chime meeting.
Creates an order for phone numbers to be provisioned.
Creates a chat room for the specified Amazon Chime Enterprise account.
Adds a member to a chat room in an Amazon Chime Enterprise account.
Creates a user under the specified Amazon Chime account.
Deletes the specified Amazon Chime account.
Deletes the events configuration that allows a bot to receive outgoing events.
Moves the specified phone number into the Deletion queue.
Deletes a chat room in an Amazon Chime Enterprise account.
Removes a member from a chat room in an Amazon Chime Enterprise account.
Disassociates the primary provisioned phone number from the specified Amazon Chime user.
Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings.
Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
Gets the retention settings for the specified Amazon Chime Enterprise account.
Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.
Retrieves settings for the specified user ID, such as any associated phone number settings.
Sends email to a maximum of 50 users, inviting them to the specified Amazon
Chime
Team
account.
Lists the Amazon Chime accounts under the administrator's AWS account.
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
Lists the phone number orders for the administrator's Amazon Chime account.
Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.
Lists the room details for the specified Amazon Chime Enterprise account.
Lists supported phone number countries.
Lists the users that belong to the specified Amazon Chime account.
Logs out the specified user from all of the devices they are currently logged into.
Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime.
Puts retention settings for the specified Amazon Chime Enterprise account.
Redacts the specified message from the specified Amazon Chime conversation.
Redacts the specified message from the specified Amazon Chime channel.
Regenerates the security token for a bot.
Resets the personal meeting PIN for the specified user on an Amazon Chime account.
Moves a phone number from the Deletion queue back into the phone number Inventory.
Searches for phone numbers that can be ordered.
Updates account details for the specified Amazon Chime account.
Updates the settings for the specified Amazon Chime account.
Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
Updates phone number details, such as product type or calling name, for the specified phone number ID.
Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name.
Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account.
Updates user details for a specified user ID.
Updates the settings for the specified user, such as phone number settings.
Link to this section Functions
associate_phone_number_with_user(client, account_id, user_id, input, options \\ [])
View SourceAssociates a phone number with the specified Amazon Chime user.
associate_signin_delegate_groups_with_account(client, account_id, input, options \\ [])
View SourceAssociates the specified sign-in delegate groups with the specified Amazon Chime account.
batch_create_room_membership(client, account_id, room_id, input, options \\ [])
View SourceAdds up to 50 members to a chat room in an Amazon Chime Enterprise account.
Members can be users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.
Moves phone numbers into the Deletion queue.
Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.
Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
Suspends up to 50 users from a Team
or EnterpriseLWA
Amazon Chime
account.
For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
Users suspended from a Team
account are disassociated from the account,but
they
can continue to use Amazon Chime as free users. To remove the suspension from
suspended
Team
account users, invite them to the Team
account again.
You can use the InviteUsers
action to do so.
Users suspended from an EnterpriseLWA
account are immediately signed out of
Amazon Chime and can no longer sign in. To remove the suspension from suspended
EnterpriseLWA
account users, use the
BatchUnsuspendUser
action.
To sign out users without suspending them, use the
LogoutUser
action.
Removes the suspension from up to 50 previously suspended users for the
specified Amazon
Chime EnterpriseLWA
account.
Only users on EnterpriseLWA
accounts can be unsuspended using this action. For more information about
different account types, see
Managing Your Amazon Chime Accounts
in the
account types, in the Amazon Chime Administration Guide.
Previously suspended users who are unsuspended using this action are returned to
Registered
status. Users who are not previously suspended are ignored.
Updates phone number product types or calling names.
You can update one attribute at a time for each UpdatePhoneNumberRequestItem
.
For example, you can update the product type or the calling name.
For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
Updates user details within the UpdateUserRequestItem
object for up to 20
users for the specified Amazon Chime account.
Currently, only LicenseType
updates are supported for this action.
Creates an Amazon Chime account under the administrator's AWS account.
Only Team
account types are currently supported for this action. For more information
about different account types, see
Managing Your Amazon Chime Accounts
in the Amazon Chime
Administration Guide.
Creates a bot for an Amazon Chime Enterprise account.
Uses 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 network (PSTN) and join them into a Chime meeting.
Also ensures that the From number belongs to the customer.
To play welcome audio or implement an interactive voice response (IVR), use the
CreateSipMediaApplicationCall
action with the corresponding SIP media
application ID.
this-api-is-not-available-in-a-dedicated-namespace
This API is not available in a dedicated namespace.
Creates an order for phone numbers to be provisioned.
For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
Creates a chat room for the specified Amazon Chime Enterprise account.
create_room_membership(client, account_id, room_id, input, options \\ [])
View SourceAdds 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 chat room administrator or a general chat room member.
Creates a user under the specified Amazon Chime account.
Deletes the specified Amazon Chime account.
You must suspend all users before deleting
Team
account. You can use the BatchSuspendUser
action
to dodo.
For EnterpriseLWA
and EnterpriseAD
accounts, you must release the
claimed domains for your Amazon Chime account before deletion. As soon as you
release
the domain, all users under that account are suspended.
Deleted accounts appear in your Disabled
accounts list for 90 days. To restore
deleted account from your Disabled
accounts list, you must contact AWS
Support.
After 90 days, deleted accounts are permanently removed from your
Disabled
accounts list.
delete_events_configuration(client, account_id, bot_id, input, options \\ [])
View SourceDeletes the events configuration that allows a bot to receive outgoing events.
delete_phone_number(client, phone_number_id, input, options \\ [])
View SourceMoves 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 be deleted.
Deleted phone numbers remain in the
deletion-queue
Deletion queue
for 7 days before they are deleted permanently.
Deletes a chat room in an Amazon Chime Enterprise account.
delete_room_membership(client, account_id, member_id, room_id, input, options \\ [])
View SourceRemoves a member from a chat room in an Amazon Chime Enterprise account.
disassociate_phone_number_from_user(client, account_id, user_id, input, options \\ [])
View SourceDisassociates the primary provisioned phone number from the specified Amazon Chime user.
disassociate_signin_delegate_groups_from_account(client, account_id, input, options \\ [])
View SourceDisassociates the specified sign-in delegate groups from the specified Amazon Chime account.
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings.
For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
get_events_configuration(client, account_id, bot_id, options \\ [])
View SourceGets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
get_phone_number_order(client, phone_number_order_id, options \\ [])
View SourceRetrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
Gets the retention settings for the specified Amazon Chime Enterprise account.
For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.
To retrieve user details with an email address instead of a user ID, use the
ListUsers
action, and then filter by email address.
Retrieves settings for the specified user ID, such as any associated phone number settings.
Sends 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.
list_accounts(client, max_results \\ nil, name \\ nil, next_token \\ nil, user_email \\ nil, options \\ [])
View SourceLists 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 a user belongs to, you can filter by the user's email address, which returns one account result.
list_bots(client, account_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the bots associated with the administrator's Amazon Chime Enterprise account ID.
list_phone_number_orders(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the phone number orders for the administrator's Amazon Chime account.
list_phone_numbers(client, filter_name \\ nil, filter_value \\ nil, max_results \\ nil, next_token \\ nil, product_type \\ nil, status \\ nil, options \\ [])
View SourceLists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
list_room_memberships(client, account_id, room_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.
list_rooms(client, account_id, max_results \\ nil, member_id \\ nil, next_token \\ nil, options \\ [])
View SourceLists 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 rooms that the member belongs to.
list_supported_phone_number_countries(client, product_type, options \\ [])
View SourceLists supported phone number countries.
list_users(client, account_id, max_results \\ nil, next_token \\ nil, user_email \\ nil, user_type \\ nil, options \\ [])
View SourceLists 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.
Logs out the specified user from all of the devices they are currently logged into.
put_events_configuration(client, account_id, bot_id, input, options \\ [])
View SourceCreates 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. For more information,
see Bot
.
Puts retention settings for the specified Amazon Chime Enterprise account.
We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide.
To turn off existing retention settings, remove the number of days from the corresponding
retentiondays
RetentionDays
field in the
retentionsettings
RetentionSettings
object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
redact_conversation_message(client, account_id, conversation_id, message_id, input, options \\ [])
View SourceRedacts the specified message from the specified Amazon Chime conversation.
redact_room_message(client, account_id, message_id, room_id, input, options \\ [])
View SourceRedacts the specified message from the specified Amazon Chime channel.
regenerate_security_token(client, account_id, bot_id, input, options \\ [])
View SourceRegenerates the security token for a bot.
reset_personal_pin(client, account_id, user_id, input, options \\ [])
View SourceResets the personal meeting PIN for the specified user on an Amazon Chime account.
Returns
the User
object with the updated personal meeting PIN.
restore_phone_number(client, phone_number_id, input, options \\ [])
View SourceMoves a phone number from the Deletion queue back into the phone number Inventory.
search_available_phone_numbers(client, area_code \\ nil, city \\ nil, country \\ nil, max_results \\ nil, next_token \\ nil, phone_number_type \\ nil, state \\ nil, toll_free_prefix \\ nil, options \\ [])
View SourceSearches for phone numbers that can be ordered.
For US numbers, provide at least one of
the following search filters: AreaCode
, City
,
State
, or TollFreePrefix
. If you provide
City
, you must also provide State
. Numbers outside the US only
support the PhoneNumberType
filter, which you must use.
Updates account details for the specified Amazon Chime account.
Currently, only account name and default license updates are supported for this action.
Updates 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 more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
update_phone_number(client, phone_number_id, input, options \\ [])
View SourceUpdates 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 example, you can update either the product type or the calling name in one action.
For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name.
You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.
Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
update_room_membership(client, account_id, member_id, room_id, input, options \\ [])
View SourceUpdates 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 chat room administrator or a general chat room member. The member role can be updated only for user IDs.
Updates user details for a specified user ID.
Currently, only LicenseType
updates are supported for this action.
update_user_settings(client, account_id, user_id, input, options \\ [])
View SourceUpdates the settings for the specified user, such as phone number settings.