- DarkLight
Update Contact Attribute
- DarkLight
Overview
This API facilitates the modification of user-defined contact attributes associated with a designated contact. It enables the agents to update contact attributes, such as customer’s name or any other detail, during active or completed calls.
Pre-requisite
The Agent must be in the Logged in state.
Sequence Diagram
Message Structure
Request Parameters | Value |
---|---|
channel | Amazon |
topic | OutboundCall |
subtopic | Swap |
source | «app-name-broadcasting-this-message» |
data | JSON Object |
Data Parameters
Parameter | Data Type | Mandatory | Description | Sample Value |
---|---|---|---|---|
InitialContactID | String | Yes | The identifier of the contact. This is the identifier of the contact associated with the first Interaction with the Contact Center. | c65486b8a-a292-460d-a59c-a937e486106e |
ContactAttributes | JSON Object | Yes | The Amazon Connect attributes. These attributes can be accessed in contact flows, just like any other contact attributes. You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters. | "ContactAttributes": { "LCMKey": "791|485|582|0|0|44|59", "CallType": "Agent" |
Response Parameters | Value |
---|---|
channel | Amazon |
topic | OutboundCall |
subtopic | UpdateContactAttributeResponse |
Sample Request
{
"channel": "Amazon",
"topic": "OutboundCall",
"subtopic": "UpdateContactAttribute",
"source": "myapp",
"data": {
"InitialContactId": "c65486b8a-a292-460d-a59c-a937e486106e",
"ContactAttributes": {
"LCMKey": "791|485|582|0|0|44|59",
"CallType": "Agent",
"CampaignID": "SAMLHVOC",
"ContactNature": "Fresh",
"IsRequiredDisposition": "False",
"PacingMode": "DIRECT_PREVIEW"
}
}
}
Sample Response
{
"channel": "Amazon",
"topic": "OutboundCall",
"subtopic": "UpdateContactAttributeResponse",
"message": {
"response": true
}
}