Package-level declarations

Types

Link copied to clipboard

The Amazon Chime SDK telephony APIs in this section enable developers to create PSTN calling solutions that use Amazon Chime SDK Voice Connectors, and Amazon Chime SDK SIP media applications. Developers can also order and manage phone numbers, create and manage Voice Connectors and SIP media applications, and run voice analytics.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Inherited functions

Link copied to clipboard

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

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

Link copied to clipboard

Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime SDK Voice Connectors before they can be deleted.

Link copied to clipboard

Updates phone number product types, calling names, or phone number names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update the product type, the calling name, or phone name.

Link copied to clipboard

Creates an order for phone numbers to be provisioned. For numbers outside the U.S., you must use the Amazon Chime SDK SIP media application dial-in product type.

Link copied to clipboard

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

Link copied to clipboard

Creates a SIP media application. For more information about SIP media applications, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.

Link copied to clipboard

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.

Link copied to clipboard

Creates a SIP rule, which can be used to run a SIP media application as a target for a specific trigger type. For more information about SIP rules, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.

Link copied to clipboard

Creates an Amazon Chime SDK Voice Connector. For more information about Voice Connectors, see Managing Amazon Chime SDK Voice Connector groups in the Amazon Chime SDK Administrator Guide.

Link copied to clipboard

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

Link copied to clipboard

Creates a voice profile, which consists of an enrolled user and their latest voice print.

Link copied to clipboard

Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment audio.

Link copied to clipboard

Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime SDK Voice Connectors before it can be deleted.

Link copied to clipboard

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

Link copied to clipboard

Deletes a SIP media application.

Link copied to clipboard

Deletes a SIP rule.

Link copied to clipboard

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

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

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

Link copied to clipboard

Deletes a voice profile, including its voice print and enrollment data. WARNING: This action is not reversible.

Link copied to clipboard

Deletes all voice profiles in the domain. WARNING: This action is not reversible.

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

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

Link copied to clipboard

Retrieves the global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector.

Link copied to clipboard

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

Retrieves the logging configuration for the specified SIP media application.

Link copied to clipboard

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

Link copied to clipboard

Retrieves the details of the specified speaker search task.

Link copied to clipboard

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

Retrieves the emergency calling configuration details for the specified Voice Connector.

Gets information about an external systems configuration for a Voice Connector.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Retrieves the origination settings for the specified Voice Connector.

Link copied to clipboard

Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector.

Link copied to clipboard

Retrieves the streaming configuration details for the specified Amazon Chime SDK 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.

Link copied to clipboard

Retrieves the termination setting details for the specified Voice Connector.

Link copied to clipboard

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

Link copied to clipboard

Retrieves the details of the specified voice profile.

Link copied to clipboard

Retrieves the details of the specified voice profile domain.

Link copied to clipboard

Retrieves the details of a voice tone analysis task.

Link copied to clipboard

Lists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector.

Link copied to clipboard

Lists the phone numbers for an administrator's Amazon Chime SDK account.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Lists the countries that you can order phone numbers from.

Link copied to clipboard

Returns a list of the tags in a given resource.

Link copied to clipboard

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

Link copied to clipboard

Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.

Link copied to clipboard

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

Link copied to clipboard

Lists the specified voice profile domains in the administrator's AWS account.

Link copied to clipboard

Lists the voice profiles in a voice profile domain.

Updates the logging configuration for the specified SIP media application.

Link copied to clipboard

Updates a Voice Connector's origination settings.

Link copied to clipboard

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

Link copied to clipboard

Updates a Voice Connector's streaming configuration settings.

Link copied to clipboard

Updates a Voice Connector's termination settings.

Link copied to clipboard

Restores a deleted phone number.

Link copied to clipboard

Searches the provisioned phone numbers in an organization.

Link copied to clipboard

Starts a speaker search task.

Link copied to clipboard

Starts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics in the Amazon Chime SDK Developer Guide.

Link copied to clipboard

Stops a speaker search task.

Link copied to clipboard

Stops a voice tone analysis task.

Link copied to clipboard

Adds a tag to the specified resource.

Link copied to clipboard

Removes tags from a resource.

Link copied to clipboard

Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS account.

Link copied to clipboard

Updates phone number details, such as product type, calling name, or phone number 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, calling name, or phone number name in one action.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Updates the details of the specified SIP media application.

Link copied to clipboard

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.

Link copied to clipboard

Updates the details of the specified SIP rule.

Link copied to clipboard

Updates the details for the specified Amazon Chime SDK Voice Connector.

Link copied to clipboard

Updates the settings for the specified Amazon Chime SDK Voice Connector group.

Link copied to clipboard

Updates the specified voice profile’s voice print and refreshes its expiration timestamp.

Link copied to clipboard

Updates the settings for the specified voice profile domain.

Link copied to clipboard

Validates an address to be used for 911 calls made with Amazon Chime SDK 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.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.