Amazon Connect Service

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.

See also: AWS API Documentation

Request Syntax

client.monitor_contact(
    InstanceId='string',
    ContactId='string',
    UserId='string',
    AllowedMonitorCapabilities=[
        'SILENT_MONITOR'|'BARGE',
    ],
    ClientToken='string'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type ContactId

string

param ContactId

[REQUIRED]

The identifier of the contact.

type UserId

string

param UserId

[REQUIRED]

The identifier of the user account.

type AllowedMonitorCapabilities

list

param AllowedMonitorCapabilities

Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge.

• (string) --

type ClientToken

string

param ClientToken

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.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'ContactId': 'string',
    'ContactArn': 'string'
}

Response Structure

• (dict) --

  • ContactId (string) --

    The identifier of the contact.

  • ContactArn (string) --

    The ARN of the contact.