aws-elixir

View Source AWS.ChimeSDKVoice (aws-elixir 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.

Link to this section Summary

Functions

associate_phone_numbers_with_voice_connector(client, voice_connector_id, input, options \\ [])

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

associate_phone_numbers_with_voice_connector_group(client, voice_connector_group_id, input, options \\ [])

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

batch_delete_phone_number(client, input, options \\ [])

Moves phone numbers into the Deletion queue.

batch_update_phone_number(client, input, options \\ [])

Updates phone number product types, calling names, or phone number names.

create_phone_number_order(client, input, options \\ [])

Creates an order for phone numbers to be provisioned.

create_proxy_session(client, voice_connector_id, input, options \\ [])

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

create_sip_media_application(client, input, options \\ [])

Creates a SIP media application.

create_sip_media_application_call(client, sip_media_application_id, input, options \\ [])

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.

create_sip_rule(client, input, options \\ [])

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

create_voice_connector(client, input, options \\ [])

Creates an Amazon Chime SDK Voice Connector.

create_voice_connector_group(client, input, options \\ [])

Creates an Amazon Chime SDK Voice Connector group under the administrator's AWS account.

create_voice_profile(client, input, options \\ [])

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

create_voice_profile_domain(client, input, options \\ [])

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

delete_phone_number(client, phone_number_id, input, options \\ [])

Moves the specified phone number into the Deletion queue.

delete_proxy_session(client, proxy_session_id, voice_connector_id, input, options \\ [])

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

delete_sip_media_application(client, sip_media_application_id, input, options \\ [])

Deletes a SIP media application.

delete_sip_rule(client, sip_rule_id, input, options \\ [])

Deletes a SIP rule.

delete_voice_connector(client, voice_connector_id, input, options \\ [])

Deletes an Amazon Chime SDK Voice Connector.

delete_voice_connector_emergency_calling_configuration(client, voice_connector_id, input, options \\ [])

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

delete_voice_connector_external_systems_configuration(client, voice_connector_id, input, options \\ [])

Deletes the external systems configuration for a Voice Connector.

delete_voice_connector_group(client, voice_connector_group_id, input, options \\ [])

Deletes an Amazon Chime SDK Voice Connector group.

delete_voice_connector_origination(client, voice_connector_id, input, options \\ [])

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

delete_voice_connector_proxy(client, voice_connector_id, input, options \\ [])

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

delete_voice_connector_streaming_configuration(client, voice_connector_id, input, options \\ [])

Deletes a Voice Connector's streaming configuration.

delete_voice_connector_termination(client, voice_connector_id, input, options \\ [])

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

delete_voice_connector_termination_credentials(client, voice_connector_id, input, options \\ [])

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

delete_voice_profile(client, voice_profile_id, input, options \\ [])

Deletes a voice profile, including its voice print and enrollment data.

delete_voice_profile_domain(client, voice_profile_domain_id, input, options \\ [])

Deletes all voice profiles in the domain.

disassociate_phone_numbers_from_voice_connector(client, voice_connector_id, input, options \\ [])

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

disassociate_phone_numbers_from_voice_connector_group(client, voice_connector_group_id, input, options \\ [])

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

get_global_settings(client, options \\ [])

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

get_phone_number(client, phone_number_id, options \\ [])

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

get_phone_number_order(client, phone_number_order_id, options \\ [])

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.

get_phone_number_settings(client, options \\ [])

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

get_proxy_session(client, proxy_session_id, voice_connector_id, options \\ [])

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

get_sip_media_application(client, sip_media_application_id, options \\ [])

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

get_sip_media_application_alexa_skill_configuration(client, sip_media_application_id, options \\ [])

Gets the Alexa Skill configuration for the SIP media application.

get_sip_media_application_logging_configuration(client, sip_media_application_id, options \\ [])

Retrieves the logging configuration for the specified SIP media application.

get_sip_rule(client, sip_rule_id, options \\ [])

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

get_speaker_search_task(client, speaker_search_task_id, voice_connector_id, options \\ [])

Retrieves the details of the specified speaker search task.

get_voice_connector(client, voice_connector_id, options \\ [])

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

get_voice_connector_emergency_calling_configuration(client, voice_connector_id, options \\ [])

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

get_voice_connector_external_systems_configuration(client, voice_connector_id, options \\ [])

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

get_voice_connector_group(client, voice_connector_group_id, options \\ [])

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

get_voice_connector_logging_configuration(client, voice_connector_id, options \\ [])

Retrieves the logging configuration settings for the specified Voice Connector.

get_voice_connector_origination(client, voice_connector_id, options \\ [])

Retrieves the origination settings for the specified Voice Connector.

get_voice_connector_proxy(client, voice_connector_id, options \\ [])

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

get_voice_connector_streaming_configuration(client, voice_connector_id, options \\ [])

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

get_voice_connector_termination(client, voice_connector_id, options \\ [])

Retrieves the termination setting details for the specified Voice Connector.

get_voice_connector_termination_health(client, voice_connector_id, options \\ [])

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

get_voice_profile(client, voice_profile_id, options \\ [])

Retrieves the details of the specified voice profile.

get_voice_profile_domain(client, voice_profile_domain_id, options \\ [])

Retrieves the details of the specified voice profile domain.

get_voice_tone_analysis_task(client, voice_connector_id, voice_tone_analysis_task_id, is_caller, options \\ [])

Retrieves the details of a voice tone analysis task.

list_available_voice_connector_regions(client, options \\ [])

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

list_phone_number_orders(client, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_phone_numbers(client, filter_name \\ nil, filter_value \\ nil, max_results \\ nil, next_token \\ nil, product_type \\ nil, status \\ nil, options \\ [])

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.

list_proxy_sessions(client, voice_connector_id, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

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

list_sip_media_applications(client, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_sip_rules(client, max_results \\ nil, next_token \\ nil, sip_media_application_id \\ nil, options \\ [])

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

list_supported_phone_number_countries(client, product_type, options \\ [])

Lists the countries that you can order phone numbers from.

list_tags_for_resource(client, resource_arn, options \\ [])

Returns a list of the tags in a given resource.

list_voice_connector_groups(client, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_voice_connector_termination_credentials(client, voice_connector_id, options \\ [])

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

list_voice_connectors(client, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_voice_profile_domains(client, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_voice_profiles(client, max_results \\ nil, next_token \\ nil, voice_profile_domain_id, options \\ [])

Lists the voice profiles in a voice profile domain.

metadata()
put_sip_media_application_alexa_skill_configuration(client, sip_media_application_id, input, options \\ [])

Updates the Alexa Skill configuration for the SIP media application.

put_sip_media_application_logging_configuration(client, sip_media_application_id, input, options \\ [])

Updates the logging configuration for the specified SIP media application.

put_voice_connector_emergency_calling_configuration(client, voice_connector_id, input, options \\ [])

Updates a Voice Connector's emergency calling configuration.

put_voice_connector_external_systems_configuration(client, voice_connector_id, input, options \\ [])

Adds an external systems configuration to a Voice Connector.

put_voice_connector_logging_configuration(client, voice_connector_id, input, options \\ [])

Updates a Voice Connector's logging configuration.

put_voice_connector_origination(client, voice_connector_id, input, options \\ [])

Updates a Voice Connector's origination settings.

put_voice_connector_proxy(client, voice_connector_id, input, options \\ [])

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

put_voice_connector_streaming_configuration(client, voice_connector_id, input, options \\ [])

Updates a Voice Connector's streaming configuration settings.

put_voice_connector_termination(client, voice_connector_id, input, options \\ [])

Updates a Voice Connector's termination settings.

put_voice_connector_termination_credentials(client, voice_connector_id, input, options \\ [])

Updates a Voice Connector's termination credentials.

restore_phone_number(client, phone_number_id, input, options \\ [])

Restores a deleted phone number.

search_available_phone_numbers(client, area_code \\ nil, city \\ nil, country \\ nil, max_results \\ nil, next_token \\ nil, phone_number_type \\ nil, state \\ nil, toll_free_prefix \\ nil, options \\ [])

Searches the provisioned phone numbers in an organization.

start_speaker_search_task(client, voice_connector_id, input, options \\ [])

Starts a speaker search task.

start_voice_tone_analysis_task(client, voice_connector_id, input, options \\ [])

Starts a voice tone analysis task.

stop_speaker_search_task(client, speaker_search_task_id, voice_connector_id, input, options \\ [])

Stops a speaker search task.

stop_voice_tone_analysis_task(client, voice_connector_id, voice_tone_analysis_task_id, input, options \\ [])

Stops a voice tone analysis task.

tag_resource(client, input, options \\ [])

Adds a tag to the specified resource.

untag_resource(client, input, options \\ [])

Removes tags from a resource.

update_global_settings(client, input, options \\ [])

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

update_phone_number(client, phone_number_id, input, options \\ [])

Updates phone number details, such as product type, calling name, or phone number name for the specified phone number ID.

update_phone_number_settings(client, input, options \\ [])

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

update_proxy_session(client, proxy_session_id, voice_connector_id, input, options \\ [])

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

update_sip_media_application(client, sip_media_application_id, input, options \\ [])

Updates the details of the specified SIP media application.

update_sip_media_application_call(client, sip_media_application_id, transaction_id, input, options \\ [])

Invokes the AWS Lambda function associated with the SIP media application and transaction ID in an update request.

update_sip_rule(client, sip_rule_id, input, options \\ [])

Updates the details of the specified SIP rule.

update_voice_connector(client, voice_connector_id, input, options \\ [])

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

update_voice_connector_group(client, voice_connector_group_id, input, options \\ [])

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

update_voice_profile(client, voice_profile_id, input, options \\ [])

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

update_voice_profile_domain(client, voice_profile_domain_id, input, options \\ [])

Updates the settings for the specified voice profile domain.

validate_e911_address(client, input, options \\ [])

Validates an address to be used for 911 calls made with Amazon Chime SDK Voice Connectors.

Link to this section Functions

Link to this function

associate_phone_numbers_with_voice_connector(client, voice_connector_id, input, options \\ [])

View Source

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

Link to this function

associate_phone_numbers_with_voice_connector_group(client, voice_connector_group_id, input, options \\ [])

View Source

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

Link to this function

batch_delete_phone_number(client, input, options \\ [])

View Source

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.

Link to this function

batch_update_phone_number(client, input, options \\ [])

View Source

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.

You cannot have a duplicate phoneNumberId in a request.

Link to this function

create_phone_number_order(client, input, options \\ [])

View Source

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 to this function

create_proxy_session(client, voice_connector_id, input, options \\ [])

View Source

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

Link to this function

create_sip_media_application(client, input, options \\ [])

View Source

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 to this function

create_sip_media_application_call(client, sip_media_application_id, input, options \\ [])

View Source

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 to this function

create_sip_rule(client, input, options \\ [])

View Source

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 to this function

create_voice_connector(client, input, options \\ [])

View Source

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 to this function

create_voice_connector_group(client, input, options \\ [])

View Source

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.

Link to this function

create_voice_profile(client, input, options \\ [])

View Source

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.

Link to this function

create_voice_profile_domain(client, input, options \\ [])

View Source

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.

Link to this function

delete_phone_number(client, phone_number_id, input, options \\ [])

View Source

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.

Link to this function

delete_proxy_session(client, proxy_session_id, voice_connector_id, input, options \\ [])

View Source

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

Link to this function

delete_sip_media_application(client, sip_media_application_id, input, options \\ [])

View Source

Deletes a SIP media application.

Link to this function

delete_sip_rule(client, sip_rule_id, input, options \\ [])

View Source

Deletes a SIP rule.

Link to this function

delete_voice_connector(client, voice_connector_id, input, options \\ [])

View Source

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.

Link to this function

delete_voice_connector_emergency_calling_configuration(client, voice_connector_id, input, options \\ [])

View Source

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

Link to this function

delete_voice_connector_external_systems_configuration(client, voice_connector_id, input, options \\ [])

View Source

Deletes the external systems configuration for a Voice Connector.

Link to this function

delete_voice_connector_group(client, voice_connector_group_id, input, options \\ [])

View Source

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 to this function

delete_voice_connector_origination(client, voice_connector_id, input, options \\ [])

View Source

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.

Link to this function

delete_voice_connector_proxy(client, voice_connector_id, input, options \\ [])

View Source

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

Link to this function

delete_voice_connector_streaming_configuration(client, voice_connector_id, input, options \\ [])

View Source

Deletes a Voice Connector's streaming configuration.

Link to this function

delete_voice_connector_termination(client, voice_connector_id, input, options \\ [])

View Source

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.

Link to this function

delete_voice_connector_termination_credentials(client, voice_connector_id, input, options \\ [])

View Source

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

Link to this function

delete_voice_profile(client, voice_profile_id, input, options \\ [])

View Source

Deletes a voice profile, including its voice print and enrollment data.

WARNING: This action is not reversible.

Link to this function

delete_voice_profile_domain(client, voice_profile_domain_id, input, options \\ [])

View Source

Deletes all voice profiles in the domain.

WARNING: This action is not reversible.

Link to this function

disassociate_phone_numbers_from_voice_connector(client, voice_connector_id, input, options \\ [])

View Source

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

Link to this function

disassociate_phone_numbers_from_voice_connector_group(client, voice_connector_group_id, input, options \\ [])

View Source

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

Link to this function

get_global_settings(client, options \\ [])

View Source

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

Link to this function

get_phone_number(client, phone_number_id, options \\ [])

View Source

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

Link to this function

get_phone_number_order(client, phone_number_order_id, options \\ [])

View Source

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 to this function

get_phone_number_settings(client, options \\ [])

View Source

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

Link to this function

get_proxy_session(client, proxy_session_id, voice_connector_id, options \\ [])

View Source

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

Link to this function

get_sip_media_application(client, sip_media_application_id, options \\ [])

View Source

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

Link to this function

get_sip_media_application_alexa_skill_configuration(client, sip_media_application_id, options \\ [])

View Source

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.

Link to this function

get_sip_media_application_logging_configuration(client, sip_media_application_id, options \\ [])

View Source

Retrieves the logging configuration for the specified SIP media application.

Link to this function

get_sip_rule(client, sip_rule_id, options \\ [])

View Source

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

Link to this function

get_speaker_search_task(client, speaker_search_task_id, voice_connector_id, options \\ [])

View Source

Retrieves the details of the specified speaker search task.

Link to this function

get_voice_connector(client, voice_connector_id, options \\ [])

View Source

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

Link to this function

get_voice_connector_emergency_calling_configuration(client, voice_connector_id, options \\ [])

View Source

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

Link to this function

get_voice_connector_external_systems_configuration(client, voice_connector_id, options \\ [])

View Source

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

Link to this function

get_voice_connector_group(client, voice_connector_group_id, options \\ [])

View Source

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

Link to this function

get_voice_connector_logging_configuration(client, voice_connector_id, options \\ [])

View Source

Retrieves the logging configuration settings for the specified Voice Connector.

Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

Link to this function

get_voice_connector_origination(client, voice_connector_id, options \\ [])

View Source

Retrieves the origination settings for the specified Voice Connector.

Link to this function

get_voice_connector_proxy(client, voice_connector_id, options \\ [])

View Source

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

Link to this function

get_voice_connector_streaming_configuration(client, voice_connector_id, options \\ [])

View Source

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 to this function

get_voice_connector_termination(client, voice_connector_id, options \\ [])

View Source

Retrieves the termination setting details for the specified Voice Connector.

Link to this function

get_voice_connector_termination_health(client, voice_connector_id, options \\ [])

View Source

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 to this function

get_voice_profile(client, voice_profile_id, options \\ [])

View Source

Retrieves the details of the specified voice profile.

Link to this function

get_voice_profile_domain(client, voice_profile_domain_id, options \\ [])

View Source

Retrieves the details of the specified voice profile domain.

Link to this function

get_voice_tone_analysis_task(client, voice_connector_id, voice_tone_analysis_task_id, is_caller, options \\ [])

View Source

Retrieves the details of a voice tone analysis task.

Link to this function

list_available_voice_connector_regions(client, options \\ [])

View Source

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

Link to this function

list_phone_number_orders(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_phone_numbers(client, filter_name \\ nil, filter_value \\ nil, max_results \\ nil, next_token \\ nil, product_type \\ nil, status \\ nil, options \\ [])

View Source

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 to this function

list_proxy_sessions(client, voice_connector_id, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

View Source

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

Link to this function

list_sip_media_applications(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_sip_rules(client, max_results \\ nil, next_token \\ nil, sip_media_application_id \\ nil, options \\ [])

View Source

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

Link to this function

list_supported_phone_number_countries(client, product_type, options \\ [])

View Source

Lists the countries that you can order phone numbers from.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Returns a list of the tags in a given resource.

Link to this function

list_voice_connector_groups(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_voice_connector_termination_credentials(client, voice_connector_id, options \\ [])

View Source

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

Link to this function

list_voice_connectors(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_voice_profile_domains(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_voice_profiles(client, max_results \\ nil, next_token \\ nil, voice_profile_domain_id, options \\ [])

View Source

Lists the voice profiles in a voice profile domain.

Link to this function

metadata()

View Source
Link to this function

put_sip_media_application_alexa_skill_configuration(client, sip_media_application_id, input, options \\ [])

View Source

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.

Link to this function

put_sip_media_application_logging_configuration(client, sip_media_application_id, input, options \\ [])

View Source

Updates the logging configuration for the specified SIP media application.

Link to this function

put_voice_connector_emergency_calling_configuration(client, voice_connector_id, input, options \\ [])

View Source

Updates a Voice Connector's emergency calling configuration.

Link to this function

put_voice_connector_external_systems_configuration(client, voice_connector_id, input, options \\ [])

View Source

Adds an external systems configuration to a Voice Connector.

Link to this function

put_voice_connector_logging_configuration(client, voice_connector_id, input, options \\ [])

View Source

Updates a Voice Connector's logging configuration.

Link to this function

put_voice_connector_origination(client, voice_connector_id, input, options \\ [])

View Source

Updates a Voice Connector's origination settings.

Link to this function

put_voice_connector_proxy(client, voice_connector_id, input, options \\ [])

View Source

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

Link to this function

put_voice_connector_streaming_configuration(client, voice_connector_id, input, options \\ [])

View Source

Updates a Voice Connector's streaming configuration settings.

Link to this function

put_voice_connector_termination(client, voice_connector_id, input, options \\ [])

View Source

Updates a Voice Connector's termination settings.

Link to this function

put_voice_connector_termination_credentials(client, voice_connector_id, input, options \\ [])

View Source

Updates a Voice Connector's termination credentials.

Link to this function

restore_phone_number(client, phone_number_id, input, options \\ [])

View Source

Restores a deleted phone number.

Link to this function

search_available_phone_numbers(client, area_code \\ nil, city \\ nil, country \\ nil, max_results \\ nil, next_token \\ nil, phone_number_type \\ nil, state \\ nil, toll_free_prefix \\ nil, options \\ [])

View Source

Searches the provisioned phone numbers in an organization.

Link to this function

start_speaker_search_task(client, voice_connector_id, input, options \\ [])

View Source

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.

Link to this function

start_voice_tone_analysis_task(client, voice_connector_id, input, options \\ [])

View Source

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.

Link to this function

stop_speaker_search_task(client, speaker_search_task_id, voice_connector_id, input, options \\ [])

View Source

Stops a speaker search task.

Link to this function

stop_voice_tone_analysis_task(client, voice_connector_id, voice_tone_analysis_task_id, input, options \\ [])

View Source

Stops a voice tone analysis task.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Adds a tag to the specified resource.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes tags from a resource.

Link to this function

update_global_settings(client, input, options \\ [])

View Source

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

Link to this function

update_phone_number(client, phone_number_id, input, options \\ [])

View Source

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.

Link to this function

update_phone_number_settings(client, input, options \\ [])

View Source

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 to this function

update_proxy_session(client, proxy_session_id, voice_connector_id, input, options \\ [])

View Source

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

Link to this function

update_sip_media_application(client, sip_media_application_id, input, options \\ [])

View Source

Updates the details of the specified SIP media application.

Link to this function

update_sip_media_application_call(client, sip_media_application_id, transaction_id, input, options \\ [])

View Source

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 to this function

update_sip_rule(client, sip_rule_id, input, options \\ [])

View Source

Updates the details of the specified SIP rule.

Link to this function

update_voice_connector(client, voice_connector_id, input, options \\ [])

View Source

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

Link to this function

update_voice_connector_group(client, voice_connector_group_id, input, options \\ [])

View Source

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

Link to this function

update_voice_profile(client, voice_profile_id, input, options \\ [])

View Source

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.

Link to this function

update_voice_profile_domain(client, voice_profile_domain_id, input, options \\ [])

View Source

Updates the settings for the specified voice profile domain.

Link to this function

validate_e911_address(client, input, options \\ [])

View Source

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.