ListRealtimeContactAnalysisSegmentsV2
Provides a list of analysis segments for a real-time chat analysis session. This API supports CHAT channels only.
This API does not support VOICE. If you attempt to use it for VOICE, an InvalidRequestException
occurs.
Request Syntax
POST /contact/list-real-time-analysis-segments-v2/InstanceId/ContactId HTTP/1.1
Content-type: application/json
{
"ListFilter": {
"CategoriesAttributeFilter": {
"AndCondition": {
"TagConditions": [
{
"TagKey": "string",
"TagValue": "string"
}
]
},
"OrConditions": [
{
"TagConditions": [
{
"TagKey": "string",
"TagValue": "string"
}
]
}
],
"TagCondition": {
"TagKey": "string",
"TagValue": "string"
}
}
},
"MaxResults": number,
"NextToken": "string",
"OutputType": "string",
"SegmentTypes": [ "string" ]
}
URI Request Parameters
The request uses the following URI parameters.
- ContactId
-
The identifier of the contact in this instance of Connect Customer.
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
- InstanceId
-
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- ListFilter
-
A filter that restricts the segments returned by the API. When
SegmentTypesincludesCategories, useCategoriesAttributeFilterto return only the category segments whose rules have tags that match the filter. This enforces tag-based access control on the categories a caller can view.Type: RealTimeContactAnalysisSegmentsFilter object
Required: No
- MaxResults
-
The maximum number of results to return per page.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100000.
Required: No
- OutputType
-
The Contact Lens output type to be returned.
Type: String
Valid Values:
Raw | RedactedRequired: Yes
- SegmentTypes
-
Enum with segment types . Each value corresponds to a segment type returned in the segments list of the API. Each segment type has its own structure. Different channels may have different sets of supported segment types.
Type: Array of strings
Array Members: Maximum number of 7 items.
Valid Values:
Transcript | Categories | Issues | Event | Attachments | PostContactSummary | ExtractedInformationRequired: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Channel": "string",
"NextToken": "string",
"Segments": [
{ ... }
],
"Status": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Channel
-
The channel of the contact.
ImportantOnly
CHATis supported. This API does not supportVOICE. If you attempt to use it for the VOICE channel, anInvalidRequestExceptionerror occurs.Type: String
Valid Values:
VOICE | CHAT - NextToken
-
If there are additional results, this is the token for the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100000.
- Segments
-
An analyzed transcript or category.
Type: Array of RealtimeContactAnalysisSegment objects
- Status
-
Status of real-time contact analysis.
Type: String
Valid Values:
IN_PROGRESS | FAILED | COMPLETED
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403
- InternalServiceException
-
Request processing failed because of an error or failure with the service.
- Message
-
The message.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
- Message
-
The message about the request.
- Reason
-
Reason why the request was invalid.
HTTP Status Code: 400
- OutputTypeNotFoundException
-
Thrown for analyzed content when requested OutputType was not enabled for a given contact. For example, if an OutputType.Raw was requested for a contact that had `RedactedOnly` Redaction policy set in the flow.
HTTP Status Code: 404
- ResourceNotFoundException
-
The specified resource was not found.
- Message
-
The message about the resource.
HTTP Status Code: 404
- ThrottlingException
-
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: