2025/10/22 - Amazon Connect Service - 2 new 5 updated api methods
Changes This release added support for email address alias configuration and outbound campaign preview mode.
Associates an email address alias with an existing email address in an Amazon Connect instance. This creates a forwarding relationship where emails sent to the alias email address are automatically forwarded to the primary email address.
Use cases
Following are common uses cases for this API:
Unified customer support: Create multiple entry points (for example, support@example.com, help@example.com, customercare@example.com) that all forward to a single agent queue for streamlined management.
Department consolidation: Forward emails from legacy department addresses (for example, sales@example.com, info@example.com) to a centralized customer service email during organizational restructuring.
Brand management: Enable you to use familiar brand-specific email addresses that forward to the appropriate Amazon Connect instance email address.
Important things to know
Each email address can have a maximum of one alias. You cannot create multiple aliases for the same email address.
If the alias email address already receives direct emails, it continues to receive direct emails plus forwarded emails.
You cannot chain email aliases together (that is, create an alias of an alias).
AssociateEmailAddressAlias does not return the following information:
A confirmation of the alias relationship details (you must call DescribeEmailAddress to verify).
The timestamp of when the association occurred.
The status of the forwarding configuration.
Endpoints: See Amazon Connect endpoints and quotas.
Related operations
DisassociateEmailAddressAlias: Removes the alias association between two email addresses in an Amazon Connect instance.
DescribeEmailAddress: View current alias configurations for an email address.
SearchEmailAddresses: Find email addresses and their alias relationships across an instance.
CreateEmailAddress: Create new email addresses that can participate in alias relationships.
DeleteEmailAddress: Remove email addresses (automatically removes any alias relationships).
UpdateEmailAddressMetadata: Modify email address properties (does not affect alias relationships).
See also: AWS API Documentation
Request Syntax
client.associate_email_address_alias(
EmailAddressId='string',
InstanceId='string',
AliasConfiguration={
'EmailAddressId': 'string'
},
ClientToken='string'
)
string
[REQUIRED]
The identifier of the email address.
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
dict
[REQUIRED]
Configuration object that specifies which email address will serve as the alias. The specified email address must already exist in the Amazon Connect instance and cannot already be configured as an alias or have an alias of its own.
EmailAddressId (string) -- [REQUIRED]
The email address ID.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
This field is autopopulated if not provided.
dict
Response Syntax
{}
Response Structure
(dict) --
Removes the alias association between two email addresses in an Amazon Connect instance. After disassociation, emails sent to the former alias email address are no longer forwarded to the primary email address. Both email addresses continue to exist independently and can receive emails directly.
Use cases
Following are common uses cases for this API:
Department separation: Remove alias relationships when splitting a consolidated support queue back into separate department-specific queues.
Email address retirement: Cleanly remove forwarding relationships before decommissioning old email addresses.
Organizational restructuring: Reconfigure email routing when business processes change and aliases are no longer needed.
Important things to know
Concurrent operations: This API uses distributed locking, so concurrent operations on the same email addresses may be temporarily blocked.
Emails sent to the former alias address are still delivered directly to that address if it exists.
You do not need to delete the email addresses after disassociation. Both addresses remain active independently.
After a successful disassociation, you can immediately create a new alias relationship with the same addresses.
200 status means alias was successfully disassociated.
DisassociateEmailAddressAlias does not return the following information:
Details in the response about the email that was disassociated. The response returns an empty body.
The timestamp of when the disassociation occurred.
Endpoints: See Amazon Connect endpoints and quotas.
Related operations
AssociateEmailAddressAlias: Associates an email address alias with an existing email address in an Amazon Connect instance.
DescribeEmailAddress: View current alias configurations for an email address.
SearchEmailAddresses: Find email addresses and their alias relationships across an instance.
CreateEmailAddress: Create new email addresses that can participate in alias relationships.
DeleteEmailAddress: Remove email addresses (automatically removes any alias relationships).
UpdateEmailAddressMetadata: Modify email address properties (does not affect alias relationships).
See also: AWS API Documentation
Request Syntax
client.disassociate_email_address_alias(
EmailAddressId='string',
InstanceId='string',
AliasConfiguration={
'EmailAddressId': 'string'
},
ClientToken='string'
)
string
[REQUIRED]
The identifier of the email address.
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
dict
[REQUIRED]
Configuration object that specifies which alias relationship to remove. The alias association must currently exist between the primary email address and the specified alias email address.
EmailAddressId (string) -- [REQUIRED]
The email address ID.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
This field is autopopulated if not provided.
dict
Response Syntax
{}
Response Structure
(dict) --
{'ContactDataRequestList': {'OutboundStrategy': {'Config': {'AgentFirst': {'Preview': {'AllowedUserActions': ['CALL '
'| '
'DISCARD'],
'PostAcceptTimeoutConfig': {'DurationInSeconds': 'integer'}}}},
'Type': 'AGENT_FIRST'}}}
Response {'FailedRequestList': {'FailureReasonCode': {'INVALID_OUTBOUND_STRATEGY'}}}
Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.
See also: AWS API Documentation
Request Syntax
client.batch_put_contact(
ClientToken='string',
InstanceId='string',
ContactDataRequestList=[
{
'SystemEndpoint': {
'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS',
'Address': 'string'
},
'CustomerEndpoint': {
'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS',
'Address': 'string'
},
'RequestIdentifier': 'string',
'QueueId': 'string',
'Attributes': {
'string': 'string'
},
'Campaign': {
'CampaignId': 'string'
},
'OutboundStrategy': {
'Type': 'AGENT_FIRST',
'Config': {
'AgentFirst': {
'Preview': {
'PostAcceptTimeoutConfig': {
'DurationInSeconds': 123
},
'AllowedUserActions': [
'CALL'|'DISCARD',
]
}
}
}
}
},
]
)
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
This field is autopopulated if not provided.
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
list
[REQUIRED]
List of individual contact requests.
(dict) --
Request object with information to create a contact.
SystemEndpoint (dict) --
Endpoint associated with the Amazon Connect instance from which outbound contact will be initiated for the campaign.
Type (string) --
Type of the endpoint.
Address (string) --
Address of the endpoint.
CustomerEndpoint (dict) --
Endpoint of the customer for which contact will be initiated.
Type (string) --
Type of the endpoint.
Address (string) --
Address of the endpoint.
RequestIdentifier (string) --
Identifier to uniquely identify individual requests in the batch.
QueueId (string) --
The identifier of the queue associated with the Amazon Connect instance in which contacts that are created will be queued.
Attributes (dict) --
List of attributes to be stored in a contact.
(string) --
(string) --
Campaign (dict) --
Structure to store information associated with a campaign.
CampaignId (string) --
A unique identifier for a campaign.
OutboundStrategy (dict) --
Information about the outbound strategy.
Type (string) -- [REQUIRED]
Type of the outbound strategy.
Config (dict) --
Config of the outbound strategy.
AgentFirst (dict) --
The config of agent first outbound strategy.
Preview (dict) --
Information about preview configuration of agent first outbound strategy
PostAcceptTimeoutConfig (dict) -- [REQUIRED]
Countdown timer configuration after the agent accepted the preview outbound contact.
DurationInSeconds (integer) -- [REQUIRED]
Duration in seconds for the countdown timer after the agent accepted the contact.
AllowedUserActions (list) -- [REQUIRED]
The actions the agent can perform after accepting the preview outbound contact.
(string) --
dict
Response Syntax
{
'SuccessfulRequestList': [
{
'RequestIdentifier': 'string',
'ContactId': 'string'
},
],
'FailedRequestList': [
{
'RequestIdentifier': 'string',
'FailureReasonCode': 'INVALID_ATTRIBUTE_KEY'|'INVALID_CUSTOMER_ENDPOINT'|'INVALID_SYSTEM_ENDPOINT'|'INVALID_QUEUE'|'INVALID_OUTBOUND_STRATEGY'|'MISSING_CAMPAIGN'|'MISSING_CUSTOMER_ENDPOINT'|'MISSING_QUEUE_ID_AND_SYSTEM_ENDPOINT'|'REQUEST_THROTTLED'|'IDEMPOTENCY_EXCEPTION'|'INTERNAL_ERROR',
'FailureReasonMessage': 'string'
},
]
}
Response Structure
(dict) --
SuccessfulRequestList (list) --
List of requests for which contact was successfully created.
(dict) --
Request for which contact was successfully created.
RequestIdentifier (string) --
Request identifier provided in the API call in the ContactDataRequest to create a contact.
ContactId (string) --
The contactId of the contact that was created successfully.
FailedRequestList (list) --
List of requests for which contact creation failed.
(dict) --
Request for which contact failed to be generated.
RequestIdentifier (string) --
Request identifier provided in the API call in the ContactDataRequest to create a contact.
FailureReasonCode (string) --
Reason code for the failure.
FailureReasonMessage (string) --
Why the request to create a contact failed.
{'Contact': {'AgentInfo': {'AcceptedByAgentTimestamp': 'timestamp',
'PreviewEndTimestamp': 'timestamp'},
'OutboundStrategy': {'Config': {'AgentFirst': {'Preview': {'AllowedUserActions': ['CALL '
'| '
'DISCARD'],
'PostAcceptTimeoutConfig': {'DurationInSeconds': 'integer'}}}},
'Type': 'AGENT_FIRST'}}}
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
Use cases
Following are common uses cases for this API:
Retrieve contact information such as the caller's phone number and the specific number the caller dialed to integrate into custom monitoring or custom agent experience solutions.
Detect when a customer chat session disconnects due to a network issue on the agent's end. Use the DisconnectReason field in the ContactTraceRecord to detect this event and then re-queue the chat for followup.
Identify after contact work (ACW) duration and call recordings information when a COMPLETED event is received by using the contact event stream.
Important things to know
SystemEndpoint is not populated for contacts with initiation method of MONITOR, QUEUE_TRANSFER, or CALLBACK
Contact information remains available in Amazon Connect for 24 months from the InitiationTimestamp, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API.
Endpoints: See Amazon Connect endpoints and quotas.
See also: AWS API Documentation
Request Syntax
client.describe_contact(
InstanceId='string',
ContactId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier of the contact.
dict
Response Syntax
{
'Contact': {
'Arn': 'string',
'Id': 'string',
'InitialContactId': 'string',
'PreviousContactId': 'string',
'ContactAssociationId': 'string',
'InitiationMethod': 'INBOUND'|'OUTBOUND'|'TRANSFER'|'QUEUE_TRANSFER'|'CALLBACK'|'API'|'DISCONNECT'|'MONITOR'|'EXTERNAL_OUTBOUND'|'WEBRTC_API'|'AGENT_REPLY'|'FLOW',
'Name': 'string',
'Description': 'string',
'Channel': 'VOICE'|'CHAT'|'TASK'|'EMAIL',
'QueueInfo': {
'Id': 'string',
'EnqueueTimestamp': datetime(2015, 1, 1)
},
'AgentInfo': {
'Id': 'string',
'AcceptedByAgentTimestamp': datetime(2015, 1, 1),
'PreviewEndTimestamp': datetime(2015, 1, 1),
'ConnectedToAgentTimestamp': datetime(2015, 1, 1),
'AgentPauseDurationInSeconds': 123,
'HierarchyGroups': {
'Level1': {
'Arn': 'string'
},
'Level2': {
'Arn': 'string'
},
'Level3': {
'Arn': 'string'
},
'Level4': {
'Arn': 'string'
},
'Level5': {
'Arn': 'string'
}
},
'DeviceInfo': {
'PlatformName': 'string',
'PlatformVersion': 'string',
'OperatingSystem': 'string'
},
'Capabilities': {
'Video': 'SEND',
'ScreenShare': 'SEND'
},
'AfterContactWorkDuration': 123,
'AfterContactWorkStartTimestamp': datetime(2015, 1, 1),
'AfterContactWorkEndTimestamp': datetime(2015, 1, 1),
'AgentInitiatedHoldDuration': 123,
'StateTransitions': [
{
'State': 'INITIAL'|'CONNECTED'|'DISCONNECTED'|'MISSED',
'StateStartTimestamp': datetime(2015, 1, 1),
'StateEndTimestamp': datetime(2015, 1, 1)
},
]
},
'InitiationTimestamp': datetime(2015, 1, 1),
'DisconnectTimestamp': datetime(2015, 1, 1),
'LastUpdateTimestamp': datetime(2015, 1, 1),
'LastPausedTimestamp': datetime(2015, 1, 1),
'LastResumedTimestamp': datetime(2015, 1, 1),
'TotalPauseCount': 123,
'TotalPauseDurationInSeconds': 123,
'ScheduledTimestamp': datetime(2015, 1, 1),
'RelatedContactId': 'string',
'WisdomInfo': {
'SessionArn': 'string'
},
'CustomerId': 'string',
'CustomerEndpoint': {
'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS',
'Address': 'string',
'DisplayName': 'string'
},
'SystemEndpoint': {
'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS',
'Address': 'string',
'DisplayName': 'string'
},
'QueueTimeAdjustmentSeconds': 123,
'QueuePriority': 123,
'Tags': {
'string': 'string'
},
'ConnectedToSystemTimestamp': datetime(2015, 1, 1),
'RoutingCriteria': {
'Steps': [
{
'Expiry': {
'DurationInSeconds': 123,
'ExpiryTimestamp': datetime(2015, 1, 1)
},
'Expression': {
'AttributeCondition': {
'Name': 'string',
'Value': 'string',
'ProficiencyLevel': ...,
'Range': {
'MinProficiencyLevel': ...,
'MaxProficiencyLevel': ...
},
'MatchCriteria': {
'AgentsCriteria': {
'AgentIds': [
'string',
]
}
},
'ComparisonOperator': 'string'
},
'AndExpression': [
{'... recursive ...'},
],
'OrExpression': [
{'... recursive ...'},
],
'NotAttributeCondition': {
'Name': 'string',
'Value': 'string',
'ProficiencyLevel': ...,
'Range': {
'MinProficiencyLevel': ...,
'MaxProficiencyLevel': ...
},
'MatchCriteria': {
'AgentsCriteria': {
'AgentIds': [
'string',
]
}
},
'ComparisonOperator': 'string'
}
},
'Status': 'ACTIVE'|'INACTIVE'|'JOINED'|'EXPIRED'
},
],
'ActivationTimestamp': datetime(2015, 1, 1),
'Index': 123
},
'Customer': {
'DeviceInfo': {
'PlatformName': 'string',
'PlatformVersion': 'string',
'OperatingSystem': 'string'
},
'Capabilities': {
'Video': 'SEND',
'ScreenShare': 'SEND'
}
},
'Campaign': {
'CampaignId': 'string'
},
'AnsweringMachineDetectionStatus': 'ANSWERED'|'UNDETECTED'|'ERROR'|'HUMAN_ANSWERED'|'SIT_TONE_DETECTED'|'SIT_TONE_BUSY'|'SIT_TONE_INVALID_NUMBER'|'FAX_MACHINE_DETECTED'|'VOICEMAIL_BEEP'|'VOICEMAIL_NO_BEEP'|'AMD_UNRESOLVED'|'AMD_UNANSWERED'|'AMD_ERROR'|'AMD_NOT_APPLICABLE',
'CustomerVoiceActivity': {
'GreetingStartTimestamp': datetime(2015, 1, 1),
'GreetingEndTimestamp': datetime(2015, 1, 1)
},
'QualityMetrics': {
'Agent': {
'Audio': {
'QualityScore': ...,
'PotentialQualityIssues': [
'string',
]
}
},
'Customer': {
'Audio': {
'QualityScore': ...,
'PotentialQualityIssues': [
'string',
]
}
}
},
'ChatMetrics': {
'ChatContactMetrics': {
'MultiParty': True|False,
'TotalMessages': 123,
'TotalBotMessages': 123,
'TotalBotMessageLengthInChars': 123,
'ConversationCloseTimeInMillis': 123,
'ConversationTurnCount': 123,
'AgentFirstResponseTimestamp': datetime(2015, 1, 1),
'AgentFirstResponseTimeInMillis': 123
},
'AgentMetrics': {
'ParticipantId': 'string',
'ParticipantType': 'ALL'|'MANAGER'|'AGENT'|'CUSTOMER'|'THIRDPARTY',
'ConversationAbandon': True|False,
'MessagesSent': 123,
'NumResponses': 123,
'MessageLengthInChars': 123,
'TotalResponseTimeInMillis': 123,
'MaxResponseTimeInMillis': 123,
'LastMessageTimestamp': datetime(2015, 1, 1)
},
'CustomerMetrics': {
'ParticipantId': 'string',
'ParticipantType': 'ALL'|'MANAGER'|'AGENT'|'CUSTOMER'|'THIRDPARTY',
'ConversationAbandon': True|False,
'MessagesSent': 123,
'NumResponses': 123,
'MessageLengthInChars': 123,
'TotalResponseTimeInMillis': 123,
'MaxResponseTimeInMillis': 123,
'LastMessageTimestamp': datetime(2015, 1, 1)
}
},
'DisconnectDetails': {
'PotentialDisconnectIssue': 'string'
},
'AdditionalEmailRecipients': {
'ToList': [
{
'Address': 'string',
'DisplayName': 'string'
},
],
'CcList': [
{
'Address': 'string',
'DisplayName': 'string'
},
]
},
'SegmentAttributes': {
'string': {
'ValueString': 'string',
'ValueMap': {
'string': {'... recursive ...'}
},
'ValueInteger': 123,
'ValueList': [
{'... recursive ...'},
],
'ValueArn': 'string'
}
},
'Recordings': [
{
'StorageType': 'S3'|'KINESIS_VIDEO_STREAM'|'KINESIS_STREAM'|'KINESIS_FIREHOSE',
'Location': 'string',
'MediaStreamType': 'AUDIO'|'VIDEO',
'ParticipantType': 'ALL'|'MANAGER'|'AGENT'|'CUSTOMER'|'THIRDPARTY',
'FragmentStartNumber': 'string',
'FragmentStopNumber': 'string',
'StartTimestamp': datetime(2015, 1, 1),
'StopTimestamp': datetime(2015, 1, 1),
'Status': 'AVAILABLE'|'DELETED',
'DeletionReason': 'string'
},
],
'DisconnectReason': 'string',
'ContactEvaluations': {
'string': {
'FormId': 'string',
'EvaluationArn': 'string',
'Status': 'COMPLETE'|'IN_PROGRESS'|'DELETED',
'StartTimestamp': datetime(2015, 1, 1),
'EndTimestamp': datetime(2015, 1, 1),
'DeleteTimestamp': datetime(2015, 1, 1),
'ExportLocation': 'string'
}
},
'TaskTemplateInfo': {
'Arn': 'string',
'Name': 'string'
},
'ContactDetails': {
'Name': 'string',
'Description': 'string'
},
'OutboundStrategy': {
'Type': 'AGENT_FIRST',
'Config': {
'AgentFirst': {
'Preview': {
'PostAcceptTimeoutConfig': {
'DurationInSeconds': 123
},
'AllowedUserActions': [
'CALL'|'DISCARD',
]
}
}
}
},
'Attributes': {
'string': 'string'
}
}
}
Response Structure
(dict) --
Contact (dict) --
Information about the contact.
Arn (string) --
The Amazon Resource Name (ARN) for the contact.
Id (string) --
The identifier for the contact.
InitialContactId (string) --
If this contact is related to other contacts, this is the ID of the initial contact.
PreviousContactId (string) --
If this contact is not the first contact, this is the ID of the previous contact.
ContactAssociationId (string) --
This is the root contactId which is used as a unique identifier for all subsequent contacts in a contact tree.
InitiationMethod (string) --
Indicates how the contact was initiated.
Name (string) --
The name of the contact.
Description (string) --
The description of the contact.
Channel (string) --
How the contact reached your contact center.
QueueInfo (dict) --
If this contact was queued, this contains information about the queue.
Id (string) --
The unique identifier for the queue.
EnqueueTimestamp (datetime) --
The timestamp when the contact was added to the queue.
AgentInfo (dict) --
Information about the agent who accepted the contact.
Id (string) --
The identifier of the agent who accepted the contact.
AcceptedByAgentTimestamp (datetime) --
The timestamp when the contact was accepted by the agent.
PreviewEndTimestamp (datetime) --
The timestamp when the agent finished previewing the contact.
ConnectedToAgentTimestamp (datetime) --
The timestamp when the contact was connected to the agent.
AgentPauseDurationInSeconds (integer) --
Agent pause duration for a contact in seconds.
HierarchyGroups (dict) --
The agent hierarchy groups for the agent.
Level1 (dict) --
The group at level one of the agent hierarchy.
Arn (string) --
The Amazon Resource Name (ARN) of the group.
Level2 (dict) --
The group at level two of the agent hierarchy.
Arn (string) --
The Amazon Resource Name (ARN) of the group.
Level3 (dict) --
The group at level three of the agent hierarchy.
Arn (string) --
The Amazon Resource Name (ARN) of the group.
Level4 (dict) --
The group at level four of the agent hierarchy.
Arn (string) --
The Amazon Resource Name (ARN) of the group.
Level5 (dict) --
The group at level five of the agent hierarchy.
Arn (string) --
The Amazon Resource Name (ARN) of the group.
DeviceInfo (dict) --
Information regarding Agent’s device.
PlatformName (string) --
Name of the platform that the participant used for the call.
PlatformVersion (string) --
Version of the platform that the participant used for the call.
OperatingSystem (string) --
Operating system that the participant used for the call.
Capabilities (dict) --
The configuration for the allowed video and screen sharing capabilities for participants present over the call. For more information, see Set up in-app, web, video calling, and screen sharing capabilities in the Amazon Connect Administrator Guide.
Video (string) --
The configuration having the video and screen sharing capabilities for participants over the call.
ScreenShare (string) --
The screen sharing capability that is enabled for the participant. SEND indicates the participant can share their screen.
AfterContactWorkDuration (integer) --
The difference in time, in whole seconds, between AfterContactWorkStartTimestamp and AfterContactWorkEndTimestamp.
AfterContactWorkStartTimestamp (datetime) --
The date and time when the agent started doing After Contact Work for the contact, in UTC time.
AfterContactWorkEndTimestamp (datetime) --
The date and time when the agent ended After Contact Work for the contact, in UTC time. In cases when agent finishes doing AfterContactWork for chat contacts and switches their activity status to offline or equivalent without clearing the contact in CCP, discrepancies may be noticed for AfterContactWorkEndTimestamp.
AgentInitiatedHoldDuration (integer) --
The total hold duration in seconds initiated by the agent.
StateTransitions (list) --
List of StateTransition for a supervisor.
(dict) --
Information about the state transition of a supervisor.
State (string) --
The state of the transition.
StateStartTimestamp (datetime) --
The date and time when the state started in UTC time.
StateEndTimestamp (datetime) --
The date and time when the state ended in UTC time.
InitiationTimestamp (datetime) --
The date and time this contact was initiated, in UTC time. For INBOUND, this is when the contact arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when the callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the transfer was initiated. For API, this is when the request arrived. For EXTERNAL_OUTBOUND, this is when the agent started dialing the external participant. For MONITOR, this is when the supervisor started listening to a contact.
DisconnectTimestamp (datetime) --
The date and time that the customer endpoint disconnected from the current contact, in UTC time. In transfer scenarios, the DisconnectTimestamp of the previous contact indicates the date and time when that contact ended.
LastUpdateTimestamp (datetime) --
The timestamp when contact was last updated.
LastPausedTimestamp (datetime) --
The timestamp when the contact was last paused.
LastResumedTimestamp (datetime) --
The timestamp when the contact was last resumed.
TotalPauseCount (integer) --
Total pause count for a contact.
TotalPauseDurationInSeconds (integer) --
Total pause duration for a contact in seconds.
ScheduledTimestamp (datetime) --
The timestamp, in Unix epoch time format, at which to start running the inbound flow.
RelatedContactId (string) --
The contactId that is related to this contact.
WisdomInfo (dict) --
Information about Amazon Connect Wisdom.
SessionArn (string) --
The Amazon Resource Name (ARN) of the Wisdom session.
CustomerId (string) --
The customer's identification number. For example, the CustomerId may be a customer number from your CRM. You can create a Lambda function to pull the unique customer ID of the caller from your CRM system. If you enable Amazon Connect Voice ID capability, this attribute is populated with the CustomerSpeakerId of the caller.
CustomerEndpoint (dict) --
The customer or external third party participant endpoint.
Type (string) --
Type of endpoint.
Address (string) --
Address of the endpoint.
DisplayName (string) --
Display name of the endpoint.
SystemEndpoint (dict) --
The system endpoint. For INBOUND, this is the phone number or email address that the customer dialed. For OUTBOUND and EXTERNAL_OUTBOUND, this is the outbound caller ID number assigned to the outbound queue that is used to dial the customer. For callback, this shows up as Softphone for calls handled by agents with softphone.
Type (string) --
Type of endpoint.
Address (string) --
Address of the endpoint.
DisplayName (string) --
Display name of the endpoint.
QueueTimeAdjustmentSeconds (integer) --
An integer that represents the queue time adjust to be applied to the contact, in seconds (longer / larger queue time are routed preferentially). Cannot be specified if the QueuePriority is specified. Must be statically defined and a valid integer value.
QueuePriority (integer) --
An integer that represents the queue priority to be applied to the contact (lower priorities are routed preferentially). Cannot be specified if the QueueTimeAdjustmentSeconds is specified. Must be statically defined, must be larger than zero, and a valid integer value. Default Value is 5.
Tags (dict) --
Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.
(string) --
(string) --
ConnectedToSystemTimestamp (datetime) --
The timestamp when customer endpoint connected to Amazon Connect.
RoutingCriteria (dict) --
Latest routing criteria on the contact.
Steps (list) --
List of routing steps. When Amazon Connect does not find an available agent meeting the requirements in a step for a given step duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue.
(dict) --
Step signifies the criteria to be used for routing to an agent
Expiry (dict) --
An object to specify the expiration of a routing step.
DurationInSeconds (integer) --
The number of seconds to wait before expiring the routing step.
ExpiryTimestamp (datetime) --
The timestamp indicating when the routing step expires.
Expression (dict) --
A tagged union to specify expression for a routing step.
AttributeCondition (dict) --
An object to specify the predefined attribute condition.
Name (string) --
The name of predefined attribute.
Value (string) --
The value of predefined attribute.
ProficiencyLevel (float) --
The proficiency level of the condition.
Range (dict) --
An Object to define the minimum and maximum proficiency levels.
MinProficiencyLevel (float) --
The minimum proficiency level of the range.
MaxProficiencyLevel (float) --
The maximum proficiency level of the range.
MatchCriteria (dict) --
An object to define AgentsCriteria.
AgentsCriteria (dict) --
An object to define agentIds.
AgentIds (list) --
An object to specify a list of agents, by user ID.
(string) --
ComparisonOperator (string) --
The operator of the condition.
AndExpression (list) --
List of routing expressions which will be AND-ed together.
(dict) --
A tagged union to specify expression for a routing step.
OrExpression (list) --
List of routing expressions which will be OR-ed together.
(dict) --
A tagged union to specify expression for a routing step.
NotAttributeCondition (dict) --
An object to specify the predefined attribute condition.
Name (string) --
The name of predefined attribute.
Value (string) --
The value of predefined attribute.
ProficiencyLevel (float) --
The proficiency level of the condition.
Range (dict) --
An Object to define the minimum and maximum proficiency levels.
MinProficiencyLevel (float) --
The minimum proficiency level of the range.
MaxProficiencyLevel (float) --
The maximum proficiency level of the range.
MatchCriteria (dict) --
An object to define AgentsCriteria.
AgentsCriteria (dict) --
An object to define agentIds.
AgentIds (list) --
An object to specify a list of agents, by user ID.
(string) --
ComparisonOperator (string) --
The operator of the condition.
Status (string) --
Represents status of the Routing step.
ActivationTimestamp (datetime) --
The timestamp indicating when the routing criteria is set to active. A routing criteria is activated when contact is transferred to a queue. ActivationTimestamp will be set on routing criteria for contacts in agent queue even though Routing criteria is never activated for contacts in agent queue.
Index (integer) --
Information about the index of the routing criteria.
Customer (dict) --
Information about the Customer on the contact.
DeviceInfo (dict) --
Information regarding Customer’s device.
PlatformName (string) --
Name of the platform that the participant used for the call.
PlatformVersion (string) --
Version of the platform that the participant used for the call.
OperatingSystem (string) --
Operating system that the participant used for the call.
Capabilities (dict) --
The configuration for the allowed video and screen sharing capabilities for participants present over the call. For more information, see Set up in-app, web, video calling, and screen sharing capabilities in the Amazon Connect Administrator Guide.
Video (string) --
The configuration having the video and screen sharing capabilities for participants over the call.
ScreenShare (string) --
The screen sharing capability that is enabled for the participant. SEND indicates the participant can share their screen.
Campaign (dict) --
Information associated with a campaign.
CampaignId (string) --
A unique identifier for a campaign.
AnsweringMachineDetectionStatus (string) --
Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect.
CustomerVoiceActivity (dict) --
Information about customer’s voice activity.
GreetingStartTimestamp (datetime) --
Timestamp that measures the beginning of the customer greeting from an outbound voice call.
GreetingEndTimestamp (datetime) --
Timestamp that measures the end of the customer greeting from an outbound voice call.
QualityMetrics (dict) --
Information about the quality of the participant's media connection.
Agent (dict) --
Information about the quality of Agent media connection.
Audio (dict) --
Information about the audio quality of the Agent
QualityScore (float) --
Number measuring the estimated quality of the media connection.
PotentialQualityIssues (list) --
List of potential issues causing degradation of quality on a media connection. If the service did not detect any potential quality issues the list is empty.
Valid values: HighPacketLoss | HighRoundTripTime | HighJitterBuffer
(string) --
Customer (dict) --
Information about the quality of Customer media connection.
Audio (dict) --
Information about the audio quality of the Customer
QualityScore (float) --
Number measuring the estimated quality of the media connection.
PotentialQualityIssues (list) --
List of potential issues causing degradation of quality on a media connection. If the service did not detect any potential quality issues the list is empty.
Valid values: HighPacketLoss | HighRoundTripTime | HighJitterBuffer
(string) --
ChatMetrics (dict) --
Information about how agent, bot, and customer interact in a chat contact.
ChatContactMetrics (dict) --
Information about the overall participant interactions at the contact level.
MultiParty (boolean) --
A boolean flag indicating whether multiparty chat or supervisor barge were enabled on this contact.
TotalMessages (integer) --
The number of chat messages on the contact.
TotalBotMessages (integer) --
The total number of bot and automated messages on a chat contact.
TotalBotMessageLengthInChars (integer) --
The total number of characters from bot and automated messages on a chat contact.
ConversationCloseTimeInMillis (integer) --
The time it took for a contact to end after the last customer message.
ConversationTurnCount (integer) --
The number of conversation turns in a chat contact, which represents the back-and-forth exchanges between customer and other participants.
AgentFirstResponseTimestamp (datetime) --
The agent first response timestamp for a chat contact.
AgentFirstResponseTimeInMillis (integer) --
The time for an agent to respond after obtaining a chat contact.
AgentMetrics (dict) --
Information about agent interactions in a contact.
ParticipantId (string) --
The Participant's ID.
ParticipantType (string) --
Information about the conversation participant. Following are the participant types: [Agent, Customer, Supervisor].
ConversationAbandon (boolean) --
A boolean flag indicating whether the chat conversation was abandoned by a Participant.
MessagesSent (integer) --
Number of chat messages sent by Participant.
NumResponses (integer) --
Number of chat messages sent by Participant.
MessageLengthInChars (integer) --
Number of chat characters sent by Participant.
TotalResponseTimeInMillis (integer) --
Total chat response time by Participant.
MaxResponseTimeInMillis (integer) --
Maximum chat response time by Participant.
LastMessageTimestamp (datetime) --
Timestamp of last chat message by Participant.
CustomerMetrics (dict) --
Information about customer interactions in a contact.
ParticipantId (string) --
The Participant's ID.
ParticipantType (string) --
Information about the conversation participant. Following are the participant types: [Agent, Customer, Supervisor].
ConversationAbandon (boolean) --
A boolean flag indicating whether the chat conversation was abandoned by a Participant.
MessagesSent (integer) --
Number of chat messages sent by Participant.
NumResponses (integer) --
Number of chat messages sent by Participant.
MessageLengthInChars (integer) --
Number of chat characters sent by Participant.
TotalResponseTimeInMillis (integer) --
Total chat response time by Participant.
MaxResponseTimeInMillis (integer) --
Maximum chat response time by Participant.
LastMessageTimestamp (datetime) --
Timestamp of last chat message by Participant.
DisconnectDetails (dict) --
Information about the call disconnect experience.
PotentialDisconnectIssue (string) --
Indicates the potential disconnection issues for a call. This field is not populated if the service does not detect potential issues.
AdditionalEmailRecipients (dict) --
List of additional email addresses for an email contact.
ToList (list) --
List of additional TO email recipients for an email contact.
(dict) --
Information about the email recipient
Address (string) --
Address of the email recipient.
DisplayName (string) --
Display name of the email recipient.
CcList (list) --
List of additional CC email recipients for an email contact.
(dict) --
Information about the email recipient
Address (string) --
Address of the email recipient.
DisplayName (string) --
Display name of the email recipient.
SegmentAttributes (dict) --
A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, connect:Guide or connect:SMS.
(string) --
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueString (string) --
The value of a segment attribute.
ValueMap (dict) --
The value of a segment attribute.
(string) --
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueInteger (integer) --
The value of a segment attribute.
ValueList (list) --
The value of a segment attribute. This is only supported for system-defined attributes, not for user-defined attributes.
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueArn (string) --
The value of a segment attribute that has to be a valid ARN. This is only supported for system-defined attributes, not for user-defined attributes.
Recordings (list) --
If recording was enabled, this is information about the recordings.
(dict) --
Information about a voice recording, chat transcript, or screen recording.
StorageType (string) --
Where the recording/transcript is stored.
Location (string) --
The location, in Amazon S3, for the recording/transcript.
MediaStreamType (string) --
Information about the media stream used during the conversation.
ParticipantType (string) --
Information about the conversation participant, whether they are an agent or contact. The participant types are as follows:
All
Manager
Agent
Customer
Thirdparty
Supervisor
FragmentStartNumber (string) --
The number that identifies the Kinesis Video Streams fragment where the customer audio stream started.
FragmentStopNumber (string) --
The number that identifies the Kinesis Video Streams fragment where the customer audio stream stopped.
StartTimestamp (datetime) --
When the conversation of the last leg of the recording started in UTC time.
StopTimestamp (datetime) --
When the conversation of the last leg of recording stopped in UTC time.
Status (string) --
The status of the recording/transcript.
DeletionReason (string) --
If the recording/transcript was deleted, this is the reason entered for the deletion.
DisconnectReason (string) --
The disconnect reason for the contact. For a list and description of all the possible disconnect reasons by channel, see DisconnectReason under ContactTraceRecord in the Amazon Connect Administrator Guide.
ContactEvaluations (dict) --
Information about the contact evaluations where the key is the FormId, which is a unique identifier for the form.
(string) --
(dict) --
Information about the contact evaluations where the key is the FormId, which is a unique identifier for the form.
FormId (string) --
The FormId of the contact evaluation.
EvaluationArn (string) --
The Amazon Resource Name for the evaluation form. It is always present.
Status (string) --
The status of the evaluation.
StartTimestamp (datetime) --
The date and time when the evaluation was started, in UTC time.
EndTimestamp (datetime) --
The date and time when the evaluation was submitted, in UTC time.
DeleteTimestamp (datetime) --
The date and time when the evaluation was deleted, in UTC time.
ExportLocation (string) --
The path where evaluation was exported.
TaskTemplateInfo (dict) --
If this contact was created using a task template, this contains information about the task template.
Arn (string) --
The Amazon Resource Name (ARN) of the task template used to create this contact.
Name (string) --
The name of the task template used to create this contact.
ContactDetails (dict) --
A map of string key/value pairs that contain user-defined attributes which are lightly typed within the contact. This object is used only for task contacts.
Name (string) --
The name of the contact details.
Description (string) --
Teh description of the contact details.
OutboundStrategy (dict) --
Information about the outbound strategy.
Type (string) --
Type of the outbound strategy.
Config (dict) --
Config of the outbound strategy.
AgentFirst (dict) --
The config of agent first outbound strategy.
Preview (dict) --
Information about preview configuration of agent first outbound strategy
PostAcceptTimeoutConfig (dict) --
Countdown timer configuration after the agent accepted the preview outbound contact.
DurationInSeconds (integer) --
Duration in seconds for the countdown timer after the agent accepted the contact.
AllowedUserActions (list) --
The actions the agent can perform after accepting the preview outbound contact.
(string) --
Attributes (dict) --
The attributes of the contact.
(string) --
(string) --
{'AliasConfigurations': [{'EmailAddressId': 'string'}]}
Describe email address form the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.describe_email_address(
InstanceId='string',
EmailAddressId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier of the email address.
dict
Response Syntax
{
'EmailAddressId': 'string',
'EmailAddressArn': 'string',
'EmailAddress': 'string',
'DisplayName': 'string',
'Description': 'string',
'CreateTimestamp': 'string',
'ModifiedTimestamp': 'string',
'AliasConfigurations': [
{
'EmailAddressId': 'string'
},
],
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
EmailAddressId (string) --
The identifier of the email address.
EmailAddressArn (string) --
The Amazon Resource Name (ARN) of the email address.
EmailAddress (string) --
The email address, including the domain.
DisplayName (string) --
The display name of email address
Description (string) --
The description of the email address.
CreateTimestamp (string) --
The email address creation timestamp in ISO 8601 Datetime.
ModifiedTimestamp (string) --
The email address last modification timestamp in ISO 8601 Datetime.
AliasConfigurations (list) --
A list of alias configurations associated with this email address. Contains details about email addresses that forward to this primary email address. The list can contain at most one alias configuration per email address.
(dict) --
Configuration information of an email alias.
EmailAddressId (string) --
The email address ID.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
{'EmailAddresses': {'AliasConfigurations': [{'EmailAddressId': 'string'}]}}
Searches email address in an instance, with optional filtering.
See also: AWS API Documentation
Request Syntax
client.search_email_addresses(
InstanceId='string',
MaxResults=123,
NextToken='string',
SearchCriteria={
'OrConditions': [
{'... recursive ...'},
],
'AndConditions': [
{'... recursive ...'},
],
'StringCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
}
},
SearchFilter={
'TagFilter': {
'OrConditions': [
[
{
'TagKey': 'string',
'TagValue': 'string'
},
],
],
'AndConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
],
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
}
}
}
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
integer
The maximum number of results to return per page.
string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
dict
The search criteria to be used to return email addresses.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
The search criteria to be used to return email addresses.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
The search criteria to be used to return email addresses.
StringCondition (dict) --
A leaf node condition which can be used to specify a string condition.
FieldName (string) --
The name of the field in the string condition.
Value (string) --
The value of the string.
ComparisonType (string) --
The type of comparison to be made when evaluating the string condition.
dict
Filters to be applied to search results.
TagFilter (dict) --
An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where:
Top level list specifies conditions that need to be applied with OR operator
Inner list specifies conditions that need to be applied with AND operator.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(list) --
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
TagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
dict
Response Syntax
{
'NextToken': 'string',
'EmailAddresses': [
{
'EmailAddressId': 'string',
'EmailAddressArn': 'string',
'EmailAddress': 'string',
'Description': 'string',
'DisplayName': 'string',
'AliasConfigurations': [
{
'EmailAddressId': 'string'
},
]
},
],
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
EmailAddresses (list) --
List of email addresses matching SearchFilter and SearchCriteria
(dict) --
Contains information about an email address for a contact center.
EmailAddressId (string) --
The identifier of the email address.
EmailAddressArn (string) --
The Amazon Resource Name (ARN) of the email address.
EmailAddress (string) --
The email address, including the domain.
Description (string) --
The description of the email address.
DisplayName (string) --
The display name of email address.
AliasConfigurations (list) --
A list of alias configurations for this email address, showing which email addresses forward to this primary address. Each configuration contains the email address ID of an alias that forwards emails to this address.
(dict) --
Configuration information of an email alias.
EmailAddressId (string) --
The email address ID.
ApproximateTotalCount (integer) --
The total number of email addresses which matched your search query.
{'OutboundStrategy': {'Config': {'AgentFirst': {'Preview': {'AllowedUserActions': ['CALL '
'| '
'DISCARD'],
'PostAcceptTimeoutConfig': {'DurationInSeconds': 'integer'}}}},
'Type': 'AGENT_FIRST'}}
Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in ContactFlowId).
Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.
There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.
See also: AWS API Documentation
Request Syntax
client.start_outbound_voice_contact(
Name='string',
Description='string',
References={
'string': {
'Value': 'string',
'Type': 'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE',
'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED',
'Arn': 'string',
'StatusReason': 'string'
}
},
RelatedContactId='string',
DestinationPhoneNumber='string',
ContactFlowId='string',
InstanceId='string',
ClientToken='string',
SourcePhoneNumber='string',
QueueId='string',
Attributes={
'string': 'string'
},
AnswerMachineDetectionConfig={
'EnableAnswerMachineDetection': True|False,
'AwaitAnswerMachinePrompt': True|False
},
CampaignId='string',
TrafficType='GENERAL'|'CAMPAIGN',
OutboundStrategy={
'Type': 'AGENT_FIRST',
'Config': {
'AgentFirst': {
'Preview': {
'PostAcceptTimeoutConfig': {
'DurationInSeconds': 123
},
'AllowedUserActions': [
'CALL'|'DISCARD',
]
}
}
}
}
)
string
The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).
string
A description of the voice contact that appears in the agent's snapshot in the CCP logs. For more information about CCP logs, see Download and review CCP logs in the Amazon Connect Administrator Guide.
dict
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during voice contact creation.
(string) --
(dict) --
Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
Value (string) --
A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
Type (string) -- [REQUIRED]
The type of the reference. DATE must be of type Epoch timestamp.
Status (string) --
Status of the attachment reference type.
Arn (string) --
The Amazon Resource Name (ARN) of the reference
StatusReason (string) --
Relevant details why the reference was not successfully created.
string
The contactId that is related to this contact. Linking voice, task, or chat by using RelatedContactID copies over contact attributes from the related contact to the new contact. All updates to user-defined attributes in the new contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using RelatedContactId.
string
[REQUIRED]
The phone number of the customer, in E.164 format.
string
[REQUIRED]
The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.
This field is autopopulated if not provided.
string
The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
string
The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the flow is used. If you do not specify a queue, you must specify a source phone number.
dict
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
(string) --
(string) --
dict
Configuration of the answering machine detection for this outbound call.
EnableAnswerMachineDetection (boolean) --
The flag to indicate if answer machine detection analysis needs to be performed for a voice call. If set to true, TrafficType must be set as CAMPAIGN.
AwaitAnswerMachinePrompt (boolean) --
Wait for the answering machine prompt.
string
The campaign identifier of the outbound communication.
string
Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The default value is GENERAL. Use CAMPAIGN if EnableAnswerMachineDetection is set to true. For all other cases, use GENERAL.
dict
Information about the outbound strategy.
Type (string) -- [REQUIRED]
Type of the outbound strategy.
Config (dict) --
Config of the outbound strategy.
AgentFirst (dict) --
The config of agent first outbound strategy.
Preview (dict) --
Information about preview configuration of agent first outbound strategy
PostAcceptTimeoutConfig (dict) -- [REQUIRED]
Countdown timer configuration after the agent accepted the preview outbound contact.
DurationInSeconds (integer) -- [REQUIRED]
Duration in seconds for the countdown timer after the agent accepted the contact.
AllowedUserActions (list) -- [REQUIRED]
The actions the agent can perform after accepting the preview outbound contact.
(string) --
dict
Response Syntax
{
'ContactId': 'string'
}
Response Structure
(dict) --
ContactId (string) --
The identifier of this contact within the Amazon Connect instance.