Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

ListRealtimeContactAnalysisSegments

Provides a list of analysis segments for a real-time analysis session.

Request Syntax


POST /realtime-contact-analysis/analysis-segments HTTP/1.1
Content-type: application/json

{
   "ContactId": "string",
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ContactId

The identifier of the contact.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: .*\S.*

Required: Yes

InstanceId

The identifier of the Amazon Connect instance.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: .*\S.*

Required: Yes

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 131070.

Pattern: .*\S.*

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Segments": [ 
      { 
         "Categories": { 
            "MatchedCategories": [ "string" ],
            "MatchedDetails": { 
               "string" : { 
                  "PointsOfInterest": [ 
                     { 
                        "BeginOffsetMillis": number,
                        "EndOffsetMillis": number
                     }
                  ]
               }
            }
         },
         "PostContactSummary": { 
            "Content": "string",
            "FailureCode": "string",
            "Status": "string"
         },
         "Transcript": { 
            "BeginOffsetMillis": number,
            "Content": "string",
            "EndOffsetMillis": number,
            "Id": "string",
            "IssuesDetected": [ 
               { 
                  "CharacterOffsets": { 
                     "BeginOffsetChar": number,
                     "EndOffsetChar": number
                  }
               }
            ],
            "ParticipantId": "string",
            "ParticipantRole": "string",
            "Sentiment": "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.

NextToken

If there are additional results, this is the token for the next set of results. If response includes nextToken there are two possible scenarios:

There are more segments so another call is required to get them.
There are no more segments at this time, but more may be available later (real-time analysis is in progress) so the client should call the operation again to get new segments.

If response does not include nextToken, the analysis is completed (successfully or failed) and there are no more segments to retrieve.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 131070.

Pattern: .*\S.*

Segments

An analyzed transcript or category.

Type: Array of RealtimeContactAnalysisSegment objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServiceException

Request processing failed due to an error or failure with the service.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

Examples

Example

This example illustrates one usage of ListRealtimeContactAnalysisSegments.

Sample Request


POST /realtime-contact-analysis/analysis-segments
{
  "InstanceId": "eeeeeee-eeee-eeee-eeee-eeeeeeeeeeee",
  "ContactId": "11111111-1111-1111-1111-11111111111",
  "MaxResults": 50,
  "NextToken": "fdsfsadgdfsgdfgfdhfghfghfgjmbnmnm"
}

Sample Response


{
    "Segments": [
        {
            "Transcript": {
                "Id": "tttttttt-tttt-tttt-tttt-tttttttt",
                "ParticipantId": "AGENT",
                "ParticipantRole": "AGENT",
                "Content": "I can't login.",
                "BeginOffsetMillis": 19010,
                "EndOffsetMillis": 22690,
                "Sentiment": "NEUTRAL",
                "IssuesDetected": [
                    {
                        "CharacterOffsets": {
                            "BeginOffsetChar": 8,
                            "EndOffsetChar": 12
                        }
                    }
                ]
            }
        },
        {
            "Categories": {
                "MatchedCategories": [
                    "CreditCardRelated",
                    "CardBrokenIssue"
                ],
                "MatchedDetails": {
                    "CreditCardRelated": {
                        "PointsOfInterest": [
                            {
                                "BeginOffsetMillis": 19010,
                                "EndOffsetMillis": 22690
                            }
                        ]
                    },
                    "CardBrokenIssue": {
                        "PointsOfInterest": [
                            {
                                "BeginOffsetMillis": 25000,
                                "EndOffsetMillis": 29690
                            }
                        ]
                    }
                }
            }
        }
    ],
    "NextToken": "fdsfsadgdfsgdfgfdhfghfghfgjmbnmnm"
}