Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1429150124.9 KB

Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.

post/#X-Amz-Target=VoiceID.EvaluateSession

Headers

X-Amz-Target'VoiceID.EvaluateSession' required

Request body

DomainIdstring required

The identifier of the domain where the session started.

SessionNameOrIdstring required

The session identifier, or name of the session, that you want to evaluate. In Voice ID integration, this is the Contact-Id.

Response

Success

DomainIdstring

The identifier of the domain that contains the session.

SessionIdstring

The service-generated identifier of the session.

SessionNamestring

The client-provided name of the session.

StreamingStatus'PENDING_CONFIGURATION' | 'ONGOING' | 'ENDED'

The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is <code>NOT_ENOUGH_SPEECH</code>. In this situation, if the <code>StreamingStatus</code> is <code>ONGOING/PENDING_CONFIGURATION</code>, it can mean that the client should call the API again later, after Voice ID has enough audio to produce a result. If the decision remains <code>NOT_ENOUGH_SPEECH</code> even after <code>StreamingStatus</code> is <code>ENDED</code>, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.