GetVoiceToneAnalysisTask - Amazon Chime SDK

GetVoiceToneAnalysisTask

Retrieves the details of a voice tone analysis task.

Request Syntax

GET /voice-connectors/VoiceConnectorId/voice-tone-analysis-tasks/VoiceToneAnalysisTaskId?isCaller=IsCaller HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

IsCaller

Specifies whether the voice being analyzed is the caller (originator) or the callee (responder).

Required: Yes

VoiceConnectorId

The Voice Connector ID.

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

Pattern: .*\S.*

Required: Yes

VoiceToneAnalysisTaskId

The ID of the voice tone analysis task.

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

Pattern: .*\S.*

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "VoiceToneAnalysisTask": { "CallDetails": { "IsCaller": boolean, "TransactionId": "string", "VoiceConnectorId": "string" }, "CreatedTimestamp": "string", "StartedTimestamp": "string", "StatusMessage": "string", "UpdatedTimestamp": "string", "VoiceToneAnalysisTaskId": "string", "VoiceToneAnalysisTaskStatus": "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.

VoiceToneAnalysisTask

The details of the voice tone analysis task.

Type: VoiceToneAnalysisTask object

Errors

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

AccessDeniedException

You don't have the permissions needed to run this action.

HTTP Status Code: 403

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

Multiple instances of the same request were made simultaneously.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: