call_recording

Creates, updates, deletes, gets or lists a call_recording resource.

Overview

Name	call_recording
Type	Resource
Id	azure.communication_call_automation.call_recording

Fields

The following fields are returned by SELECT queries:

get_recording_properties

Name	Datatype	Description
recordingId	string	:vartype recording_id: str
recordingKind	string	Known values are: "azureCommunicationServices", "teams", and "teamsCompliance".
recordingState	string	Known values are: "active" and "inactive".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_recording_properties	select	recording_id, endpoint		Get call recording properties. Get call recording properties.
stop_recording	delete	recording_id, endpoint		Stop recording the call. Stop recording the call.
start_recording	exec	endpoint		Start recording the call. Start recording the call.
pause_recording	exec	recording_id, endpoint		Pause recording the call. Pause recording the call.
resume_recording	exec	recording_id, endpoint		Resume recording the call. Resume recording the call.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
recording_id	string	The recording id. Required.

SELECT examples

get_recording_properties

Get call recording properties. Get call recording properties.

SELECT
recordingId,
recordingKind,
recordingState
FROM azure.communication_call_automation.call_recording
WHERE recording_id = '{{ recording_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

DELETE examples

stop_recording

Stop recording the call. Stop recording the call.

DELETE FROM azure.communication_call_automation.call_recording
WHERE recording_id = '{{ recording_id }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

start_recording

Start recording the call. Start recording the call.

EXEC azure.communication_call_automation.call_recording.start_recording 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"callLocator": "{{ callLocator }}", 
"callConnectionId": "{{ callConnectionId }}", 
"recordingStateCallbackUri": "{{ recordingStateCallbackUri }}", 
"recordingContentType": "{{ recordingContentType }}", 
"recordingChannelType": "{{ recordingChannelType }}", 
"recordingFormatType": "{{ recordingFormatType }}", 
"audioChannelParticipantOrdering": "{{ audioChannelParticipantOrdering }}", 
"channelAffinity": "{{ channelAffinity }}", 
"pauseOnStart": {{ pauseOnStart }}, 
"externalStorage": "{{ externalStorage }}"
}'
;

pause_recording

Pause recording the call. Pause recording the call.

EXEC azure.communication_call_automation.call_recording.pause_recording 
@recording_id='{{ recording_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

resume_recording

Resume recording the call. Resume recording the call.

EXEC azure.communication_call_automation.call_recording.resume_recording 
@recording_id='{{ recording_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;