Connect / Client / monitor_contact

monitor_contact#

Connect.Client.monitor_contact(**kwargs)#

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

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

  • InstanceId (string) –

    [REQUIRED]

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

  • ContactId (string) –

    [REQUIRED]

    The identifier of the contact.

  • UserId (string) –

    [REQUIRED]

    The identifier of the user account.

  • AllowedMonitorCapabilities (list) –

    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.

    • (string) –

  • ClientToken (string) –

    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.

Return type:

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.

Exceptions