AWS.ChimeSDKVoice — AWS SDK for JavaScript (original) (raw)

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

associatePhoneNumbersWithVoiceConnector(params = {}, callback) ⇒ AWS.Request

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

associatePhoneNumbersWithVoiceConnectorGroup(params = {}, callback) ⇒ AWS.Request

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

batchDeletePhoneNumber(params = {}, callback) ⇒ AWS.Request

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.

batchUpdatePhoneNumber(params = {}, callback) ⇒ AWS.Request

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.

Note: You cannot have a duplicate phoneNumberId in a request.

createPhoneNumberOrder(params = {}, callback) ⇒ AWS.Request

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.

createProxySession(params = {}, callback) ⇒ AWS.Request

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

createSipMediaApplication(params = {}, callback) ⇒ AWS.Request

createSipMediaApplicationCall(params = {}, callback) ⇒ AWS.Request

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.

createSipRule(params = {}, callback) ⇒ AWS.Request

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.

createVoiceConnector(params = {}, callback) ⇒ AWS.Request

createVoiceConnectorGroup(params = {}, callback) ⇒ AWS.Request

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.

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.

createVoiceProfile(params = {}, callback) ⇒ AWS.Request

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.

createVoiceProfileDomain(params = {}, callback) ⇒ AWS.Request

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.

deletePhoneNumber(params = {}, callback) ⇒ AWS.Request

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.

deleteProxySession(params = {}, callback) ⇒ AWS.Request

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

deleteSipMediaApplication(params = {}, callback) ⇒ AWS.Request

Deletes a SIP media application.

deleteSipRule(params = {}, callback) ⇒ AWS.Request

deleteVoiceConnector(params = {}, callback) ⇒ AWS.Request

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.

deleteVoiceConnectorEmergencyCallingConfiguration(params = {}, callback) ⇒ AWS.Request

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

deleteVoiceConnectorGroup(params = {}, callback) ⇒ AWS.Request

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.

deleteVoiceConnectorOrigination(params = {}, callback) ⇒ AWS.Request

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

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

deleteVoiceConnectorProxy(params = {}, callback) ⇒ AWS.Request

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

deleteVoiceConnectorStreamingConfiguration(params = {}, callback) ⇒ AWS.Request

Deletes a Voice Connector's streaming configuration.

deleteVoiceConnectorTermination(params = {}, callback) ⇒ AWS.Request

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

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

deleteVoiceConnectorTerminationCredentials(params = {}, callback) ⇒ AWS.Request

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

deleteVoiceProfile(params = {}, callback) ⇒ AWS.Request

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

deleteVoiceProfileDomain(params = {}, callback) ⇒ AWS.Request

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

disassociatePhoneNumbersFromVoiceConnector(params = {}, callback) ⇒ AWS.Request

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

disassociatePhoneNumbersFromVoiceConnectorGroup(params = {}, callback) ⇒ AWS.Request

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

getGlobalSettings(params = {}, callback) ⇒ AWS.Request

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

getPhoneNumber(params = {}, callback) ⇒ AWS.Request

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

getPhoneNumberOrder(params = {}, callback) ⇒ AWS.Request

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.

getPhoneNumberSettings(params = {}, callback) ⇒ AWS.Request

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

getProxySession(params = {}, callback) ⇒ AWS.Request

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

getSipMediaApplication(params = {}, callback) ⇒ AWS.Request

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

getSipMediaApplicationAlexaSkillConfiguration(params = {}, callback) ⇒ AWS.Request

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.

getSipMediaApplicationLoggingConfiguration(params = {}, callback) ⇒ AWS.Request

Retrieves the logging configuration for the specified SIP media application.

getSipRule(params = {}, callback) ⇒ AWS.Request

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

getSpeakerSearchTask(params = {}, callback) ⇒ AWS.Request

Retrieves the details of the specified speaker search task.

getVoiceConnector(params = {}, callback) ⇒ AWS.Request

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

getVoiceConnectorEmergencyCallingConfiguration(params = {}, callback) ⇒ AWS.Request

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

getVoiceConnectorGroup(params = {}, callback) ⇒ AWS.Request

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

getVoiceConnectorLoggingConfiguration(params = {}, callback) ⇒ AWS.Request

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

getVoiceConnectorOrigination(params = {}, callback) ⇒ AWS.Request

Retrieves the origination settings for the specified Voice Connector.

getVoiceConnectorProxy(params = {}, callback) ⇒ AWS.Request

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

getVoiceConnectorStreamingConfiguration(params = {}, callback) ⇒ AWS.Request

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.

getVoiceConnectorTermination(params = {}, callback) ⇒ AWS.Request

Retrieves the termination setting details for the specified Voice Connector.

getVoiceConnectorTerminationHealth(params = {}, callback) ⇒ AWS.Request

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

getVoiceProfile(params = {}, callback) ⇒ AWS.Request

Retrieves the details of the specified voice profile.

getVoiceProfileDomain(params = {}, callback) ⇒ AWS.Request

Retrieves the details of the specified voice profile domain.

getVoiceToneAnalysisTask(params = {}, callback) ⇒ AWS.Request

Retrieves the details of a voice tone analysis task.

listAvailableVoiceConnectorRegions(params = {}, callback) ⇒ AWS.Request

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

listPhoneNumberOrders(params = {}, callback) ⇒ AWS.Request

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

listPhoneNumbers(params = {}, callback) ⇒ AWS.Request

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.

listProxySessions(params = {}, callback) ⇒ AWS.Request

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

listSipMediaApplications(params = {}, callback) ⇒ AWS.Request

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

listSipRules(params = {}, callback) ⇒ AWS.Request

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

listSupportedPhoneNumberCountries(params = {}, callback) ⇒ AWS.Request

Lists the countries that you can order phone numbers from.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Returns a list of the tags in a given resource.

listVoiceConnectorGroups(params = {}, callback) ⇒ AWS.Request

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

listVoiceConnectors(params = {}, callback) ⇒ AWS.Request

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

listVoiceConnectorTerminationCredentials(params = {}, callback) ⇒ AWS.Request

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

listVoiceProfileDomains(params = {}, callback) ⇒ AWS.Request

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

listVoiceProfiles(params = {}, callback) ⇒ AWS.Request

Lists the voice profiles in a voice profile domain.

putSipMediaApplicationAlexaSkillConfiguration(params = {}, callback) ⇒ AWS.Request

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.

putSipMediaApplicationLoggingConfiguration(params = {}, callback) ⇒ AWS.Request

Updates the logging configuration for the specified SIP media application.

putVoiceConnectorEmergencyCallingConfiguration(params = {}, callback) ⇒ AWS.Request

Updates a Voice Connector's emergency calling configuration.

putVoiceConnectorLoggingConfiguration(params = {}, callback) ⇒ AWS.Request

Updates a Voice Connector's logging configuration.

putVoiceConnectorOrigination(params = {}, callback) ⇒ AWS.Request

Updates a Voice Connector's origination settings.

putVoiceConnectorProxy(params = {}, callback) ⇒ AWS.Request

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

putVoiceConnectorStreamingConfiguration(params = {}, callback) ⇒ AWS.Request

Updates a Voice Connector's streaming configuration settings.

putVoiceConnectorTermination(params = {}, callback) ⇒ AWS.Request

Updates a Voice Connector's termination settings.

putVoiceConnectorTerminationCredentials(params = {}, callback) ⇒ AWS.Request

Updates a Voice Connector's termination credentials.

restorePhoneNumber(params = {}, callback) ⇒ AWS.Request

Restores a deleted phone number.

searchAvailablePhoneNumbers(params = {}, callback) ⇒ AWS.Request

Searches the provisioned phone numbers in an organization.

startSpeakerSearchTask(params = {}, callback) ⇒ AWS.Request

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.

startVoiceToneAnalysisTask(params = {}, callback) ⇒ AWS.Request

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.

stopSpeakerSearchTask(params = {}, callback) ⇒ AWS.Request

Stops a speaker search task.

stopVoiceToneAnalysisTask(params = {}, callback) ⇒ AWS.Request

Stops a voice tone analysis task.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds a tag to the specified resource.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from a resource.

updateGlobalSettings(params = {}, callback) ⇒ AWS.Request

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

updatePhoneNumber(params = {}, callback) ⇒ AWS.Request

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.

updatePhoneNumberSettings(params = {}, callback) ⇒ AWS.Request

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.

updateProxySession(params = {}, callback) ⇒ AWS.Request

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

updateSipMediaApplication(params = {}, callback) ⇒ AWS.Request

Updates the details of the specified SIP media application.

updateSipMediaApplicationCall(params = {}, callback) ⇒ AWS.Request

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.

updateSipRule(params = {}, callback) ⇒ AWS.Request

Updates the details of the specified SIP rule.

updateVoiceConnector(params = {}, callback) ⇒ AWS.Request

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

updateVoiceConnectorGroup(params = {}, callback) ⇒ AWS.Request

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

updateVoiceProfile(params = {}, callback) ⇒ AWS.Request

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.

updateVoiceProfileDomain(params = {}, callback) ⇒ AWS.Request

Updates the settings for the specified voice profile domain.

validateE911Address(params = {}, callback) ⇒ AWS.Request

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.