Show / Hide Table of Contents

Calls.AccessMedia.All

Allows the app to get direct access to media streams in a call, without a signed-in user.

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver Type Method
V1 A DELETE /app/calls/{id}
V1 A DELETE /communications/calls/{id}
V1 A GET /app/calls/{id}
V1 A GET /app/calls/{id}/participants
V1 A GET /communications/calls/{id}
V1 A GET /communications/calls/{id}/participants
V1 A POST /app/calls/{id}/cancelMediaProcessing
V1 A POST /app/calls/{id}/changeScreenSharingRole
V1 A POST /app/calls/{id}/mute
V1 A POST /app/calls/{id}/playPrompt
V1 A POST /app/calls/{id}/recordResponse
V1 A POST /app/calls/{id}/subscribeToTone
V1 A POST /app/calls/{id}/unmute
V1 A POST /app/calls/{id}/updateRecordingStatus
V1 A POST /communications/calls/{id}/cancelMediaProcessing
V1 A POST /communications/calls/{id}/changeScreenSharingRole
V1 A POST /communications/calls/{id}/keepAlive
V1 A POST /communications/calls/{id}/mute
V1 A POST /communications/calls/{id}/playPrompt
V1 A POST /communications/calls/{id}/recordResponse
V1 A POST /communications/calls/{id}/subscribeToTone
V1 A POST /communications/calls/{id}/unmute
V1 A POST /communications/calls/{id}/updateRecordingStatus
V1 A POST /communications/calls/logTeleconferenceDeviceQuality

Application Permission

Id a7a681dc-756e-4909-b988-f160edc6655f
Display String Access media streams in a call as an app
Description Allows the app to get direct access to media streams in a call, without a signed-in user.

Resources

call

Property Type Description
callbackUri String The callback URL on which callbacks will be delivered. Must be https.
callChainId String A unique identifier for all the participant calls in a conference or a unique identifier for two participant calls in a P2P call. This needs to be copied over from Microsoft.Graph.Call.CallChainId.
callOptions outgoingCallOptions Contains the optional features for the call.
callRoutes callRoute collection The routing information on how the call was retargeted. Read-only.
chatInfo chatInfo The chat information. Required information for joining a meeting.
direction callDirection The direction of the call. The possible value are incoming or outgoing. Read-only.
id String The unique identifier for the call. Read-only.
incomingContext incomingContext Call context associated with an incoming call.
mediaConfig appHostedMediaConfig or serviceHostedMediaConfig The media configuration. Required.
mediaState callMediaState Read-only. The call media state.
meetingInfo organizerMeetingInfo, tokenMeetingInfo, or joinMeetingIdMeetingInfo The meeting information. Required information for meeting scenarios.
myParticipantId String Read-only.
requestedModalities modality collection The list of requested modalities. Possible values are: unknown, audio, video, videoBasedScreenSharing, data.
resultInfo resultInfo The result information. For example can hold termination reason. Read-only.
source participantInfo The originator of the call.
state callState The call state. Possible values are: incoming, establishing, ringing, established, hold, transferring, transferAccepted, redirecting, terminating, terminated. Read-only.
subject String The subject of the conversation.
targets invitationParticipantInfo collection The targets of the call. Required information for creating peer to peer call.
toneInfo toneInfo Read-only.
transcription callTranscriptionInfo The transcription information for the call. Read-only.

commsOperation

Property Type Description
clientContext String Unique Client Context string. Max limit is 256 chars.
id String The operation ID. Read-only.
resultInfo resultInfo The result information. Read-only.
status String Possible values are: notStarted, running, completed, failed. Read-only.

mediaPrompt

Property Type Description
mediaInfo mediaInfo The media information

MuteParticipantOperation

Property Type Description
clientContext String Unique client context string. Can have a maximum of 256 characters.
id String The server operation ID. Read-only.
resultInfo resultInfo The result information. Read-only.
status String Possible values are: notStarted, running, completed, failed. Read-only.

participant

Property Type Description
id String The participant ID.
info participantInfo Information about the participant.
isInLobby Boolean true if the participant is in lobby.
isMuted Boolean true if the participant is muted (client or server muted).
mediaStreams mediaStream collection The list of media streams.
metadata String A blob of data provided by the participant in the roster.
recordingInfo recordingInfo Information about whether the participant has recording capability.

playPromptOperation

Property Type Description
clientContext String Unique Client Context string. Max limit is 256 chars.
id String Read-only.
resultInfo resultInfo The result information. Read-only.
status String Possible values are: notStarted, running, completed, failed.

recordOperation

Property Type Description
clientContext String Unique Client Context string. Max limit is 256 chars.
id String The server operation id. Read-only.
recordingAccessToken String The access token required to retrieve the recording.
recordingLocation String The location where the recording is located.
resultInfo resultInfo The result information. Read-only.
status String Possible values are: notStarted, running, completed, failed. Read-only.

serviceHostedMediaConfig

Property Type Description
preFetchMedia mediaInfo collection The list of media to pre-fetch.

teleconferenceDeviceQuality

Property Type Description
callChainId Guid A unique identifier for all the participant calls in a conference or a unique identifier for two participant calls in P2P call. This needs to be copied over from Microsoft.Graph.Call.CallChainId.
cloudServiceDeploymentEnvironment String A geo-region where the service is deployed, such as ProdNoam.
cloudServiceDeploymentId String A unique deployment identifier assigned by Azure.
cloudServiceInstanceName String The Azure deployed cloud service instance name, such as FrontEnd_IN_3.
cloudServiceName String The Azure deployed cloud service name, such as contoso.cloudapp.net.
deviceDescription String Any additional description, such as VTC Bldg 30/21.
deviceName String The user media agent name, such as Cisco SX80.
mediaLegId Guid A unique identifier for a specific media leg of a participant in a conference. One participant can have multiple media leg identifiers if retargeting happens. CVI partner assigns this value.
mediaQualityList teleconferenceDeviceMediaQuality collection The list of media qualities in a media session (call), such as audio quality, video quality, and/or screen sharing quality.
participantId Guid A unique identifier for a specific participant in a conference. The CVI partner needs to copy over Call.MyParticipantId to this property.

toneInfo

Property Type Description
sequenceId Int64 An incremental identifier used for ordering DTMF events.
tone tone Possible values are: tone0, tone1, tone2, tone3, tone4, tone5, tone6, tone7, tone8, tone9, star, pound, a, b, c, d, flash.

updateRecordingStatusOperation

Property Type Description
clientContext String Unique client context string. Max limit is 256 chars.
id String Read-only.
resultInfo resultInfo The result information. Read-only.
status String Possible values are: notStarted, running, completed, failed.
In This Article
Back to top Created by merill | Submit feedback