integrations.sh
← all integrations

amazonaws.com – chime

OpenAPI apis-guru cloud

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 .

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 in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the 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 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 in the Amazon Chime Administration Guide.

Homepage
https://api.apis.guru/v2/specs/amazonaws.com:chime/2018-05-01.json
Provider
amazonaws.com:chime / chime
OpenAPI version
3.0.0
Spec (JSON)
https://api.apis.guru/v2/specs/amazonaws.com/chime/2018-05-01/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/amazonaws.com/chime/2018-05-01/openapi.yaml

Tools (193)

Extracted live via the executor SDK.

  • accounts.associatePhoneNumberWithUser

    Associates a phone number with the specified Amazon Chime user.

  • accounts.associateSigninDelegateGroupsWithAccount

    Associates the specified sign-in delegate groups with the specified Amazon Chime account.

  • accounts.batchCreateRoomMembership

    Adds 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.

  • accounts.batchSuspendUser

    Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see 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 [blocked] 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 [blocked] action.

    To sign out users without suspending them, use the LogoutUser [blocked] action.

  • accounts.batchUnsuspendUser

    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 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.

  • accounts.batchUpdateUser

    Updates user details within the UpdateUserRequestItem [blocked] object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.

  • accounts.createAccount

    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 in the Amazon Chime Administration Guide.

  • accounts.createBot

    Creates a bot for an Amazon Chime Enterprise account.

  • accounts.createRoom

    Creates a chat room for the specified Amazon Chime Enterprise account.

  • accounts.createRoomMembership

    Adds 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.

  • accounts.createUser

    Creates a user under the specified Amazon Chime account.

  • accounts.deleteAccount

    Deletes the specified Amazon Chime account. You must suspend all users before deleting Team account. You can use the BatchSuspendUser [blocked] 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.

  • accounts.deleteEventsConfiguration

    Deletes the events configuration that allows a bot to receive outgoing events.

  • accounts.deleteRoom

    Deletes a chat room in an Amazon Chime Enterprise account.

  • accounts.deleteRoomMembership

    Removes a member from a chat room in an Amazon Chime Enterprise account.

  • accounts.disassociatePhoneNumberFromUser

    Disassociates the primary provisioned phone number from the specified Amazon Chime user.

  • accounts.disassociateSigninDelegateGroupsFromAccount

    Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.

  • accounts.getAccount

    Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.

  • accounts.getAccountSettings

    Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings. For more information about these settings, see in the Amazon Chime Administration Guide.

  • accounts.getBot

    Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.

  • accounts.getEventsConfiguration

    Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.

  • accounts.getRetentionSettings

    Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see in the Amazon Chime Administration Guide.

  • accounts.getRoom

    Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.

  • accounts.getUser

    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 [blocked] action, and then filter by email address.

  • accounts.getUserSettings

    Retrieves settings for the specified user ID, such as any associated phone number settings.

  • accounts.inviteUsers

    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.

  • accounts.listAccounts

    Lists 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.

  • accounts.listBots

    Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

  • accounts.listRoomMemberships

    Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.

  • accounts.listRooms

    Lists 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.

  • accounts.listUsers

    Lists 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.

  • accounts.logoutUser

    Logs out the specified user from all of the devices they are currently logged into.

  • accounts.putEventsConfiguration

    Creates 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 [blocked].

  • accounts.putRetentionSettings

    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 in the Amazon Chime Administration Guide.

    To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see in the Amazon Chime Administration Guide.

  • accounts.redactConversationMessage

    Redacts the specified message from the specified Amazon Chime conversation.

  • accounts.redactRoomMessage

    Redacts the specified message from the specified Amazon Chime channel.

  • accounts.regenerateSecurityToken

    Regenerates the security token for a bot.

  • accounts.resetPersonalPin

    Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User [blocked] object with the updated personal meeting PIN.

  • accounts.updateAccount

    Updates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.

  • accounts.updateAccountSettings

    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 in the Amazon Chime Administration Guide.

  • accounts.updateBot

    Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.

  • accounts.updateRoom

    Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.

  • accounts.updateRoomMembership

    Updates 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.

  • accounts.updateUser

    Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.

  • accounts.updateUserSettings

    Updates the settings for the specified user, such as phone number settings.

  • appInstances.createAppInstance

    Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.

  • appInstances.createAppInstanceAdmin

    Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the following actions.

    • ChannelModerator actions across all channels in the AppInstance.

    • DeleteChannelMessage actions.

    Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.

  • appInstances.deleteAppInstance

    Deletes an AppInstance and all associated data asynchronously.

  • appInstances.deleteAppInstanceAdmin

    Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user.

  • appInstances.deleteAppInstanceStreamingConfigurations

    Deletes the streaming configurations of an AppInstance.

  • appInstances.describeAppInstance

    Returns the full details of an AppInstance.

  • appInstances.describeAppInstanceAdmin

    Returns the full details of an AppInstanceAdmin.

  • appInstances.getAppInstanceRetentionSettings

    Gets the retention settings for an AppInstance.

  • appInstances.getAppInstanceStreamingConfigurations

    Gets the streaming settings for an AppInstance.

  • appInstances.listAppInstanceAdmins

    Returns a list of the administrators in the AppInstance.

  • appInstances.listAppInstances

    Lists all Amazon Chime AppInstances created under a single AWS account.

  • appInstances.putAppInstanceRetentionSettings

    Sets the amount of time in days that a given AppInstance retains data.

  • appInstances.putAppInstanceStreamingConfigurations

    The data streaming configurations of an AppInstance.

  • appInstances.updateAppInstance

    Updates AppInstance metadata.

  • appInstanceUsers.createAppInstanceUser

    Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.

  • appInstanceUsers.deleteAppInstanceUser

    Deletes an AppInstanceUser.

  • appInstanceUsers.describeAppInstanceUser

    Returns the full details of an AppInstanceUser.

  • appInstanceUsers.updateAppInstanceUser

    Updates the details of an AppInstanceUser. You can update names and metadata.

  • appInstanceUsersAppInstanceArn.listAppInstanceUsers

    List all AppInstanceUsers created under a single AppInstance.

  • channels.batchCreateChannelMembership

    Adds a specified number of users to a channel.

  • channels.createChannel

    Creates a channel to which you can add users and send messages.

    Restriction: You can't change a channel's privacy.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channels.createChannelBan

    Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels.

    If you ban a user who is already part of a channel, that user is automatically kicked from the channel.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channels.createChannelMembership

    Adds a user to a channel. The InvitedBy response field is derived from the request header. A channel member can:

    • List messages

    • Send messages

    • Receive messages

    • Edit their own messages

    • Leave the channel

    Privacy settings impact this action as follows:

    • Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.

    • Private Channels: You must be a member to list or send messages.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channels.createChannelModerator

    Creates a new ChannelModerator. A channel moderator can:

    • Add and remove other members of the channel.

    • Add and remove other moderators of the channel.

    • Add and remove user bans for the channel.

    • Redact messages in the channel.

    • List messages in the channel.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channels.deleteChannel

    Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channels.deleteChannelBan

    Removes a user from a channel's ban list.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channels.deleteChannelMembership

    Removes a member from a channel.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channels.deleteChannelMessage

    Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channels.deleteChannelModerator

    Deletes a channel moderator.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channels.describeChannel

    Returns the full details of a channel in an Amazon Chime AppInstance.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channels.describeChannelBan

    Returns the full details of a channel ban.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channels.describeChannelMembership

    Returns the full details of a user's channel membership.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channels.describeChannelMembershipForAppInstanceUser

    Returns the details of a channel based on the membership of the specified AppInstanceUser.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channels.describeChannelModeratedByAppInstanceUser

    Returns the full details of a channel moderated by the specified AppInstanceUser.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channels.describeChannelModerator

    Returns the full details of a single ChannelModerator.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channels.getChannelMessage

    Gets the full details of a channel message.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channels.listChannelBans

    Lists all the users banned from a particular channel.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channels.listChannelMemberships

    Lists all channel memberships in a channel.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channels.listChannelMessages

    List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order.

    Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.

    Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channels.listChannelModerators

    Lists all the moderators for a channel.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channels.redactChannelMessage

    Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channels.sendChannelMessage

    Sends a message to a particular channel that the member is a part of.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

    Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata.

  • channels.updateChannel

    Update a channel's attributes.

    Restriction: You can't change a channel's privacy.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channels.updateChannelMessage

    Updates the content of a message.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channels.updateChannelReadMarker

    The details of the time when a user last read messages in a channel.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channelsAppInstanceArn.listChannels

    Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.

    Functionality & restrictions

    • Use privacy = PUBLIC to retrieve all public channels in the account.

    • Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channelsScopeAppInstanceUserMemberships.listChannelMembershipsForAppInstanceUser

    Lists all channels that a particular AppInstanceUser is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • channelsScopeAppInstanceUserModeratedChannels.listChannelsModeratedByAppInstanceUser

    A list of the channels moderated by an AppInstanceUser.

    The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

  • emergencyCalling.validateE911Address

    Validates an address to be used for 911 calls made with Amazon Chime Voice Connectors. You can use validated addresses in a Presence Information Data Format Location Object file that you include in SIP requests. That helps ensure that addresses are routed to the appropriate Public Safety Answering Point.

  • endpoints.getMessagingSessionEndpoint

    The details of the endpoint for the messaging session.

  • mediaCapturePipelines.createMediaCapturePipeline

    Creates a media capture pipeline.

  • mediaCapturePipelines.deleteMediaCapturePipeline

    Deletes the media capture pipeline.

  • mediaCapturePipelines.getMediaCapturePipeline

    Gets an existing media capture pipeline.

  • mediaCapturePipelines.listMediaCapturePipelines

    Returns a list of media capture pipelines.

  • meetings.batchCreateAttendee

    Creates up to 100 new attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see in the Amazon Chime SDK Developer Guide.

  • meetings.createAttendee

    Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see in the Amazon Chime SDK Developer Guide.

  • meetings.createMeeting

    Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see in the Amazon Chime SDK Developer Guide . For more information about the Amazon Chime SDK, see in the Amazon Chime SDK Developer Guide .

  • meetings.createMeetingDialOut

    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.

  • meetings.deleteAttendee

    Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see in the Amazon Chime SDK Developer Guide.

  • meetings.deleteMeeting

    Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see in the Amazon Chime SDK Developer Guide.

  • meetings.getAttendee

    Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see in the Amazon Chime SDK Developer Guide .

  • meetings.getMeeting

    Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see in the Amazon Chime SDK Developer Guide .

  • meetings.listAttendees

    Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see in the Amazon Chime SDK Developer Guide.

  • meetings.listAttendeeTags

    Lists the tags applied to an Amazon Chime SDK attendee resource.

  • meetings.listMeetings

    Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see in the Amazon Chime SDK Developer Guide.

  • meetings.listMeetingTags

    Lists the tags applied to an Amazon Chime SDK meeting resource.

  • meetings.startMeetingTranscription

    Starts transcription for the specified meetingId. For more information, refer to in the Amazon Chime SDK Developer Guide.

    If you specify an invalid configuration, a TranscriptFailed event will be sent with the contents of the BadRequestException generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the API in the Amazon Transcribe Developer Guide.

    Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the , including the terms specific to the AWS Machine Learning and Artificial Intelligence Services.

  • meetings.stopMeetingTranscription

    Stops transcription for the specified meetingId.

  • meetings.tagAttendee

    Applies the specified tags to the specified Amazon Chime SDK attendee.

  • meetings.tagMeeting

    Applies the specified tags to the specified Amazon Chime SDK meeting.

  • meetings.untagAttendee

    Untags the specified tags from the specified Amazon Chime SDK attendee.

  • meetings.untagMeeting

    Untags the specified tags from the specified Amazon Chime SDK meeting.

  • meetingsOperationCreateAttendees.createMeetingWithAttendees

    Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see in the Amazon Chime SDK Developer Guide . For more information about the Amazon Chime SDK, see in the Amazon Chime SDK Developer Guide .

  • phoneNumberCountriesProductType.listSupportedPhoneNumberCountries

    Lists supported phone number countries.

  • phoneNumberOrders.createPhoneNumberOrder

    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.

  • phoneNumberOrders.getPhoneNumberOrder

    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.

  • phoneNumberOrders.listPhoneNumberOrders

    Lists the phone number orders for the administrator's Amazon Chime account.

  • phoneNumbers.deletePhoneNumber

    Moves 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 for 7 days before they are deleted permanently.

  • phoneNumbers.getPhoneNumber

    Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

  • phoneNumbers.listPhoneNumbers

    Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.

  • phoneNumbers.restorePhoneNumber

    Moves a phone number from the Deletion queue back into the phone number Inventory.

  • phoneNumbers.updatePhoneNumber

    Updates 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.

  • phoneNumbersOperationBatchDelete.batchDeletePhoneNumber

    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.

  • phoneNumbersOperationBatchUpdate.batchUpdatePhoneNumber

    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.

  • searchTypePhoneNumbers.searchAvailablePhoneNumbers

    Searches 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.

  • settings.getGlobalSettings

    Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

  • settings.getPhoneNumberSettings

    Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

  • settings.updateGlobalSettings

    Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

  • settings.updatePhoneNumberSettings

    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.

  • sipMediaApplications.createSipMediaApplication

    Creates a SIP media application.

  • sipMediaApplications.createSipMediaApplicationCall

    Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.

  • sipMediaApplications.deleteSipMediaApplication

    Deletes a SIP media application.

  • sipMediaApplications.getSipMediaApplication

    Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

  • sipMediaApplications.getSipMediaApplicationLoggingConfiguration

    Returns the logging configuration for the specified SIP media application.

  • sipMediaApplications.listSipMediaApplications

    Lists the SIP media applications under the administrator's AWS account.

  • sipMediaApplications.putSipMediaApplicationLoggingConfiguration

    Updates the logging configuration for the specified SIP media application.

  • sipMediaApplications.updateSipMediaApplication

    Updates the details of the specified SIP media application.

  • sipMediaApplications.updateSipMediaApplicationCall

    Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request. The Lambda function can then return a new set of actions.

  • sipRules.createSipRule

    Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.

  • sipRules.deleteSipRule

    Deletes a SIP rule. You must disable a SIP rule before you can delete it.

  • sipRules.getSipRule

    Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

  • sipRules.listSipRules

    Lists the SIP rules under the administrator's AWS account.

  • sipRules.updateSipRule

    Updates the details of the specified SIP rule.

  • tagsArn.listTagsForResource

    Lists the tags applied to an Amazon Chime SDK meeting resource.

  • tagsOperationTagResource.tagResource

    Applies the specified tags to the specified Amazon Chime SDK meeting resource.

  • tagsOperationUntagResource.untagResource

    Untags the specified tags from the specified Amazon Chime SDK meeting resource.

  • voiceConnectorGroups.associatePhoneNumbersWithVoiceConnectorGroup

    Associates phone numbers with the specified Amazon Chime Voice Connector group.

  • voiceConnectorGroups.createVoiceConnectorGroup

    Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems in the request.

    You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

  • voiceConnectorGroups.deleteVoiceConnectorGroup

    Deletes the specified Amazon Chime Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.

  • voiceConnectorGroups.disassociatePhoneNumbersFromVoiceConnectorGroup

    Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.

  • voiceConnectorGroups.getVoiceConnectorGroup

    Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.

  • voiceConnectorGroups.listVoiceConnectorGroups

    Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.

  • voiceConnectorGroups.updateVoiceConnectorGroup

    Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.

  • voiceConnectors.associatePhoneNumbersWithVoiceConnector

    Associates phone numbers with the specified Amazon Chime Voice Connector.

  • voiceConnectors.createProxySession

    Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.

  • voiceConnectors.createVoiceConnector

    Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region.

    Enabling CreateVoiceConnectorRequest$RequireEncryption [blocked] configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.

  • voiceConnectors.deleteProxySession

    Deletes the specified proxy session from the specified Amazon Chime Voice Connector.

  • voiceConnectors.deleteVoiceConnector

    Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the Amazon Chime Voice Connector must be disassociated from it before it can be deleted.

  • voiceConnectors.deleteVoiceConnectorEmergencyCallingConfiguration

    Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.

  • voiceConnectors.deleteVoiceConnectorOrigination

    Deletes the origination settings for the specified Amazon Chime Voice Connector.

    If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the origination settings.

  • voiceConnectors.deleteVoiceConnectorProxy

    Deletes the proxy configuration from the specified Amazon Chime Voice Connector.

  • voiceConnectors.deleteVoiceConnectorStreamingConfiguration

    Deletes the streaming configuration for the specified Amazon Chime Voice Connector.

  • voiceConnectors.deleteVoiceConnectorTermination

    Deletes the termination settings for the specified Amazon Chime Voice Connector.

    If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the termination settings.

  • voiceConnectors.deleteVoiceConnectorTerminationCredentials

    Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

  • voiceConnectors.disassociatePhoneNumbersFromVoiceConnector

    Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.

  • voiceConnectors.getProxySession

    Gets the specified proxy session details for the specified Amazon Chime Voice Connector.

  • voiceConnectors.getVoiceConnector

    Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.

  • voiceConnectors.getVoiceConnectorEmergencyCallingConfiguration

    Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.

  • voiceConnectors.getVoiceConnectorLoggingConfiguration

    Retrieves the logging configuration details for the specified Amazon Chime Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

  • voiceConnectors.getVoiceConnectorOrigination

    Retrieves origination setting details for the specified Amazon Chime Voice Connector.

  • voiceConnectors.getVoiceConnectorProxy

    Gets the proxy configuration details for the specified Amazon Chime Voice Connector.

  • voiceConnectors.getVoiceConnectorStreamingConfiguration

    Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

  • voiceConnectors.getVoiceConnectorTermination

    Retrieves termination setting details for the specified Amazon Chime Voice Connector.

  • voiceConnectors.getVoiceConnectorTerminationHealth

    Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.

  • voiceConnectors.listProxySessions

    Lists the proxy sessions for the specified Amazon Chime Voice Connector.

  • voiceConnectors.listVoiceConnectors

    Lists the Amazon Chime Voice Connectors for the administrator's AWS account.

  • voiceConnectors.listVoiceConnectorTerminationCredentials

    Lists the SIP credentials for the specified Amazon Chime Voice Connector.

  • voiceConnectors.putVoiceConnectorEmergencyCallingConfiguration

    Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries. Origination and termination settings must be enabled for the Amazon Chime Voice Connector before emergency calling can be configured.

  • voiceConnectors.putVoiceConnectorLoggingConfiguration

    Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

  • voiceConnectors.putVoiceConnectorOrigination

    Adds origination settings for the specified Amazon Chime Voice Connector.

    If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off origination settings.

  • voiceConnectors.putVoiceConnectorProxy

    Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.

  • voiceConnectors.putVoiceConnectorStreamingConfiguration

    Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data.

  • voiceConnectors.putVoiceConnectorTermination

    Adds termination settings for the specified Amazon Chime Voice Connector.

    If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off termination settings.

  • voiceConnectors.putVoiceConnectorTerminationCredentials

    Adds termination SIP credentials for the specified Amazon Chime Voice Connector.

  • voiceConnectors.updateProxySession

    Updates the specified proxy session details, such as voice or SMS capabilities.

  • voiceConnectors.updateVoiceConnector

    Updates details for the specified Amazon Chime Voice Connector.

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools