Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SuspendContactRecording

When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.

The period of time that the recording is suspended is filled with silence in the final recording.

Voice and screen recordings are supported.

Request Syntax


POST /contact/suspend-recording HTTP/1.1
Content-type: application/json

{
   "ContactId": "string",
   "ContactRecordingType": "string",
   "InitialContactId": "string",
   "InstanceId": "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

ContactRecordingType

The type of recording being operated on.

Type: String

Valid Values: AGENT | IVR | SCREEN

Required: No

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. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Type: String

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

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 because of an error or failure with the service.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404