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

StartContactConversationalAnalyticsJob

Starts a Contact Lens post-call analytics job for the specified contact. This API runs Conversational Analytics post-contact analysis on a voice recording that is already attached to the contact, generating transcription, sentiment analysis, redaction, and summarization results based on the provided configuration.

Important

A voice recording must already be attached to the contact before calling this API. Use CreateAttachedFile to attach a recording from an S3 source URI.

Note

For example, you can call CreateContact, then CreateAttachedFile, then StartContactConversationalAnalyticsJob to create a contact, attach a recording, and run post-call analytics.

Request Syntax


POST /contact/start-conversational-analytics-job/InstanceId/ContactId HTTP/1.1
Content-type: application/json

{
   "AnalyticsConfiguration": { 
      "LanguageConfiguration": { 
         "LanguageLocale": "string"
      },
      "RedactionConfiguration": { 
         "Behavior": "string",
         "Entities": [ "string" ],
         "MaskMode": "string",
         "Policy": "string"
      },
      "RulesConfiguration": { 
         "Behavior": "string"
      },
      "SentimentConfiguration": { 
         "Behavior": "string"
      },
      "SummaryConfiguration": { 
         "SummaryModes": [ "string" ]
      }
   },
   "AnalyticsModes": [ "string" ],
   "ClientToken": "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.

AnalyticsConfiguration

The configuration for the conversational analytics job.

Type: AnalyticsConfiguration object

Required: Yes

AnalyticsModes

The analytics modes to run for the contact. Valid values: PostContact.

Type: Array of strings

Valid Values: PostContact | RealTime | ContactLens | AutomatedInteraction

Required: Yes

ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Type: String

Length Constraints: Maximum length of 500.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ContactId": "string",
   "InstanceId": "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.

ContactId

The identifier of the contact.

Type: String

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

InstanceId

The identifier of the Connect Customer instance.

Type: String

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

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

IdempotencyException

An entity with the same name already exists.

HTTP Status Code: 409

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

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