call_media

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

Overview

Name	call_media
Type	Resource
Id	azure.communication_call_automation.call_media

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
play	exec	call_connection_id, endpoint, playSources		Plays audio to participants in the call. Plays audio to participants in the call.
start_transcription	exec	call_connection_id, endpoint		Starts transcription in the call. Starts transcription in the call.
stop_transcription	exec	call_connection_id, endpoint		Stops transcription in the call. Stops transcription in the call.
update_transcription	exec	call_connection_id, endpoint		UpdateTranscription Api. API to change transcription language.
cancel_all_media_operations	exec	call_connection_id, endpoint		Cancel all media operations in a call. Cancel all media operations in a call.
recognize	exec	call_connection_id, endpoint, recognizeInputType, recognizeOptions		Recognize media from call. Recognize media from call.
start_continuous_dtmf_recognition	exec	call_connection_id, endpoint, targetParticipant		Start continuous Dtmf recognition by subscribing to tones. Start continuous Dtmf recognition by subscribing to tones.
stop_continuous_dtmf_recognition	exec	call_connection_id, endpoint, targetParticipant		Stop continuous Dtmf recognition by unsubscribing to tones. Stop continuous Dtmf recognition by unsubscribing to tones.
send_dtmf_tones	exec	call_connection_id, endpoint, tones, targetParticipant		Send dtmf tones. Send dtmf tones.
hold	exec	call_connection_id, endpoint, targetParticipant		Hold participant from the call using identifier. Hold participant from the call using identifier.
unhold	exec	call_connection_id, endpoint, targetParticipant		Unhold participants from the call using identifier. Unhold participants from the call using identifier.
start_media_streaming	exec	call_connection_id, endpoint		Starts media streaming in the call. Starts media streaming in the call.
stop_media_streaming	exec	call_connection_id, endpoint		Stops media streaming in the call. Stops media streaming in 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
call_connection_id	string	The call connection id. Required.
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )

Lifecycle Methods

play

Plays audio to participants in the call. Plays audio to participants in the call.

EXEC azure.communication_call_automation.call_media.play 
@call_connection_id='{{ call_connection_id }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"playSources": "{{ playSources }}", 
"playTo": "{{ playTo }}", 
"interruptCallMediaOperation": {{ interruptCallMediaOperation }}, 
"playOptions": "{{ playOptions }}", 
"operationContext": "{{ operationContext }}", 
"operationCallbackUri": "{{ operationCallbackUri }}"
}'
;

start_transcription

Starts transcription in the call. Starts transcription in the call.

EXEC azure.communication_call_automation.call_media.start_transcription 
@call_connection_id='{{ call_connection_id }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"locale": "{{ locale }}", 
"speechModelEndpointId": "{{ speechModelEndpointId }}", 
"operationContext": "{{ operationContext }}", 
"operationCallbackUri": "{{ operationCallbackUri }}"
}'
;

stop_transcription

Stops transcription in the call. Stops transcription in the call.

EXEC azure.communication_call_automation.call_media.stop_transcription 
@call_connection_id='{{ call_connection_id }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"operationContext": "{{ operationContext }}", 
"operationCallbackUri": "{{ operationCallbackUri }}"
}'
;

update_transcription

UpdateTranscription Api. API to change transcription language.

EXEC azure.communication_call_automation.call_media.update_transcription 
@call_connection_id='{{ call_connection_id }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"locale": "{{ locale }}", 
"speechModelEndpointId": "{{ speechModelEndpointId }}", 
"operationContext": "{{ operationContext }}", 
"operationCallbackUri": "{{ operationCallbackUri }}"
}'
;

cancel_all_media_operations

Cancel all media operations in a call. Cancel all media operations in a call.

EXEC azure.communication_call_automation.call_media.cancel_all_media_operations 
@call_connection_id='{{ call_connection_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

recognize

Recognize media from call. Recognize media from call.

EXEC azure.communication_call_automation.call_media.recognize 
@call_connection_id='{{ call_connection_id }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"recognizeInputType": "{{ recognizeInputType }}", 
"playPrompt": "{{ playPrompt }}", 
"playPrompts": "{{ playPrompts }}", 
"interruptCallMediaOperation": {{ interruptCallMediaOperation }}, 
"recognizeOptions": "{{ recognizeOptions }}", 
"operationContext": "{{ operationContext }}", 
"operationCallbackUri": "{{ operationCallbackUri }}"
}'
;

start_continuous_dtmf_recognition

Start continuous Dtmf recognition by subscribing to tones. Start continuous Dtmf recognition by subscribing to tones.

EXEC azure.communication_call_automation.call_media.start_continuous_dtmf_recognition 
@call_connection_id='{{ call_connection_id }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"targetParticipant": "{{ targetParticipant }}", 
"operationContext": "{{ operationContext }}", 
"operationCallbackUri": "{{ operationCallbackUri }}"
}'
;

stop_continuous_dtmf_recognition

Stop continuous Dtmf recognition by unsubscribing to tones. Stop continuous Dtmf recognition by unsubscribing to tones.

EXEC azure.communication_call_automation.call_media.stop_continuous_dtmf_recognition 
@call_connection_id='{{ call_connection_id }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"targetParticipant": "{{ targetParticipant }}", 
"operationContext": "{{ operationContext }}", 
"operationCallbackUri": "{{ operationCallbackUri }}"
}'
;

send_dtmf_tones

Send dtmf tones. Send dtmf tones.

EXEC azure.communication_call_automation.call_media.send_dtmf_tones 
@call_connection_id='{{ call_connection_id }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"tones": "{{ tones }}", 
"targetParticipant": "{{ targetParticipant }}", 
"operationContext": "{{ operationContext }}", 
"operationCallbackUri": "{{ operationCallbackUri }}"
}'
;

hold

Hold participant from the call using identifier. Hold participant from the call using identifier.

EXEC azure.communication_call_automation.call_media.hold 
@call_connection_id='{{ call_connection_id }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"targetParticipant": "{{ targetParticipant }}", 
"playSourceInfo": "{{ playSourceInfo }}", 
"operationContext": "{{ operationContext }}", 
"operationCallbackUri": "{{ operationCallbackUri }}"
}'
;

unhold

Unhold participants from the call using identifier. Unhold participants from the call using identifier.

EXEC azure.communication_call_automation.call_media.unhold 
@call_connection_id='{{ call_connection_id }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"targetParticipant": "{{ targetParticipant }}", 
"operationContext": "{{ operationContext }}", 
"operationCallbackUri": "{{ operationCallbackUri }}"
}'
;

start_media_streaming

Starts media streaming in the call. Starts media streaming in the call.

EXEC azure.communication_call_automation.call_media.start_media_streaming 
@call_connection_id='{{ call_connection_id }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"operationCallbackUri": "{{ operationCallbackUri }}", 
"operationContext": "{{ operationContext }}"
}'
;

stop_media_streaming

Stops media streaming in the call. Stops media streaming in the call.

EXEC azure.communication_call_automation.call_media.stop_media_streaming 
@call_connection_id='{{ call_connection_id }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"operationCallbackUri": "{{ operationCallbackUri }}", 
"operationContext": "{{ operationContext }}"
}'
;