- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
SuspendContactRecordingCommand
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.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ConnectClient, SuspendContactRecordingCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, SuspendContactRecordingCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // SuspendContactRecordingRequest
InstanceId: "STRING_VALUE", // required
ContactId: "STRING_VALUE", // required
InitialContactId: "STRING_VALUE", // required
ContactRecordingType: "AGENT" || "IVR" || "SCREEN",
};
const command = new SuspendContactRecordingCommand(input);
const response = await client.send(command);
// {};
SuspendContactRecordingCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ContactIdRequired | string | undefined | The identifier of the contact. |
InitialContactIdRequired | string | undefined | The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center. |
InstanceIdRequired | string | undefined | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. |
ContactRecordingType | ContactRecordingType | undefined | The type of recording being operated on. |
SuspendContactRecordingCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InternalServiceException | server | Request processing failed because of an error or failure with the service. |
| InvalidRequestException | client | The request is not valid. |
| ResourceNotFoundException | client | The specified resource was not found. |
| ConnectServiceException | Base exception class for all service exceptions from Connect service. |