Show / Hide Table of Contents

Calls.Initiate.All

Allows the app to place outbound calls to a single user and transfer calls to users in your organization’s directory, 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}/contentSharingSessions
V1 A GET /communications/calls/{id}/contentSharingSessions/{id}
V1 A GET /communications/calls/{id}/participants
V1 A POST /app/calls
V1 A POST /app/calls/{id}/cancelMediaProcessing
V1 A POST /app/calls/{id}/mute
V1 A POST /app/calls/{id}/playPrompt
V1 A POST /app/calls/{id}/redirect
V1 A POST /app/calls/{id}/transfer
V1 A POST /app/calls/{id}/unmute
V1 A POST /communications/calls
V1 A POST /communications/calls/{id}/cancelMediaProcessing
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}/redirect
V1 A POST /communications/calls/{id}/transfer
V1 A POST /communications/calls/{id}/unmute

Application Permission

Id 284383ee-7f6e-4e40-a2a8-e85dcb029101
Display String Initiate outgoing 1 to 1 calls from the app
Description Allows the app to place outbound calls to a single user and transfer calls to users in your organization’s directory, without a signed-in user.

Resources

appHostedMediaConfig

Property Type Description
blob String The media configuration blob generated by smart media agent.

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.

contentSharingSession

Property Type Description
id String Unique identifier for the content sharing session. Read-only. Inherited from entity.

identitySet

Property Type Description
application identity Optional. The application associated with this action.
device identity Optional. The device associated with this action.
user identity Optional. The user associated with this action.

invitationParticipantInfo

Property Type Description
hidden Boolean Optional. Whether to hide the participant from the roster.
identity identitySet The identitySet associated with this invitation.
participantId String Optional. The ID of the target participant.
removeFromDefaultAudioRoutingGroup Boolean Optional. Whether to remove them from the main mixer.
replacesCallId String Optional. The call which the target identity is currently a part of. For peer-to-peer case, the call will be dropped once the participant is added successfully.

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.

participantInfo

Property Type Description
countryCode String The ISO 3166-1 Alpha-2 country code of the participant's best estimated physical location at the start of the call. Read-only.
endpointType String The type of endpoint the participant is using. Possible values are: default, skypeForBusiness, or skypeForBusinessVoipPhone. Read-only.
identity identitySet The identitySet associated with this participant. Read-only.
languageId String The language culture string. Read-only.
participantId String The participant ID of the participant. Read-only.
region String The home region of the participant. This can be a country, a continent, or a larger geographic region. This does not change based on the participant's current physical location. Read-only.

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.

serviceHostedMediaConfig

Property Type Description
preFetchMedia mediaInfo collection The list of media to pre-fetch.
In This Article
Back to top Created by merill | Submit feedback