| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Connect.StartContactRecording
Description
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.
Synopsis
- data StartContactRecording = StartContactRecording' {}
- newStartContactRecording :: Text -> Text -> Text -> VoiceRecordingConfiguration -> StartContactRecording
- startContactRecording_instanceId :: Lens' StartContactRecording Text
- startContactRecording_contactId :: Lens' StartContactRecording Text
- startContactRecording_initialContactId :: Lens' StartContactRecording Text
- startContactRecording_voiceRecordingConfiguration :: Lens' StartContactRecording VoiceRecordingConfiguration
- data StartContactRecordingResponse = StartContactRecordingResponse' {
- httpStatus :: Int
- newStartContactRecordingResponse :: Int -> StartContactRecordingResponse
- startContactRecordingResponse_httpStatus :: Lens' StartContactRecordingResponse Int
Creating a Request
data StartContactRecording Source #
See: newStartContactRecording smart constructor.
Constructors
| StartContactRecording' | |
Fields
| |
Instances
newStartContactRecording Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> VoiceRecordingConfiguration | |
| -> StartContactRecording |
Create a value of StartContactRecording with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartContactRecording, startContactRecording_instanceId - The identifier of the Amazon Connect instance. You can find the
instanceId in the ARN of the instance.
StartContactRecording, startContactRecording_contactId - The identifier of the contact.
StartContactRecording, startContactRecording_initialContactId - The identifier of the contact. This is the identifier of the contact
associated with the first interaction with the contact center.
$sel:voiceRecordingConfiguration:StartContactRecording', startContactRecording_voiceRecordingConfiguration - The person being recorded.
Request Lenses
startContactRecording_instanceId :: Lens' StartContactRecording Text Source #
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
startContactRecording_contactId :: Lens' StartContactRecording Text Source #
The identifier of the contact.
startContactRecording_initialContactId :: Lens' StartContactRecording Text Source #
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
startContactRecording_voiceRecordingConfiguration :: Lens' StartContactRecording VoiceRecordingConfiguration Source #
The person being recorded.
Destructuring the Response
data StartContactRecordingResponse Source #
See: newStartContactRecordingResponse smart constructor.
Constructors
| StartContactRecordingResponse' | |
Fields
| |
Instances
newStartContactRecordingResponse Source #
Create a value of StartContactRecordingResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StartContactRecordingResponse', startContactRecordingResponse_httpStatus - The response's http status code.
Response Lenses
startContactRecordingResponse_httpStatus :: Lens' StartContactRecordingResponse Int Source #
The response's http status code.