StartVoiceToneAnalysisTask
Starts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics in the Amazon Chime SDK Developer Guide.
Important
Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the
AWS service terms
Request Syntax
POST /voice-connectors/VoiceConnectorId
/voice-tone-analysis-tasks HTTP/1.1
Content-type: application/json
{
"ClientRequestToken": "string
",
"LanguageCode": "string
",
"TransactionId": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- VoiceConnectorId
-
The Voice Connector ID.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*
Required: Yes
Request Body
The request accepts the following data in JSON format.
- ClientRequestToken
-
The unique identifier for the client request. Use a different token for different voice tone analysis tasks.
Type: String
Pattern:
^[-_a-zA-Z0-9]*${2,64}$
Required: No
- LanguageCode
-
The language code.
Type: String
Valid Values:
en-US
Required: Yes
- TransactionId
-
The transaction ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
.*\S.*
Required: Yes
Response Syntax
HTTP/1.1 201
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 201 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
- GoneException
-
Access to the target resource is no longer available at the origin server. This condition is likely to be permanent.
HTTP Status Code: 410
- NotFoundException
-
The requested resource couldn't be found.
HTTP Status Code: 404
- ResourceLimitExceededException
-
The request exceeds the resource limit.
HTTP Status Code: 400
- 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
- UnprocessableEntityException
-
A well-formed request couldn't be followed due to semantic errors.
HTTP Status Code: 422
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: