Skip to content

Starts a Contact Lens post-call analytics job for the specified contact

Description

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.

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

For example, you can call create_contact, then create_attached_file, then start_contact_conversational_analytics_job to create a contact, attach a recording, and run post-call analytics.

Usage

connect_start_contact_conversational_analytics_job(InstanceId,
  ContactId, AnalyticsModes, AnalyticsConfiguration, ClientToken)

Arguments

  • InstanceId

[required] The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • ContactId

[required] The identifier of the contact in this instance of Connect Customer.

  • AnalyticsModes

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

  • AnalyticsConfiguration

[required] The configuration for the conversational analytics job.

  • ClientToken

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

Value

A list with the following syntax:

list(
  InstanceId = "string",
  ContactId = "string"
)

Request syntax

svc$start_contact_conversational_analytics_job(
  InstanceId = "string",
  ContactId = "string",
  AnalyticsModes = list(
    "PostContact"|"RealTime"|"ContactLens"|"AutomatedInteraction"
  ),
  AnalyticsConfiguration = list(
    LanguageConfiguration = list(
      LanguageLocale = "string"
    ),
    RedactionConfiguration = list(
      Behavior = "Enable"|"Disable",
      Policy = "None"|"RedactedOnly"|"RedactedAndOriginal",
      Entities = list(
        "string"
      ),
      MaskMode = "PII"|"EntityType"
    ),
    SentimentConfiguration = list(
      Behavior = "Enable"|"Disable"
    ),
    SummaryConfiguration = list(
      SummaryModes = list(
        "PostContact"|"AutomatedInteraction"|"ContactChain"
      )
    ),
    RulesConfiguration = list(
      Behavior = "Enable"|"Disable"
    )
  ),
  ClientToken = "string"
)