2021/11/12 - Amazon Connect Service - 4 new 1 updated api methods
Changes This release adds APIs for creating and managing scheduled tasks. Additionally, adds APIs to describe and update a contact and list associated references.
Updates the scheduled time of a task contact that is already scheduled.
See also: AWS API Documentation
Request Syntax
client.update_contact_schedule(
InstanceId='string',
ContactId='string',
ScheduledTime=datetime(2015, 1, 1)
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
string
[REQUIRED]
The identifier of the contact.
datetime
[REQUIRED]
The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
dict
Response Syntax
{}
Response Structure
(dict) --
This API is in preview release for Amazon Connect and is subject to change.
Adds or updates user defined contact information associated with the specified contact. At least one field to be updated must be present in the request.
Warning
You can add or update user-defined contact information for both ongoing and completed contacts.
See also: AWS API Documentation
Request Syntax
client.update_contact(
InstanceId='string',
ContactId='string',
Name='string',
Description='string',
References={
'string': {
'Value': 'string',
'Type': 'URL'|'ATTACHMENT'
}
}
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
string
[REQUIRED]
The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.
string
The name of the contact.
string
The description of the contact.
dict
A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
(string) --
(dict) --
A link that an agent selects to complete a given task. You can have up to 4,096 UTF-8 bytes across all references for a contact.
Value (string) -- [REQUIRED]
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. Only URL type can be added or updated on a contact.
dict
Response Syntax
{}
Response Structure
(dict) --
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
Warning
Contact information is available in Amazon Connect for 24 months, and then it is deleted.
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 instanceId in the ARN of the instance.
string
[REQUIRED]
The identifier of the initial contact.
dict
Response Syntax
{
'Contact': {
'Arn': 'string',
'Id': 'string',
'InitialContactId': 'string',
'PreviousContactId': 'string',
'InitiationMethod': 'INBOUND'|'OUTBOUND'|'TRANSFER'|'QUEUE_TRANSFER'|'CALLBACK'|'API',
'Name': 'string',
'Description': 'string',
'Channel': 'VOICE'|'CHAT'|'TASK',
'QueueInfo': {
'Id': 'string',
'EnqueueTimestamp': datetime(2015, 1, 1)
},
'AgentInfo': {
'Id': 'string',
'ConnectedToAgentTimestamp': datetime(2015, 1, 1)
},
'InitiationTimestamp': datetime(2015, 1, 1),
'DisconnectTimestamp': datetime(2015, 1, 1),
'LastUpdateTimestamp': datetime(2015, 1, 1),
'ScheduledTimestamp': datetime(2015, 1, 1)
}
}
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.
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 identifier of the agent who accepted the contact.
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.
ConnectedToAgentTimestamp (datetime) --
The timestamp when the contact was connected to the agent.
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.
DisconnectTimestamp (datetime) --
The timestamp when the customer endpoint disconnected from Amazon Connect.
LastUpdateTimestamp (datetime) --
The timestamp when contact was last updated.
ScheduledTimestamp (datetime) --
The timestamp, in Unix epoch time format, at which to start running the inbound flow.
This API is in preview release for Amazon Connect and is subject to change.
For the specified referenceTypes , returns a list of references associated with the contact.
See also: AWS API Documentation
Request Syntax
client.list_contact_references(
InstanceId='string',
ContactId='string',
ReferenceTypes=[
'URL'|'ATTACHMENT',
],
NextToken='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
string
[REQUIRED]
The identifier of the initial contact.
list
[REQUIRED]
The type of reference.
(string) --
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.
Warning
This is not expected to be set since the value returned in the previous response is always null.
dict
Response Syntax
{
'ReferenceSummaryList': [
{
'Url': {
'Name': 'string',
'Value': 'string'
},
'Attachment': {
'Name': 'string',
'Value': 'string',
'Status': 'APPROVED'|'REJECTED'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ReferenceSummaryList (list) --
Information about the contact flows.
(dict) --
Contains summary information about a reference. ReferenceSummary contains only one non null field between the URL and attachment based on the reference type.
Url (dict) --
Information about Url reference if the referenceType is URL . Otherwise, null.
Name (string) --
Identifier of the URL reference.
Value (string) --
A valid URL.
Attachment (dict) --
Information about the attachment reference if the referenceType is ATTACHMENT . Otherwise, null.
Name (string) --
Identifier of the attachment reference.
Value (string) --
Contains the location path of the attachment reference.
Status (string) --
Status of an attachment reference type.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Warning
This is always returned as null in the response.
{'References': {'Type': {'ATTACHMENT'}}, 'ScheduledTime': 'timestamp'}
Initiates a contact flow to start a new task immediately or at a future date and time.
See also: AWS API Documentation
Request Syntax
client.start_task_contact(
InstanceId='string',
PreviousContactId='string',
ContactFlowId='string',
Attributes={
'string': 'string'
},
Name='string',
References={
'string': {
'Value': 'string',
'Type': 'URL'|'ATTACHMENT'
}
},
Description='string',
ClientToken='string',
ScheduledTime=datetime(2015, 1, 1)
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
string
The identifier of the previous chat, voice, or task contact.
string
[REQUIRED]
The identifier of the contact flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing , Contact Flows . Choose the contact flow. On the contact flow page, under the name of the contact 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
dict
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact 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) --
string
[REQUIRED]
The name of a task that is shown to an agent in the Contact Control Panel (CCP).
dict
A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
(string) --
(dict) --
A link that an agent selects to complete a given task. You can have up to 4,096 UTF-8 bytes across all references for a contact.
Value (string) -- [REQUIRED]
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. Only URL type can be added or updated on a contact.
string
A description of the task that is shown to an agent in the Contact Control Panel (CCP).
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
datetime
The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
dict
Response Syntax
{
'ContactId': 'string'
}
Response Structure
(dict) --
ContactId (string) --
The identifier of this contact within the Amazon Connect instance.