- 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.
MonitorContactCommand
Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ConnectClient, MonitorContactCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, MonitorContactCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // MonitorContactRequest
InstanceId: "STRING_VALUE", // required
ContactId: "STRING_VALUE", // required
UserId: "STRING_VALUE", // required
AllowedMonitorCapabilities: [ // AllowedMonitorCapabilities
"SILENT_MONITOR" || "BARGE",
],
ClientToken: "STRING_VALUE",
};
const command = new MonitorContactCommand(input);
const response = await client.send(command);
// { // MonitorContactResponse
// ContactId: "STRING_VALUE",
// ContactArn: "STRING_VALUE",
// };
MonitorContactCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ContactIdRequired | string | undefined | The identifier of the contact. |
InstanceIdRequired | string | undefined | The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. |
UserIdRequired | string | undefined | The identifier of the user account. |
AllowedMonitorCapabilities | MonitorCapability[] | undefined | Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge. AllowedMonitorCapabilities is required if barge is enabled. |
ClientToken | string | undefined | A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs . |
MonitorContactCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
ContactArn | string | undefined | The ARN of the contact. |
ContactId | string | undefined | The identifier of the contact. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | You do not have sufficient permissions to perform this action. |
| IdempotencyException | client | An entity with the same name already exists. |
| 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. |
| ServiceQuotaExceededException | client | The service quota has been exceeded. |
| ThrottlingException | client | The throttling limit has been exceeded. |
| ConnectServiceException | Base exception class for all service exceptions from Connect service. |