Edit on GitHub

Chime Sdk Voice

This page documents function available when using the Chime_Sdk_Voice module, created with @service Chime_Sdk_Voice.

Index

Documentation

Main.Chime_Sdk_Voice.associate_phone_numbers_with_voice_connector — Method
associate_phone_numbers_with_voice_connector(e164_phone_numbers, voice_connector_id)
associate_phone_numbers_with_voice_connector(e164_phone_numbers, voice_connector_id, params::Dict{String,<:Any})

Arguments

  • e164_phone_numbers:
  • voice_connector_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ForceAssociate":
source
Main.Chime_Sdk_Voice.associate_phone_numbers_with_voice_connector_group — Method
associate_phone_numbers_with_voice_connector_group(e164_phone_numbers, voice_connector_group_id)
associate_phone_numbers_with_voice_connector_group(e164_phone_numbers, voice_connector_group_id, params::Dict{String,<:Any})

Arguments

  • e164_phone_numbers:
  • voice_connector_group_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ForceAssociate":
source
Main.Chime_Sdk_Voice.create_proxy_session — Method
create_proxy_session(capabilities, participant_phone_numbers, voice_connector_id)
create_proxy_session(capabilities, participant_phone_numbers, voice_connector_id, params::Dict{String,<:Any})

Arguments

  • capabilities:
  • participant_phone_numbers:
  • voice_connector_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ExpiryMinutes":
  • "GeoMatchLevel":
  • "GeoMatchParams":
  • "Name":
  • "NumberSelectionBehavior":
source
Main.Chime_Sdk_Voice.create_sip_media_application_call — Method
create_sip_media_application_call(from_phone_number, to_phone_number, sip_media_application_id)
create_sip_media_application_call(from_phone_number, to_phone_number, sip_media_application_id, params::Dict{String,<:Any})

Arguments

  • from_phone_number:
  • to_phone_number:
  • sip_media_application_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ArgumentsMap":
  • "SipHeaders":
source
Main.Chime_Sdk_Voice.create_sip_rule — Method
create_sip_rule(name, trigger_type, trigger_value)
create_sip_rule(name, trigger_type, trigger_value, params::Dict{String,<:Any})

Arguments

  • name:
  • trigger_type:
  • trigger_value:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Disabled":
  • "TargetApplications":
source
Main.Chime_Sdk_Voice.create_voice_connector — Method
create_voice_connector(name, require_encryption)
create_voice_connector(name, require_encryption, params::Dict{String,<:Any})

Arguments

  • name:
  • require_encryption:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AwsRegion":
source
Main.Chime_Sdk_Voice.create_voice_connector_group — Method
create_voice_connector_group(name)
create_voice_connector_group(name, params::Dict{String,<:Any})

Arguments

  • name:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "VoiceConnectorItems":
source
Main.Chime_Sdk_Voice.delete_proxy_session — Method
delete_proxy_session(proxy_session_id, voice_connector_id)
delete_proxy_session(proxy_session_id, voice_connector_id, params::Dict{String,<:Any})

Arguments

  • proxy_session_id:
  • voice_connector_id:
source
Main.Chime_Sdk_Voice.get_proxy_session — Method
get_proxy_session(proxy_session_id, voice_connector_id)
get_proxy_session(proxy_session_id, voice_connector_id, params::Dict{String,<:Any})

Arguments

  • proxy_session_id:
  • voice_connector_id:
source
Main.Chime_Sdk_Voice.list_phone_number_orders — Method
list_phone_number_orders()
list_phone_number_orders(params::Dict{String,<:Any})

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results":
  • "next-token":
source
Main.Chime_Sdk_Voice.list_phone_numbers — Method
list_phone_numbers()
list_phone_numbers(params::Dict{String,<:Any})

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filter-name":
  • "filter-value":
  • "max-results":
  • "next-token":
  • "product-type":
  • "status":
source
Main.Chime_Sdk_Voice.list_proxy_sessions — Method
list_proxy_sessions(voice_connector_id)
list_proxy_sessions(voice_connector_id, params::Dict{String,<:Any})

Arguments

  • voice_connector_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results":
  • "next-token":
  • "status":
source
Main.Chime_Sdk_Voice.list_sip_media_applications — Method
list_sip_media_applications()
list_sip_media_applications(params::Dict{String,<:Any})

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results":
  • "next-token":
source
Main.Chime_Sdk_Voice.list_sip_rules — Method
list_sip_rules()
list_sip_rules(params::Dict{String,<:Any})

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results":
  • "next-token":
  • "sip-media-application":
source
Main.Chime_Sdk_Voice.list_voice_connector_groups — Method
list_voice_connector_groups()
list_voice_connector_groups(params::Dict{String,<:Any})

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results":
  • "next-token":
source
Main.Chime_Sdk_Voice.list_voice_connectors — Method
list_voice_connectors()
list_voice_connectors(params::Dict{String,<:Any})

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results":
  • "next-token":
source
Main.Chime_Sdk_Voice.put_sip_media_application_alexa_skill_configuration — Method
put_sip_media_application_alexa_skill_configuration(sip_media_application_id)
put_sip_media_application_alexa_skill_configuration(sip_media_application_id, params::Dict{String,<:Any})

Arguments

  • sip_media_application_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "SipMediaApplicationAlexaSkillConfiguration":
source
Main.Chime_Sdk_Voice.put_sip_media_application_logging_configuration — Method
put_sip_media_application_logging_configuration(sip_media_application_id)
put_sip_media_application_logging_configuration(sip_media_application_id, params::Dict{String,<:Any})

Arguments

  • sip_media_application_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "SipMediaApplicationLoggingConfiguration":
source
Main.Chime_Sdk_Voice.put_voice_connector_proxy — Method
put_voice_connector_proxy(default_session_expiry_minutes, phone_number_pool_countries, voice_connector_id)
put_voice_connector_proxy(default_session_expiry_minutes, phone_number_pool_countries, voice_connector_id, params::Dict{String,<:Any})

Arguments

  • default_session_expiry_minutes:
  • phone_number_pool_countries:
  • voice_connector_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Disabled":
  • "FallBackPhoneNumber":
source
Main.Chime_Sdk_Voice.put_voice_connector_termination_credentials — Method
put_voice_connector_termination_credentials(voice_connector_id)
put_voice_connector_termination_credentials(voice_connector_id, params::Dict{String,<:Any})

Arguments

  • voice_connector_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Credentials":
source
Main.Chime_Sdk_Voice.search_available_phone_numbers — Method
search_available_phone_numbers()
search_available_phone_numbers(params::Dict{String,<:Any})

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "area-code":
  • "city":
  • "country":
  • "max-results":
  • "next-token":
  • "phone-number-type":
  • "state":
  • "toll-free-prefix":
source
Main.Chime_Sdk_Voice.update_global_settings — Method
update_global_settings()
update_global_settings(params::Dict{String,<:Any})

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "VoiceConnector":
source
Main.Chime_Sdk_Voice.update_phone_number — Method
update_phone_number(phone_number_id)
update_phone_number(phone_number_id, params::Dict{String,<:Any})

Arguments

  • phone_number_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "CallingName":
  • "ProductType":
source
Main.Chime_Sdk_Voice.update_proxy_session — Method
update_proxy_session(capabilities, proxy_session_id, voice_connector_id)
update_proxy_session(capabilities, proxy_session_id, voice_connector_id, params::Dict{String,<:Any})

Arguments

  • capabilities:
  • proxy_session_id:
  • voice_connector_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ExpiryMinutes":
source
Main.Chime_Sdk_Voice.update_sip_media_application — Method
update_sip_media_application(sip_media_application_id)
update_sip_media_application(sip_media_application_id, params::Dict{String,<:Any})

Arguments

  • sip_media_application_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Endpoints":
  • "Name":
source
Main.Chime_Sdk_Voice.update_sip_media_application_call — Method
update_sip_media_application_call(arguments, sip_media_application_id, transaction_id)
update_sip_media_application_call(arguments, sip_media_application_id, transaction_id, params::Dict{String,<:Any})

Arguments

  • arguments:
  • sip_media_application_id:
  • transaction_id:
source
Main.Chime_Sdk_Voice.update_sip_rule — Method
update_sip_rule(name, sip_rule_id)
update_sip_rule(name, sip_rule_id, params::Dict{String,<:Any})

Arguments

  • name:
  • sip_rule_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Disabled":
  • "TargetApplications":
source
Main.Chime_Sdk_Voice.update_voice_connector — Method
update_voice_connector(name, require_encryption, voice_connector_id)
update_voice_connector(name, require_encryption, voice_connector_id, params::Dict{String,<:Any})

Arguments

  • name:
  • require_encryption:
  • voice_connector_id:
source
Main.Chime_Sdk_Voice.update_voice_connector_group — Method
update_voice_connector_group(name, voice_connector_items, voice_connector_group_id)
update_voice_connector_group(name, voice_connector_items, voice_connector_group_id, params::Dict{String,<:Any})

Arguments

  • name:
  • voice_connector_items:
  • voice_connector_group_id:
source
Main.Chime_Sdk_Voice.validate_e911_address — Method
validate_e911_address(aws_account_id, city, country, postal_code, state, street_info, street_number)
validate_e911_address(aws_account_id, city, country, postal_code, state, street_info, street_number, params::Dict{String,<:Any})

Arguments

  • aws_account_id:
  • city:
  • country:
  • postal_code:
  • state:
  • street_info:
  • street_number:
source