View Source aws_chime_sdk_voice (aws v1.0.4)
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.Summary
Functions
Moves phone numbers into the Deletion queue.
Creates an order for phone numbers to be provisioned.
Creates a SIP media application.
sipMediaApplicationId
.Creates a SIP rule, which can be used to run a SIP media application as a target for a specific trigger type.
Creates an Amazon Chime SDK Voice Connector.
Creates an Amazon Chime SDK Voice Connector group under the administrator's AWS account.
Creates a voice profile, which consists of an enrolled user and their latest voice print.
Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment audio.
Moves the specified phone number into the Deletion queue.
Deletes an Amazon Chime SDK Voice Connector.
Deletes an Amazon Chime SDK Voice Connector group.
Deletes the origination settings for the specified Amazon Chime SDK Voice Connector.
Deletes the termination settings for the specified Amazon Chime SDK Voice Connector.
Deletes a voice profile, including its voice print and enrollment data.
Deletes all voice profiles in the domain.
VoiceConnectorItems
.Retrieves the logging configuration settings for the specified Voice Connector.
Retrieves the streaming configuration details for the specified Amazon Chime SDK Voice Connector.
SIP OPTIONS
ping was received from your SIP infrastructure for the specified Amazon Chime SDK Voice Connector.Starts a speaker search task.
Starts a voice tone analysis task.
Updates phone number details, such as product type or calling name, for the specified phone number ID.
Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name.
Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request.
Updates the specified voice profile’s voice print and refreshes its expiration timestamp.
Validates an address to be used for 911 calls made with Amazon Chime SDK Voice Connectors.
Functions
associate_phone_numbers_with_voice_connector(Client, VoiceConnectorId, Input)
View Sourceassociate_phone_numbers_with_voice_connector(Client, VoiceConnectorId, Input0, Options0)
View Sourceassociate_phone_numbers_with_voice_connector_group(Client, VoiceConnectorGroupId, Input)
View Sourceassociate_phone_numbers_with_voice_connector_group(Client, VoiceConnectorGroupId, Input0, Options0)
View SourceMoves 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.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.Creates a SIP media application.
For more information about SIP media applications, see Managing SIP media applications and rules: https://docs.aws.amazon.com/chime-sdk/latest/ag/manage-sip-applications.html in the Amazon Chime SDK Administrator Guide.create_sip_media_application_call(Client, SipMediaApplicationId, Input)
View SourcesipMediaApplicationId
.
create_sip_media_application_call(Client, SipMediaApplicationId, Input0, Options0)
View SourceCreates 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: https://docs.aws.amazon.com/chime-sdk/latest/ag/manage-sip-applications.html in the Amazon Chime SDK Administrator Guide.Creates an Amazon Chime SDK Voice Connector.
For more information about Voice Connectors, see Managing Amazon Chime SDK Voice Connector groups: https://docs.aws.amazon.com/chime-sdk/latest/ag/voice-connector-groups.html in the Amazon Chime SDK Administrator Guide.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.
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: https://aws.amazon.com/service-terms/ for the Amazon Chime SDK.
For more information about voice profiles and voice analytics, see Using Amazon Chime SDK Voice Analytics: https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html in the Amazon Chime SDK Developer Guide.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: https://aws.amazon.com/service-terms/ for the Amazon Chime SDK.
For more information about voice profile domains, see Using Amazon Chime SDK Voice Analytics: https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html in the Amazon Chime SDK Developer Guide.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.delete_proxy_session(Client, ProxySessionId, VoiceConnectorId, Input)
View Sourcedelete_proxy_session(Client, ProxySessionId, VoiceConnectorId, Input0, Options0)
View Sourcedelete_sip_media_application(Client, SipMediaApplicationId, Input)
View Sourcedelete_sip_media_application(Client, SipMediaApplicationId, Input0, Options0)
View SourceDeletes 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.delete_voice_connector(Client, VoiceConnectorId, Input0, Options0)
View Sourcedelete_voice_connector_emergency_calling_configuration(Client, VoiceConnectorId, Input)
View Sourcedelete_voice_connector_emergency_calling_configuration(Client, VoiceConnectorId, Input0, Options0)
View Sourcedelete_voice_connector_group(Client, VoiceConnectorGroupId, Input)
View SourceDeletes an Amazon Chime SDK Voice Connector group.
AnyVoiceConnectorItems
and phone numbers associated with the group must be removed before it can be deleted.
delete_voice_connector_group(Client, VoiceConnectorGroupId, Input0, Options0)
View Sourcedelete_voice_connector_origination(Client, VoiceConnectorId, Input)
View SourceDeletes 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.delete_voice_connector_origination(Client, VoiceConnectorId, Input0, Options0)
View Sourcedelete_voice_connector_proxy(Client, VoiceConnectorId, Input0, Options0)
View Sourcedelete_voice_connector_streaming_configuration(Client, VoiceConnectorId, Input)
View Sourcedelete_voice_connector_streaming_configuration(Client, VoiceConnectorId, Input0, Options0)
View Sourcedelete_voice_connector_termination(Client, VoiceConnectorId, Input)
View SourceDeletes 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.delete_voice_connector_termination(Client, VoiceConnectorId, Input0, Options0)
View Sourcedelete_voice_connector_termination_credentials(Client, VoiceConnectorId, Input)
View Sourcedelete_voice_connector_termination_credentials(Client, VoiceConnectorId, Input0, Options0)
View SourceDeletes a voice profile, including its voice print and enrollment data.
WARNING: This action is not reversible.Deletes all voice profiles in the domain.
WARNING: This action is not reversible.delete_voice_profile_domain(Client, VoiceProfileDomainId, Input0, Options0)
View Sourcedisassociate_phone_numbers_from_voice_connector(Client, VoiceConnectorId, Input)
View Sourcedisassociate_phone_numbers_from_voice_connector(Client, VoiceConnectorId, Input0, Options0)
View Sourcedisassociate_phone_numbers_from_voice_connector_group(Client, VoiceConnectorGroupId, Input)
View Sourcedisassociate_phone_numbers_from_voice_connector_group(Client, VoiceConnectorGroupId, Input0, Options0)
View Sourceget_phone_number(Client, PhoneNumberId, QueryMap, HeadersMap, Options0)
View Sourceget_phone_number_order(Client, PhoneNumberOrderId, QueryMap, HeadersMap)
View Sourceget_phone_number_order(Client, PhoneNumberOrderId, QueryMap, HeadersMap, Options0)
View Sourceget_proxy_session(Client, ProxySessionId, VoiceConnectorId, QueryMap, HeadersMap)
View Sourceget_proxy_session(Client, ProxySessionId, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View Sourceget_sip_media_application(Client, SipMediaApplicationId, QueryMap, HeadersMap)
View Sourceget_sip_media_application(Client, SipMediaApplicationId, QueryMap, HeadersMap, Options0)
View Sourceget_sip_media_application_alexa_skill_configuration(Client, SipMediaApplicationId)
View Sourceget_sip_media_application_alexa_skill_configuration(Client, SipMediaApplicationId, QueryMap, HeadersMap)
View Sourceget_sip_media_application_alexa_skill_configuration(Client, SipMediaApplicationId, QueryMap, HeadersMap, Options0)
View Sourceget_sip_media_application_logging_configuration(Client, SipMediaApplicationId)
View Sourceget_sip_media_application_logging_configuration(Client, SipMediaApplicationId, QueryMap, HeadersMap)
View Sourceget_sip_media_application_logging_configuration(Client, SipMediaApplicationId, QueryMap, HeadersMap, Options0)
View Sourceget_speaker_search_task(Client, SpeakerSearchTaskId, VoiceConnectorId)
View Sourceget_speaker_search_task(Client, SpeakerSearchTaskId, VoiceConnectorId, QueryMap, HeadersMap)
View Sourceget_speaker_search_task(Client, SpeakerSearchTaskId, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View Sourceget_voice_connector(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourceget_voice_connector(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View Sourceget_voice_connector_emergency_calling_configuration(Client, VoiceConnectorId)
View Sourceget_voice_connector_emergency_calling_configuration(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourceget_voice_connector_emergency_calling_configuration(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View SourceVoiceConnectorItems
.
get_voice_connector_group(Client, VoiceConnectorGroupId, QueryMap, HeadersMap)
View Sourceget_voice_connector_group(Client, VoiceConnectorGroupId, QueryMap, HeadersMap, Options0)
View Sourceget_voice_connector_logging_configuration(Client, VoiceConnectorId)
View SourceRetrieves the logging configuration settings for the specified Voice Connector.
Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.get_voice_connector_logging_configuration(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourceget_voice_connector_logging_configuration(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View Sourceget_voice_connector_origination(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourceget_voice_connector_origination(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View Sourceget_voice_connector_proxy(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourceget_voice_connector_proxy(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View Sourceget_voice_connector_streaming_configuration(Client, VoiceConnectorId)
View SourceRetrieves 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.get_voice_connector_streaming_configuration(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourceget_voice_connector_streaming_configuration(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View Sourceget_voice_connector_termination(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourceget_voice_connector_termination(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View SourceSIP OPTIONS
ping was received from your SIP infrastructure for the specified Amazon Chime SDK Voice Connector.
get_voice_connector_termination_health(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourceget_voice_connector_termination_health(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View Sourceget_voice_profile(Client, VoiceProfileId, QueryMap, HeadersMap, Options0)
View Sourceget_voice_profile_domain(Client, VoiceProfileDomainId, QueryMap, HeadersMap)
View Sourceget_voice_profile_domain(Client, VoiceProfileDomainId, QueryMap, HeadersMap, Options0)
View Sourceget_voice_tone_analysis_task(Client, VoiceConnectorId, VoiceToneAnalysisTaskId, IsCaller)
View Sourceget_voice_tone_analysis_task(Client, VoiceConnectorId, VoiceToneAnalysisTaskId, IsCaller, QueryMap, HeadersMap)
View Sourceget_voice_tone_analysis_task(Client, VoiceConnectorId, VoiceToneAnalysisTaskId, IsCaller, QueryMap, HeadersMap, Options0)
View Sourcelist_available_voice_connector_regions(Client, QueryMap, HeadersMap)
View Sourcelist_available_voice_connector_regions(Client, QueryMap, HeadersMap, Options0)
View Sourcelist_proxy_sessions(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourcelist_proxy_sessions(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View Sourcelist_sip_media_applications(Client, QueryMap, HeadersMap, Options0)
View Sourcelist_supported_phone_number_countries(Client, ProductType, QueryMap, HeadersMap)
View Sourcelist_supported_phone_number_countries(Client, ProductType, QueryMap, HeadersMap, Options0)
View Sourcelist_tags_for_resource(Client, ResourceARN, QueryMap, HeadersMap, Options0)
View Sourcelist_voice_connector_groups(Client, QueryMap, HeadersMap, Options0)
View Sourcelist_voice_connector_termination_credentials(Client, VoiceConnectorId)
View Sourcelist_voice_connector_termination_credentials(Client, VoiceConnectorId, QueryMap, HeadersMap)
View Sourcelist_voice_connector_termination_credentials(Client, VoiceConnectorId, QueryMap, HeadersMap, Options0)
View Sourcelist_voice_profile_domains(Client, QueryMap, HeadersMap, Options0)
View Sourcelist_voice_profiles(Client, VoiceProfileDomainId, QueryMap, HeadersMap)
View Sourcelist_voice_profiles(Client, VoiceProfileDomainId, QueryMap, HeadersMap, Options0)
View Sourceput_sip_media_application_alexa_skill_configuration(Client, SipMediaApplicationId, Input)
View Sourceput_sip_media_application_alexa_skill_configuration(Client, SipMediaApplicationId, Input0, Options0)
View Sourceput_sip_media_application_logging_configuration(Client, SipMediaApplicationId, Input)
View Sourceput_sip_media_application_logging_configuration(Client, SipMediaApplicationId, Input0, Options0)
View Sourceput_voice_connector_emergency_calling_configuration(Client, VoiceConnectorId, Input)
View Sourceput_voice_connector_emergency_calling_configuration(Client, VoiceConnectorId, Input0, Options0)
View Sourceput_voice_connector_logging_configuration(Client, VoiceConnectorId, Input)
View Sourceput_voice_connector_logging_configuration(Client, VoiceConnectorId, Input0, Options0)
View Sourceput_voice_connector_origination(Client, VoiceConnectorId, Input0, Options0)
View Sourceput_voice_connector_proxy(Client, VoiceConnectorId, Input0, Options0)
View Sourceput_voice_connector_streaming_configuration(Client, VoiceConnectorId, Input)
View Sourceput_voice_connector_streaming_configuration(Client, VoiceConnectorId, Input0, Options0)
View Sourceput_voice_connector_termination(Client, VoiceConnectorId, Input0, Options0)
View Sourceput_voice_connector_termination_credentials(Client, VoiceConnectorId, Input)
View Sourceput_voice_connector_termination_credentials(Client, VoiceConnectorId, Input0, Options0)
View Sourcesearch_available_phone_numbers(Client, QueryMap, HeadersMap, Options0)
View SourceStarts 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: https://aws.amazon.com/service-terms/ for the Amazon Chime SDK.start_speaker_search_task(Client, VoiceConnectorId, Input0, Options0)
View SourceStarts a voice tone analysis task.
For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics: https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html 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: https://aws.amazon.com/service-terms/ for the Amazon Chime SDK.start_voice_tone_analysis_task(Client, VoiceConnectorId, Input0, Options0)
View Sourcestop_speaker_search_task(Client, SpeakerSearchTaskId, VoiceConnectorId, Input)
View Sourcestop_speaker_search_task(Client, SpeakerSearchTaskId, VoiceConnectorId, Input0, Options0)
View Sourcestop_voice_tone_analysis_task(Client, VoiceConnectorId, VoiceToneAnalysisTaskId, Input)
View Sourcestop_voice_tone_analysis_task(Client, VoiceConnectorId, VoiceToneAnalysisTaskId, Input0, Options0)
View SourceUpdates phone number details, such as product type or calling name, for the specified phone number ID.
You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.
For 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.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.update_proxy_session(Client, ProxySessionId, VoiceConnectorId, Input)
View Sourceupdate_proxy_session(Client, ProxySessionId, VoiceConnectorId, Input0, Options0)
View Sourceupdate_sip_media_application(Client, SipMediaApplicationId, Input)
View Sourceupdate_sip_media_application(Client, SipMediaApplicationId, Input0, Options0)
View Sourceupdate_sip_media_application_call(Client, SipMediaApplicationId, TransactionId, Input)
View SourceInvokes 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.update_sip_media_application_call(Client, SipMediaApplicationId, TransactionId, Input0, Options0)
View Sourceupdate_voice_connector(Client, VoiceConnectorId, Input0, Options0)
View Sourceupdate_voice_connector_group(Client, VoiceConnectorGroupId, Input)
View Sourceupdate_voice_connector_group(Client, VoiceConnectorGroupId, Input0, Options0)
View SourceUpdates 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.update_voice_profile_domain(Client, VoiceProfileDomainId, Input0, Options0)
View SourceValidates 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.