2020/07/17 - Amazon Connect Service - 4 new api methods
Changes This release adds a set of Amazon Connect APIs to programmatically control call recording with start, stop, pause and resume functions.
This API starts recording the contact when the agent joins the 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
client.start_contact_recording(
InstanceId='string',
ContactId='string',
InitialContactId='string',
VoiceRecordingConfiguration={
'VoiceRecordingTrack': 'FROM_AGENT'|'TO_AGENT'|'ALL'
}
)
string
[REQUIRED]
The identifier of the Amazon Connect instance.
string
[REQUIRED]
The identifier of the contact.
string
[REQUIRED]
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
dict
[REQUIRED]
Who is being recorded.
VoiceRecordingTrack (string) --
Identifies which track is being recorded.
dict
Response Syntax
{}
Response Structure
(dict) --
When a contact is being recorded, this API suspends recording the call. For example, you might suspend the call recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording.
The period of time that the recording is suspended is filled with silence in the final recording.
Only voice recordings are supported at this time.
See also: AWS API Documentation
Request Syntax
client.suspend_contact_recording(
InstanceId='string',
ContactId='string',
InitialContactId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance.
string
[REQUIRED]
The identifier of the contact.
string
[REQUIRED]
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
dict
Response Syntax
{}
Response Structure
(dict) --
When a contact is being recorded, this API stops recording the call. StopContactRecording is a one-time action. 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 it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.
Only voice recordings are supported at this time.
See also: AWS API Documentation
Request Syntax
client.stop_contact_recording(
InstanceId='string',
ContactId='string',
InitialContactId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance.
string
[REQUIRED]
The identifier of the contact.
string
[REQUIRED]
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
dict
Response Syntax
{}
Response Structure
(dict) --
When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call.
Only voice recordings are supported at this time.
See also: AWS API Documentation
Request Syntax
client.resume_contact_recording(
InstanceId='string',
ContactId='string',
InitialContactId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance.
string
[REQUIRED]
The identifier of the contact.
string
[REQUIRED]
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
dict
Response Syntax
{}
Response Structure
(dict) --