String streetName
The address street, such as 8th Avenue.
String streetSuffix
The address suffix, such as the N in 8th Avenue N.
String postDirectional
An address suffix location, such as the S. Unit A in Central Park S. Unit A.
String preDirectional
An address prefix location, such as the N in N. Third St.
String streetNumber
The numeric portion of an address.
String city
The city of an address.
String state
The state of an address.
String postalCode
The postal code of an address.
String postalCodePlus4
The zip + 4 or postal code + 4 of an address.
String country
The country of an address.
String voiceConnectorGroupId
The Amazon Chime SDK Voice Connector group ID.
List<E> e164PhoneNumbers
List of phone numbers, in E.164 format.
Boolean forceAssociate
If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.
String voiceConnectorId
The Voice Connector ID.
List<E> e164PhoneNumbers
List of phone numbers, in E.164 format.
Boolean forceAssociate
If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.
String streetInfo
The street information of the candidate address.
String streetNumber
The numeric portion of the candidate address.
String city
The city of the candidate address.
String state
The state of the candidate address.
String postalCode
The postal code of the candidate address.
String postalCodePlus4
The zip + 4 or postal code +4 of the candidate address.
String country
The country of the candidate address.
PhoneNumberOrder phoneNumberOrder
The phone number order details.
String voiceConnectorId
The Voice Connector ID.
List<E> participantPhoneNumbers
The participant phone numbers.
String name
The name of the proxy session.
Integer expiryMinutes
The number of minutes allowed for the proxy session.
List<E> capabilities
The proxy session's capabilities.
String numberSelectionBehavior
The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
String geoMatchLevel
The preference for matching the country or area code of the proxy phone number with that of the first participant.
GeoMatchParams geoMatchParams
The country and area code for the proxy phone number.
ProxySession proxySession
The proxy session details.
String fromPhoneNumber
The phone number that a user calls from. This is a phone number in your Amazon Chime SDK phone number inventory.
String toPhoneNumber
The phone number that the service should call.
String sipMediaApplicationId
The ID of the SIP media application.
Map<K,V> sipHeaders
The SIP headers added to an outbound call leg.
Map<K,V> argumentsMap
Context passed to a CreateSipMediaApplication API call. For example, you could pass key-value pairs such as:
"FirstName": "John", "LastName": "Doe"
SipMediaApplicationCall sipMediaApplicationCall
The actual call.
SipMediaApplication sipMediaApplication
The SIP media application details.
String name
The name of the SIP rule.
String triggerType
The type of trigger assigned to the SIP rule in TriggerValue, currently
RequestUriHostname or ToPhoneNumber.
String triggerValue
If TriggerType is RequestUriHostname, the value can be the outbound host name of a
Voice Connector. If TriggerType is ToPhoneNumber, the value can be a customer-owned
phone number in the E164 format. The SipMediaApplication specified in the SipRule is
triggered if the request URI in an incoming SIP request matches the RequestUriHostname, or if the
To header in the incoming SIP request matches the ToPhoneNumber value.
Boolean disabled
Disables or enables a SIP rule. You must disable SIP rules before you can delete them.
List<E> targetApplications
List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can be used.
SipRule sipRule
The SIP rule information, including the rule ID, triggers, and target applications.
VoiceConnectorGroup voiceConnectorGroup
The details of the Voice Connector group.
String name
The name of the Voice Connector.
String awsRegion
The AWS Region in which the Amazon Chime SDK Voice Connector is created. Default value: us-east-1 .
Boolean requireEncryption
Enables or disables encryption for the Voice Connector.
List<E> tags
The tags assigned to the Voice Connector.
VoiceConnector voiceConnector
The details of the Voice Connector.
String name
The name of the voice profile domain.
String description
A description of the voice profile domain.
ServerSideEncryptionConfiguration serverSideEncryptionConfiguration
The server-side encryption configuration for the request.
String clientRequestToken
The unique identifier for the client request. Use a different token for different domain creation requests.
List<E> tags
The tags assigned to the domain.
VoiceProfileDomain voiceProfileDomain
The requested voice profile domain.
String speakerSearchTaskId
The ID of the speaker search task.
VoiceProfile voiceProfile
The requested voice profile.
String phoneNumberId
The phone number ID.
String sipMediaApplicationId
The SIP media application ID.
String sipRuleId
The SIP rule ID.
String voiceConnectorId
The Voice Connector ID.
String voiceConnectorGroupId
The Voice Connector Group ID.
String voiceConnectorId
The Voice Connector ID.
String voiceConnectorId
The Voice Connector ID.
String voiceConnectorId
The Voice Connector ID.
String voiceConnectorId
The Voice Connector ID.
String voiceConnectorId
The Voice Connector ID.
String voiceProfileDomainId
The voice profile domain ID.
String voiceProfileId
The voice profile ID.
String emergencyPhoneNumber
The DNIS phone number that you route emergency calls to, in E.164 format.
String testPhoneNumber
The DNIS phone number for routing test emergency calls to, in E.164 format.
String callingCountry
The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.
VoiceConnectorSettings voiceConnector
The Voice Connector settings.
String phoneNumberOrderId
The ID of the phone number order .
PhoneNumberOrder phoneNumberOrder
The phone number order details.
String phoneNumberId
The phone number ID.
PhoneNumber phoneNumber
The phone number details.
ProxySession proxySession
The proxy session details.
String sipMediaApplicationId
The SIP media application ID.
SipMediaApplicationAlexaSkillConfiguration sipMediaApplicationAlexaSkillConfiguration
Returns the Alexa Skill configuration.
String sipMediaApplicationId
The SIP media application ID.
SipMediaApplicationLoggingConfiguration sipMediaApplicationLoggingConfiguration
The actual logging configuration.
String sipMediaApplicationId
The SIP media application ID .
SipMediaApplication sipMediaApplication
The details of the SIP media application.
String sipRuleId
The SIP rule ID.
SipRule sipRule
The SIP rule details.
SpeakerSearchTask speakerSearchTask
The details of the speaker search task.
String voiceConnectorId
The Voice Connector ID.
EmergencyCallingConfiguration emergencyCallingConfiguration
The details of the emergency calling configuration.
String voiceConnectorGroupId
The Voice Connector group ID.
VoiceConnectorGroup voiceConnectorGroup
The details of the Voice Connector group.
String voiceConnectorId
The Voice Connector ID.
LoggingConfiguration loggingConfiguration
The logging configuration details .
String voiceConnectorId
The Voice Connector ID.
Origination origination
The origination setting details.
String voiceConnectorId
The Voice Connector ID.
Proxy proxy
The proxy configuration details.
String voiceConnectorId
The Voice Connector ID.
VoiceConnector voiceConnector
The Voice Connector details.
String voiceConnectorId
The Voice Connector ID.
StreamingConfiguration streamingConfiguration
The details of the streaming configuration.
String voiceConnectorId
The Voice Connector ID.
TerminationHealth terminationHealth
The termination health details.
String voiceConnectorId
The Voice Connector ID.
Termination termination
The termination setting details.
String voiceProfileDomainId
The voice profile domain ID.
VoiceProfileDomain voiceProfileDomain
The details of the voice profile domain.
String voiceProfileId
The voice profile ID.
VoiceProfile voiceProfile
The voice profile details.
VoiceToneAnalysisTask voiceToneAnalysisTask
The details of the voice tone analysis task.
String status
The status of your organization's phone numbers.
String productType
The phone number product types.
String filterName
The filter to limit the number of results.
String filterValue
The filter value.
Integer maxResults
The maximum number of results to return in a single call.
String nextToken
The token used to return the next page of results.
String productType
The phone number product type.
String resourceARN
The resource ARN.
String voiceConnectorId
The Voice Connector ID.
List<E> routes
The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of
20. This parameter is not required, but you must specify this parameter or Disabled.
Boolean disabled
When origination settings are disabled, inbound calls are not enabled for your Amazon Chime SDK Voice Connector.
This parameter is not required, but you must specify this parameter or Routes.
String host
The FQDN or IP address to contact for origination traffic.
Integer port
The designated origination route port. Defaults to 5060.
String protocol
The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use TCP protocol by default.
Integer priority
The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.
Integer weight
The weight assigned to an origination route. When hosts have equal priority, calls are distributed between them based on their relative weights.
String phoneNumberId
The phone number's ID.
String e164PhoneNumber
The phone number, in E.164 format.
String country
The phone number's country. Format: ISO 3166-1 alpha-2.
String type
The phone number's type.
String productType
The phone number's product type.
String status
The phone number's status.
PhoneNumberCapabilities capabilities
The phone number's capabilities.
List<E> associations
The phone number's associations.
String callingName
The outbound calling name associated with the phone number.
String callingNameStatus
The outbound calling name status.
Date createdTimestamp
The phone number creation timestamp, in ISO 8601 format.
Date updatedTimestamp
The updated phone number timestamp, in ISO 8601 format.
Date deletionTimestamp
The deleted phone number timestamp, in ISO 8601 format.
String orderId
The phone number's order ID.
String name
The name of the phone number.
String value
Contains the ID for the entity specified in Name.
String name
Defines the association with an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.
Date associatedTimestamp
The timestamp of the phone number association, in ISO 8601 format.
Boolean inboundCall
Allows or denies inbound calling for the specified phone number.
Boolean outboundCall
Allows or denies outbound calling for the specified phone number.
Boolean inboundSMS
Allows or denies inbound SMS messaging for the specified phone number.
Boolean outboundSMS
Allows or denies outbound SMS messaging for the specified phone number.
Boolean inboundMMS
Allows or denies inbound MMS messaging for the specified phone number.
Boolean outboundMMS
Allows or denies inbound MMS messaging for the specified phone number.
String phoneNumberOrderId
The ID of the phone order.
String productType
The phone number order product type.
String status
The status of the phone number order.
String orderType
The type of phone number being ordered, local or toll-free.
List<E> orderedPhoneNumbers
The ordered phone number details, such as the phone number in E.164 format and the phone number status.
Date createdTimestamp
The phone number order creation time stamp, in ISO 8601 format.
Date updatedTimestamp
The updated phone number order time stamp, in ISO 8601 format.
Integer defaultSessionExpiryMinutes
The default number of minutes allowed for proxy sessions.
Boolean disabled
When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.
String fallBackPhoneNumber
The phone number to route calls to after a proxy session expires.
List<E> phoneNumberCountries
The countries for proxy phone numbers to be selected from.
String voiceConnectorId
The Voice Connector ID.
String proxySessionId
The proxy session ID.
String name
The proxy session name.
String status
The proxy session status.
Integer expiryMinutes
The number of minutes allowed for the proxy session.
List<E> capabilities
The proxy session capabilities.
Date createdTimestamp
The created time stamp, in ISO 8601 format.
Date updatedTimestamp
The updated time stamp, in ISO 8601 format.
Date endedTimestamp
The ended time stamp, in ISO 8601 format.
List<E> participants
The proxy session participants.
String numberSelectionBehavior
The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
String geoMatchLevel
The preference for matching the country or area code of the proxy phone number with that of the first participant.
GeoMatchParams geoMatchParams
The country and area code for the proxy phone number.
String sipMediaApplicationId
The SIP media application ID.
SipMediaApplicationAlexaSkillConfiguration sipMediaApplicationAlexaSkillConfiguration
The Alexa Skill configuration.
SipMediaApplicationAlexaSkillConfiguration sipMediaApplicationAlexaSkillConfiguration
Returns the Alexa Skill configuration.
String sipMediaApplicationId
The SIP media application ID.
SipMediaApplicationLoggingConfiguration sipMediaApplicationLoggingConfiguration
The logging configuration for the specified SIP media application.
SipMediaApplicationLoggingConfiguration sipMediaApplicationLoggingConfiguration
The updated logging configuration for the specified SIP media application.
String voiceConnectorId
The Voice Connector ID.
EmergencyCallingConfiguration emergencyCallingConfiguration
The configuration being updated.
EmergencyCallingConfiguration emergencyCallingConfiguration
The updated configuration.
String voiceConnectorId
The Voice Connector ID.
LoggingConfiguration loggingConfiguration
The logging configuration being updated.
LoggingConfiguration loggingConfiguration
The updated logging configuration.
String voiceConnectorId
The Voice Connector ID.
Origination origination
The origination settings being updated.
Origination origination
The updated origination settings.
String voiceConnectorId
The Voice Connector ID.
Integer defaultSessionExpiryMinutes
The default number of minutes allowed for proxy session.
List<E> phoneNumberPoolCountries
The countries for proxy phone numbers to be selected from.
String fallBackPhoneNumber
The phone number to route calls to after a proxy session expires.
Boolean disabled
When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.
Proxy proxy
The proxy configuration details.
String voiceConnectorId
The Voice Connector ID.
StreamingConfiguration streamingConfiguration
The streaming settings being updated.
StreamingConfiguration streamingConfiguration
The updated streaming settings.
String voiceConnectorId
The Voice Connector ID.
Termination termination
The termination settings to be updated.
Termination termination
The updated termination settings.
String phoneNumberId
The ID of the phone number being restored.
PhoneNumber phoneNumber
The restored phone number.
String areaCode
Confines a search to just the phone numbers associated with the specified area code.
String city
Confines a search to just the phone numbers associated with the specified city.
String country
Confines a search to just the phone numbers associated with the specified country.
String state
Confines a search to just the phone numbers associated with the specified state.
String tollFreePrefix
Confines a search to just the phone numbers associated with the specified toll-free prefix.
String phoneNumberType
Confines a search to just the phone numbers associated with the specified phone number type, either local or toll-free.
Integer maxResults
The maximum number of results to return.
String nextToken
The token used to return the next page of results.
String kmsKeyArn
The ARN of the KMS key used to encrypt the enrollment data in a voice profile domain. Asymmetric customer managed keys are not supported.
String sipMediaApplicationId
A SIP media application's ID.
String awsRegion
The AWS Region in which the SIP media application is created.
String name
The SIP media application's name.
List<E> endpoints
List of endpoints for a SIP media application. Currently, only one endpoint per SIP media application is permitted.
Date createdTimestamp
The SIP media application creation timestamp, in ISO 8601 format.
Date updatedTimestamp
The time at which the SIP media application was updated.
String sipMediaApplicationArn
The ARN of the SIP media application.
String transactionId
The call's transaction ID.
String lambdaArn
Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.
Boolean enableSipMediaApplicationMessageLogs
Enables message logging for the specified SIP media application.
String sipRuleId
A SIP rule's ID.
String name
A SIP rule's name.
Boolean disabled
Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.
String triggerType
The type of trigger set for a SIP rule, either a phone number or a URI request host name.
String triggerValue
The value set for a SIP rule's trigger type. Either a phone number or a URI hostname.
List<E> targetApplications
The target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
Date createdTimestamp
The time at which the SIP rule was created, in ISO 8601 format.
Date updatedTimestamp
The time at which the SIP rule was updated, in ISO 8601 format.
String speakerSearchTaskId
The speaker search task ID.
String speakerSearchTaskStatus
The status of the speaker search task, IN_QUEUE, IN_PROGRESS,
PARTIAL_SUCCESS, SUCCEEDED, FAILED, or STOPPED.
CallDetails callDetails
The call details of a speaker search task.
SpeakerSearchDetails speakerSearchDetails
The details of a speaker search task.
Date createdTimestamp
The time at which a speaker search task was created.
Date updatedTimestamp
The time at which a speaker search task was updated.
Date startedTimestamp
The time at which the speaker search task began.
String statusMessage
A detailed message about the status of a speaker search.
String voiceConnectorId
The Voice Connector ID.
String transactionId
The transaction ID of the call being analyzed.
String voiceProfileDomainId
The ID of the voice profile domain that will store the voice profile.
String clientRequestToken
The unique identifier for the client request. Use a different token for different speaker search tasks.
String callLeg
Specifies which call leg to stream for speaker search.
SpeakerSearchTask speakerSearchTask
The details of the speaker search task.
String voiceConnectorId
The Voice Connector ID.
String transactionId
The transaction ID.
String languageCode
The language code.
String clientRequestToken
The unique identifier for the client request. Use a different token for different voice tone analysis tasks.
VoiceToneAnalysisTask voiceToneAnalysisTask
The details of the voice tone analysis task.
Integer dataRetentionInHours
The amount of time, in hours, to the Kinesis data.
Boolean disabled
When true, streaming to Kinesis is off.
List<E> streamingNotificationTargets
The streaming notification targets.
MediaInsightsConfiguration mediaInsightsConfiguration
The call analytics configuration.
String notificationTarget
The streaming notification target.
Integer cpsLimit
The limit on calls per second. Max value based on account service quota. Default value of 1.
String defaultPhoneNumber
The default outbound calling number.
List<E> callingRegions
The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.
List<E> cidrAllowedList
The IP addresses allowed to make calls, in CIDR format.
Boolean disabled
When termination is disabled, outbound calls cannot be made.
VoiceConnectorSettings voiceConnector
The Voice Connector settings.
PhoneNumber phoneNumber
The updated phone number details.
String callingName
The default outbound calling name for the account.
ProxySession proxySession
The updated proxy session details.
String sipMediaApplicationId
The ID of the SIP media application handling the call.
String transactionId
The ID of the call transaction.
Map<K,V> arguments
Arguments made available to the Lambda function as part of the CALL_UPDATE_REQUESTED event. Can
contain 0-20 key-value pairs.
SipMediaApplicationCall sipMediaApplicationCall
A Call instance for a SIP media application.
SipMediaApplication sipMediaApplication
The updated SIP media application’s details.
SipRule sipRule
The updated SIP rule details.
VoiceConnectorGroup voiceConnectorGroup
The updated Voice Connector group.
VoiceConnector voiceConnector
The updated Voice Connector details.
VoiceProfileDomain voiceProfileDomain
The updated details of the voice profile domain.
VoiceProfile voiceProfile
The updated voice profile settings.
String awsAccountId
The AWS account ID.
String streetNumber
The address street number, such as 200 or 2121.
String streetInfo
The address street information, such as 8th Avenue.
String city
The address city, such as Portland.
String state
The address state, such as ME.
String country
The country in the address being validated.
String postalCode
The dress postal code, such 04352.
Integer validationResult
Number indicating the result of address validation. 0 means the address was perfect as-is and
successfully validated. 1 means the address was corrected. 2 means the address sent was
not close enough and was not validated.
String addressExternalId
The ID that represents the address.
Address address
The validated address.
List<E> candidateAddressList
The list of address suggestions..
String voiceConnectorId
The Voice Connector's ID.
String awsRegion
The AWS Region in which the Voice Connector is created. Default: us-east-1.
String name
The Voice Connector's name.
String outboundHostName
The outbound host name for the Voice Connector.
Boolean requireEncryption
Enables or disables encryption for the Voice Connector.
Date createdTimestamp
The Voice Connector's creation timestamp, in ISO 8601 format.
Date updatedTimestamp
The Voice Connector's updated timestamp, in ISO 8601 format.
String voiceConnectorArn
The ARN of the Voice Connector.
String voiceConnectorGroupId
The ID of a Voice Connector group.
String name
The name of a Voice Connector group.
List<E> voiceConnectorItems
The Voice Connectors to which you route inbound calls.
Date createdTimestamp
The Voice Connector group's creation time stamp, in ISO 8601 format.
Date updatedTimestamp
The Voice Connector group's creation time stamp, in ISO 8601 format.
String voiceConnectorGroupArn
The ARN of the Voice Connector group.
String voiceConnectorId
The Voice Connector ID.
Integer priority
The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight.
String cdrBucket
The S3 bucket that stores the Voice Connector's call detail records.
String voiceProfileId
The ID of the voice profile.
String voiceProfileArn
The ARN of the voice profile.
String voiceProfileDomainId
The ID of the domain that contains the voice profile.
Date createdTimestamp
The time at which the voice profile was created and enrolled.
Date updatedTimestamp
The time at which the voice profile was last updated.
Date expirationTimestamp
The time at which a voice profile expires unless you re-enroll the caller via the UpdateVoiceProfile
API.
String voiceProfileDomainId
The ID of the voice profile domain.
String voiceProfileDomainArn
The voice profile domain's Amazon Resource Number (ARN).
String name
The name of the voice profile domain.
String description
The description of the voice profile domain.
ServerSideEncryptionConfiguration serverSideEncryptionConfiguration
A structure that contains the configuration settings for server-side encryption.
Date createdTimestamp
The time at which the voice profile domain was created.
Date updatedTimestamp
The time at which the voice profile was last updated.
String voiceProfileDomainId
The ID of the voice profile domain summary.
String voiceProfileDomainArn
The ARN of a voice profile in a voice profile domain summary.
String name
The name of the voice profile domain summary.
String description
Describes the voice profile domain summary.
Date createdTimestamp
The time at which the voice profile domain summary was created.
Date updatedTimestamp
The time at which the voice profile domain summary was last updated.
String voiceProfileId
The ID of the voice profile in a voice profile summary.
String voiceProfileArn
The ARN of the voice profile in a voice profile summary.
String voiceProfileDomainId
The ID of the voice profile domain in a voice profile summary.
Date createdTimestamp
The time at which a voice profile summary was created.
Date updatedTimestamp
The time at which a voice profile summary was last updated.
Date expirationTimestamp
Extends the life of the voice profile. You can use UpdateVoiceProfile to refresh an existing voice
profile's voice print and extend the life of the summary.
String voiceToneAnalysisTaskId
The ID of the voice tone analysis task.
String voiceToneAnalysisTaskStatus
The status of a voice tone analysis task, IN_QUEUE, IN_PROGRESS,
PARTIAL_SUCCESS, SUCCEEDED, FAILED, or STOPPED.
CallDetails callDetails
The call details of a voice tone analysis task.
Date createdTimestamp
The time at which a voice tone analysis task was created.
Date updatedTimestamp
The time at which a voice tone analysis task was updated.
Date startedTimestamp
The time at which a voice tone analysis task started.
String statusMessage
The status of a voice tone analysis task.
Copyright © 2023. All rights reserved.