SubmitContactEvaluation
Submits a contact evaluation in the specified Amazon Connect instance. Answers included
in the request are merged with existing answers for the given evaluation. If no answers or notes
are passed, the evaluation is submitted with the existing answers and notes. You can delete an
answer or note by passing an empty object ({}) to the question identifier.
If a contact evaluation is already in submitted state, this operation will trigger a resubmission.
Request Syntax
POST /contact-evaluations/InstanceId/EvaluationId/submit HTTP/1.1
Content-type: application/json
{
"Answers": {
"string" : {
"Value": { ... }
}
},
"Notes": {
"string" : {
"Value": "string"
}
}
}URI Request Parameters
The request uses the following URI parameters.
- EvaluationId
-
A unique identifier for the contact evaluation.
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: Yes
- InstanceId
-
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- Answers
-
A map of question identifiers to answer value.
Type: String to EvaluationAnswerInput object map
Map Entries: Maximum number of 100 items.
Key Length Constraints: Minimum length of 1. Maximum length of 500.
Required: No
- Notes
-
A map of question identifiers to note value.
Type: String to EvaluationNote object map
Map Entries: Maximum number of 100 items.
Key Length Constraints: Minimum length of 1. Maximum length of 500.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"EvaluationArn": "string",
"EvaluationId": "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.
- EvaluationArn
-
The Amazon Resource Name (ARN) for the contact evaluation resource.
Type: String
- EvaluationId
-
A unique identifier for the contact evaluation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceException
-
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500
- InvalidParameterException
-
One or more of the specified parameters are not valid.
HTTP Status Code: 400
- ResourceConflictException
-
A resource already has that name.
HTTP Status Code: 409
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
- ThrottlingException
-
The throttling limit has been exceeded.
HTTP Status Code: 429
Examples
Example
The following example submits a previously started contact evaluation.
Sample Request
{
"InstanceId": "[instance_id]",
"EvaluationId": "[evaluation_id]"
}Sample Response
{
"EvaluationId": "[evaluation_id]",
"EvaluationArn": "arn:aws:connect:[aws_region_code]:[account_id]:instance/[instance_id]/contact-evaluation/[evaluation_id]"
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
