- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
ChimeSDKVoiceClient
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.
Installation
npm install @aws-sdk/client-chime-sdk-voiceyarn add @aws-sdk/client-chime-sdk-voicepnpm add @aws-sdk/client-chime-sdk-voiceChimeSDKVoiceClient Operations
Command | Summary |
|---|
Command | Summary |
|---|---|
| AssociatePhoneNumbersWithVoiceConnectorCommand | Associates phone numbers with the specified Amazon Chime SDK Voice Connector. |
| AssociatePhoneNumbersWithVoiceConnectorGroupCommand | Associates phone numbers with the specified Amazon Chime SDK Voice Connector group. |
| BatchDeletePhoneNumberCommand | 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. Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently. |
| BatchUpdatePhoneNumberCommand | Updates phone number product types, calling names, or phone number names. You can update one attribute at a time for each You cannot have a duplicate |
| CreatePhoneNumberOrderCommand | 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. |
| CreateProxySessionCommand | Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers. |
| CreateSipMediaApplicationCallCommand | Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified |
| CreateSipMediaApplicationCommand | 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. |
| CreateSipRuleCommand | 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. |
| CreateVoiceConnectorCommand | 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. |
| CreateVoiceConnectorGroupCommand | 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 You can include Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events. |
| CreateVoiceProfileCommand | Creates a voice profile, which consists of an enrolled user and their latest voice print. Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK. For more information about voice profiles and voice analytics, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide. |
| CreateVoiceProfileDomainCommand | Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment audio. Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK. For more information about voice profile domains, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide. |
| DeletePhoneNumberCommand | 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. Deleted phone numbers remain in the Deletion queue queue for 7 days before they are deleted permanently. |
| DeleteProxySessionCommand | Deletes the specified proxy session from the specified Amazon Chime SDK Voice Connector. |
| DeleteSipMediaApplicationCommand | Deletes a SIP media application. |
| DeleteSipRuleCommand | Deletes a SIP rule. |
| DeleteVoiceConnectorCommand | 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. |
| DeleteVoiceConnectorEmergencyCallingConfigurationCommand | Deletes the emergency calling details from the specified Amazon Chime SDK Voice Connector. |
| DeleteVoiceConnectorExternalSystemsConfigurationCommand | Deletes the external systems configuration for a Voice Connector. |
| DeleteVoiceConnectorGroupCommand | Deletes an Amazon Chime SDK Voice Connector group. Any |
| DeleteVoiceConnectorOriginationCommand | Deletes the origination settings for the specified Amazon Chime SDK Voice Connector. If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the origination settings. |
| DeleteVoiceConnectorProxyCommand | Deletes the proxy configuration from the specified Amazon Chime SDK Voice Connector. |
| DeleteVoiceConnectorStreamingConfigurationCommand | Deletes a Voice Connector's streaming configuration. |
| DeleteVoiceConnectorTerminationCommand | Deletes the termination settings for the specified Amazon Chime SDK Voice Connector. If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the termination settings. |
| DeleteVoiceConnectorTerminationCredentialsCommand | Deletes the specified SIP credentials used by your equipment to authenticate during call termination. |
| DeleteVoiceProfileCommand | Deletes a voice profile, including its voice print and enrollment data. WARNING: This action is not reversible. |
| DeleteVoiceProfileDomainCommand | Deletes all voice profiles in the domain. WARNING: This action is not reversible. |
| DisassociatePhoneNumbersFromVoiceConnectorCommand | Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector. |
| DisassociatePhoneNumbersFromVoiceConnectorGroupCommand | Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector group. |
| GetGlobalSettingsCommand | Retrieves the global settings for the Amazon Chime SDK Voice Connectors in an AWS account. |
| GetPhoneNumberCommand | Retrieves details for the specified phone number ID, such as associations, capabilities, and product type. |
| GetPhoneNumberOrderCommand | 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. |
| GetPhoneNumberSettingsCommand | Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name. |
| GetProxySessionCommand | Retrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector. |
| GetSipMediaApplicationAlexaSkillConfigurationCommand | Gets the Alexa Skill configuration for the SIP media application. Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page. |
| GetSipMediaApplicationCommand | Retrieves the information for a SIP media application, including name, AWS Region, and endpoints. |
| GetSipMediaApplicationLoggingConfigurationCommand | Retrieves the logging configuration for the specified SIP media application. |
| GetSipRuleCommand | Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints. |
| GetSpeakerSearchTaskCommand | Retrieves the details of the specified speaker search task. |
| GetVoiceConnectorCommand | Retrieves details for the specified Amazon Chime SDK Voice Connector, such as timestamps,name, outbound host, and encryption requirements. |
| GetVoiceConnectorEmergencyCallingConfigurationCommand | Retrieves the emergency calling configuration details for the specified Voice Connector. |
| GetVoiceConnectorExternalSystemsConfigurationCommand | Gets information about an external systems configuration for a Voice Connector. |
| GetVoiceConnectorGroupCommand | Retrieves details for the specified Amazon Chime SDK Voice Connector group, such as timestamps,name, and associated |
| GetVoiceConnectorLoggingConfigurationCommand | Retrieves the logging configuration settings for the specified Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs. |
| GetVoiceConnectorOriginationCommand | Retrieves the origination settings for the specified Voice Connector. |
| GetVoiceConnectorProxyCommand | Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector. |
| GetVoiceConnectorStreamingConfigurationCommand | 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. |
| GetVoiceConnectorTerminationCommand | Retrieves the termination setting details for the specified Voice Connector. |
| GetVoiceConnectorTerminationHealthCommand | Retrieves information about the last time a |
| GetVoiceProfileCommand | Retrieves the details of the specified voice profile. |
| GetVoiceProfileDomainCommand | Retrieves the details of the specified voice profile domain. |
| GetVoiceToneAnalysisTaskCommand | Retrieves the details of a voice tone analysis task. |
| ListAvailableVoiceConnectorRegionsCommand | Lists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector. |
| ListPhoneNumberOrdersCommand | Lists the phone numbers for an administrator's Amazon Chime SDK account. |
| ListPhoneNumbersCommand | 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. |
| ListProxySessionsCommand | Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector. |
| ListSipMediaApplicationsCommand | Lists the SIP media applications under the administrator's AWS account. |
| ListSipRulesCommand | Lists the SIP rules under the administrator's AWS account. |
| ListSupportedPhoneNumberCountriesCommand | Lists the countries that you can order phone numbers from. |
| ListTagsForResourceCommand | Returns a list of the tags in a given resource. |
| ListVoiceConnectorGroupsCommand | Lists the Amazon Chime SDK Voice Connector groups in the administrator's AWS account. |
| ListVoiceConnectorTerminationCredentialsCommand | Lists the SIP credentials for the specified Amazon Chime SDK Voice Connector. |
| ListVoiceConnectorsCommand | Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account. |
| ListVoiceProfileDomainsCommand | Lists the specified voice profile domains in the administrator's AWS account. |
| ListVoiceProfilesCommand | Lists the voice profiles in a voice profile domain. |
| PutSipMediaApplicationAlexaSkillConfigurationCommand | Updates the Alexa Skill configuration for the SIP media application. Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page. |
| PutSipMediaApplicationLoggingConfigurationCommand | Updates the logging configuration for the specified SIP media application. |
| PutVoiceConnectorEmergencyCallingConfigurationCommand | Updates a Voice Connector's emergency calling configuration. |
| PutVoiceConnectorExternalSystemsConfigurationCommand | Adds an external systems configuration to a Voice Connector. |
| PutVoiceConnectorLoggingConfigurationCommand | Updates a Voice Connector's logging configuration. |
| PutVoiceConnectorOriginationCommand | Updates a Voice Connector's origination settings. |
| PutVoiceConnectorProxyCommand | Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector. |
| PutVoiceConnectorStreamingConfigurationCommand | Updates a Voice Connector's streaming configuration settings. |
| PutVoiceConnectorTerminationCommand | Updates a Voice Connector's termination settings. |
| PutVoiceConnectorTerminationCredentialsCommand | Updates a Voice Connector's termination credentials. |
| RestorePhoneNumberCommand | Restores a deleted phone number. |
| SearchAvailablePhoneNumbersCommand | Searches the provisioned phone numbers in an organization. |
| StartSpeakerSearchTaskCommand | Starts a speaker search task. Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK. |
| StartVoiceToneAnalysisTaskCommand | 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. Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK. |
| StopSpeakerSearchTaskCommand | Stops a speaker search task. |
| StopVoiceToneAnalysisTaskCommand | Stops a voice tone analysis task. |
| TagResourceCommand | Adds a tag to the specified resource. |
| UntagResourceCommand | Removes tags from a resource. |
| UpdateGlobalSettingsCommand | Updates global settings for the Amazon Chime SDK Voice Connectors in an AWS account. |
| UpdatePhoneNumberCommand | 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. For numbers outside the U.S., you must use the Amazon Chime SDK 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. |
| UpdatePhoneNumberSettingsCommand | 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. |
| UpdateProxySessionCommand | Updates the specified proxy session details, such as voice or SMS capabilities. |
| UpdateSipMediaApplicationCallCommand | 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. |
| UpdateSipMediaApplicationCommand | Updates the details of the specified SIP media application. |
| UpdateSipRuleCommand | Updates the details of the specified SIP rule. |
| UpdateVoiceConnectorCommand | Updates the details for the specified Amazon Chime SDK Voice Connector. |
| UpdateVoiceConnectorGroupCommand | Updates the settings for the specified Amazon Chime SDK Voice Connector group. |
| UpdateVoiceProfileCommand | Updates the specified voice profile’s voice print and refreshes its expiration timestamp. As a condition of using this feature, you acknowledge that the collection, use, storage, and retention of your caller’s biometric identifiers and biometric information (“biometric data”) in the form of a digital voiceprint requires the caller’s informed consent via a written release. Such consent is required under various state laws, including biometrics laws in Illinois, Texas, Washington and other state privacy laws. You must provide a written release to each caller through a process that clearly reflects each caller’s informed consent before using Amazon Chime SDK Voice Insights service, as required under the terms of your agreement with AWS governing your use of the service. |
| UpdateVoiceProfileDomainCommand | Updates the settings for the specified voice profile domain. |
| ValidateE911AddressCommand | 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. |
ChimeSDKVoiceClient Configuration
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
defaultsModeOptional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefixOptional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensionsOptional | RuntimeExtension[] | Optional extensions |
loggerOptional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttemptsOptional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profileOptional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
regionOptional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandlerOptional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryModeOptional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpointOptional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpointOptional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: ChimeSDKVoiceClientConfig