Skip to content

Start Contact Evaluation

connect_start_contact_evaluation R Documentation

Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact

Description

Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.

Evaluations created through the public API do not contain answer values suggested from automation.

Usage

connect_start_contact_evaluation(InstanceId, ContactId,
  EvaluationFormId, ClientToken)

Arguments

InstanceId

[required] The identifier of the Amazon Connect 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 Amazon Connect.

EvaluationFormId

[required] The unique identifier for the evaluation form.

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(
  EvaluationId = "string",
  EvaluationArn = "string"
)

Request syntax

svc$start_contact_evaluation(
  InstanceId = "string",
  ContactId = "string",
  EvaluationFormId = "string",
  ClientToken = "string"
)