StartContactRecording - Amazon Connect Service

StartContactRecording

This API starts recording the contact when the agent joins the call. StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.

You can use this API to override the recording behavior configured in the Set recording behavior block.

Only voice recordings are supported at this time.

Request Syntax

POST /contact/start-recording HTTP/1.1 Content-type: application/json { "ContactId": "string", "InitialContactId": "string", "InstanceId": "string", "VoiceRecordingConfiguration": { "VoiceRecordingTrack": "string" } }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ContactId

The identifier of the contact.

Type: String

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

Required: Yes

InitialContactId

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

Type: String

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

Required: Yes

InstanceId

The identifier of the Amazon Connect instance.

Type: String

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

Required: Yes

VoiceRecordingConfiguration

Who is being recorded.

Type: VoiceRecordingConfiguration object

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

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

InternalServiceException

Request processing failed due to 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

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

See Also

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