Connect / Client / start_contact_recording

start_contact_recording#

Connect.Client.start_contact_recording(**kwargs)#

Starts recording the contact:

  • If the API is called before the agent joins the call, recording starts when the agent joins the call.

  • If the API is called after the agent joins the call, recording starts at the time of the API call.

StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can’t use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.

You can use this API to override the recording behavior configured in the Set recording behavior block.

Only voice recordings are supported at this time.

See also: AWS API Documentation

Request Syntax

response = client.start_contact_recording(
    InstanceId='string',
    ContactId='string',
    InitialContactId='string',
    VoiceRecordingConfiguration={
        'VoiceRecordingTrack': 'FROM_AGENT'|'TO_AGENT'|'ALL',
        'IvrRecordingTrack': 'ALL'
    }
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • ContactId (string) –

    [REQUIRED]

    The identifier of the contact.

  • InitialContactId (string) –

    [REQUIRED]

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

  • VoiceRecordingConfiguration (dict) –

    [REQUIRED]

    The person being recorded.

    • VoiceRecordingTrack (string) –

      Identifies which track is being recorded.

    • IvrRecordingTrack (string) –

      Identifies which IVR track is being recorded.

      One and only one of the track configurations should be presented in the request.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.InternalServiceException