call-Ressourcentypcall resource type

Wichtig

APIs unter der /beta Version in Microsoft Graph können Änderungen unterworfen werden.APIs under the /beta version in Microsoft Graph are subject to change. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt.Use of these APIs in production applications is not supported.

Die call-Ressource wird erstellt, wenn es einen eingehenden Anruf für die Anwendung gibt oder die Anwendung einen neuen ausgehenden Anruf über POST in app/calls erstellt.The call resource is created when there is an incoming call for the application or the application creates a new outgoing call via a POST on app/calls.

Anrufe können als Peer-to-Peer-Anruf oder als Anruf mit mehreren Teilnehmern eingerichtet werden.Calls can be set up as a peer-to-peer or as a multiparty call. Geben Sie zum Erstellen oder Beitreten eines Anrufs mit mehreren Teilnehmern chatInfo und meetingInfo an.For creating or joining a multiparty call, supply the chatInfo and meetingInfo. Wenn Sie diese Informationen nicht angeben, wird automatisch eine neue Ad-hoc-Besprechung erstellt.If these are not supplied, a new ad hoc meeting is created automatically. Zeichnen Sie diese Werte für einen eingehenden Anruf in einem hoch verfügbaren Speicher auf, damit die Anwendung dem Anruf erneut beitreten kann, falls sie abstürzt.For an incoming call, record these values in a highly available store, so that your application to rejoin the call in the event your application crashes.

Dieselbe Identität kann zwar nicht mehrere Male verwendet werden, eine Anwendung kann aber derselben Besprechung mehrere Male beitreten.Although the same identity cannot be invited multiple times, it is possible for an application to join the same meeting multiple times. Jedes Mal, wenn die Anwendung beitritt, wird ein anderer Anruf id für diesen Anruf für die Besprechung bereitgestellt.Each time the application joins, a distinct call id is provided for that call to the meeting. Es wird empfohlen, dass Sie separate Identitäten verwenden, um an der Besprechung teilzunehmen, damit diese in den Clients als unterschiedliche Teilnehmer angezeigt werden.We recommend that you use separate identities to join the meeting in order for the clients to display them as different participants.

MethodenMethods

MethodeMethod RückgabetypReturn Type BeschreibungDescription
Get callGet call callcall Lesen der Eigenschaften des call-Objekts.Read properties of the call object.
DeleteDelete Löschen oder Auflegen eines aktiven Anrufs.Delete or Hang-up an active call.
AnrufverarbeitungCall Handling
AnswerAnswer Beantworten eines eingehenden Anrufs.Answer an incoming call.
RejectReject Ablehnen eines eingehenden Anrufs.Reject an incoming call.
RedirectRedirect Umleiten eines eingehenden Anrufs.Redirect an incoming call.
TransferTransfer Weiterleiten eines Anrufs.Transfer a call
Mehrere TeilnehmerMulti-party
List participantsList participants participant-Auflistungparticipant collection Abrufen einer Auflistung von Teilnehmerobjekten.Get a participant object collection.
Invite ParticipantsInvite Participants commsOperationcommsOperation Einladen von Teilnehmern zum aktiven Anruf.Invite participants to the active call.
Mute All ParticipantsMute All Participants commsOperationcommsOperation Stummschalten aller Teilnehmer in dem Anruf.Mute all participants in the call.
Configure Audio MixerConfigure Audio Mixer commsOperationcommsOperation Konfigurieren von Audio in der Unterhaltung mit mehreren Teilnehmern.Configure audio in multiparty conversation.
Create audioRoutingGroupCreate audioRoutingGroup audioRoutingGroupaudioRoutingGroup Erstellen einer neuen audioRoutingGroup durch Veröffentlichen in der audioRoutingGroup-Auflistung.Create a new audioRoutingGroup by posting to the audioRoutingGroups collection.
List audioRoutingGroupsList audioRoutingGroups audioRoutingGroup-AuflistungaudioRoutingGroup collection Abrufen einer aAudioRoutingGroup-Objektauflistung.Get a audioRoutingGroup object collection.
Interactive-Voice-ResponseInteractive-Voice-Response
PlayPromptPlayPrompt playPromptOperationplayPromptOperation Wiedergabeaufforderung in dem Anruf.Play prompt in the call.
RecordRecord recordOperationrecordOperation Aufzeichnen des Anrufs.Record the call.
CancelMediaProcessingCancelMediaProcessing commsOperationcommsOperation Abbrechen der Medienverarbeitung.Cancel media processing.
SubscribeToToneSubscribeToTone commsOperationcommsOperation Abonnieren von DTMF-Tönen.Subscribe to DTMF tones.
Self Participant OperationsSelf Participant Operations
MuteMute commsOperationcommsOperation Sich selbst stummschalten in dem Anruf.Mute self in the call.
UnmuteUnmute commsOperationcommsOperation Stummschaltung für sich selbst in dem Anruf aufheben.Unmute self in the call.
UpdateMetadataUpdateMetadata commsOperationcommsOperation Aktualisieren der Metadaten für sich selbst in der Teilnehmerliste.Update metadata for self in roster.
ChangeScreenSharingRoleChangeScreenSharingRole Starten und Beenden des Freigabebildschirms in dem Anruf.Start and stop sharing screen in the call

EigenschaftenProperties

EigenschaftProperty TypType BeschreibungDescription
activeModalitiesactiveModalities ZeichenfolgenauflistungString Collection Die Liste der aktiven Modalitäten.The list of active modalities. Mögliche Werte: unknown, audio, video, videoBasedScreenSharing, data.Possible values are: unknown, audio, video, videoBasedScreenSharing, data. Schreibgeschützt.Read-only. Vom Server generiert.Server generated.
answeredByansweredBy participantInfoparticipantInfo Der Teilnehmer, der den Anruf angenommen hat.The participant that answered the call. Schreibgeschützt.Read-only. Vom Server generiert.Server generated.
callRoutescallRoutes callRoute-AuflistungcallRoute collection Die Routinginformationen, wie der Anruf umgeleitet wurde.The routing information on how the call was retargeted. Schreibgeschützt.Read-only. Vom Server generiert.Server generated.
callbackUricallbackUri ZeichenfolgeString Die Rückruf- oder Abonnement-ID für Rückrufe.The callback or subscription ID on which callbacks will be delivered.
chatInfochatInfo chatInfochatInfo Die Chatinformationen.The chat information.
directiondirection ZeichenfolgeString Die Richtung des Anrufs.The direction of the call. Die möglichen Werte sind: incoming oder outgoing.The possible value are incoming or outgoing. Schreibgeschützt.Read-only. Vom Server generiert.Server generated.
idid StringString Schreibgeschützt.Read-only. Vom Server generiert.Server generated.
mediaConfigmediaConfig appHostedMediaConfig oder serviceHostedMediaConfigappHostedMediaConfig or serviceHostedMediaConfig Die Medienkonfiguration.The media configuration.
meetingCapabilitymeetingCapability meetingCapabilitymeetingCapability Enthält die Funktionen einer Besprechung.Contains the capabilities of a meeting.
meetingInfomeetingInfo organizerMeetingInfo oder tokenMeetingInfoorganizerMeetingInfo or tokenMeetingInfo Die Besprechungsinformationen.The meeting information.
myParticipantIdmyParticipantId ZeichenfolgeString Schreibgeschützt.Read-only. Vom Server generiert.Server generated.
requestedModalitiesrequestedModalities ZeichenfolgenauflistungString collection Die Liste der angeforderten Modalitäten.The list of requested modalities. Mögliche Werte: unknown, audio, video, videoBasedScreenSharing, data.Possible values are: unknown, audio, video, videoBasedScreenSharing, data.
resultInforesultInfo resultInforesultInfo Die Ergebnisinformationen.The result information. Kann beispielsweise einen Grund für die Beendigung enthalten.For example can hold termination reason. Schreibgeschützt.Read-only. Vom Server generiert.Server generated.
ringingTimeoutInSecondsringingTimeoutInSeconds Int32Int32 Timeout für Rufzeichen für ausgehende Peer-to-Peer-AnrufeRinging timeout for outgoing peer to peer calls
routingPoliciesroutingPolicies ZeichenfolgenauflistungString collection Mögliche Werte: none, noMissedCall, disableForwardingExceptPhone, disableForwardingPossible values are: none, noMissedCall, disableForwardingExceptPhone, disableForwarding.
sourcesource participantInfoparticipantInfo Ursprung des Anrufs.The originator of the call.
statestate ZeichenfolgeString Der Anrufstatus.The call state. Mögliche Werte: incoming, establishing, ringing, established, hold, transferring, transferAccepted, redirecting, terminating, terminated.Possible values are: incoming, establishing, ringing, established, hold, transferring, transferAccepted, redirecting, terminating, terminated. Schreibgeschützt.Read-only. Vom Server generiert.Server generated.
subjectsubject ZeichenfolgeString Der Betreff der Unterhaltung.The subject of the conversation.
targetstargets participantInfo-AuflistungparticipantInfo collection Die Ziele des Anrufs.The targets of the call.
tenantIdtenantId ZeichenfolgeString Mandanten-ID in Azure Active Directory.tenantId in Azure Active Directory.
terminationReasonterminationReason ZeichenfolgeString Schreibgeschützt.Read-only. Vom Server generiert.Server generated.
toneInfotoneInfo toneInfotoneInfo Schreibgeschützt.Read-only. Vom Server generiert.Server generated.

Hinweis: Eigenschaften, die als Server generated gekennzeichnet sind, werden bei der Verarbeitung von POST in app/calls ignoriert.Note: Properties marked as Server generated are ignored when processing POST on app/calls.

BeziehungenRelationships

BeziehungRelationship TypType BeschreibungDescription
audioRoutingGroupsaudioRoutingGroups audioRoutingGroup-AuflistungaudioRoutingGroup collection Schreibgeschützt. Nullwerte zulassend.Read-only. Nullable.
operationsoperations commsOperation-AuflistungcommsOperation collection Schreibgeschützt. Nullwerte zulassend.Read-only. Nullable.
participantsparticipants participant-Auflistungparticipant collection Schreibgeschützt. Nullwerte zulassend.Read-only. Nullable.

JSON-DarstellungJSON representation

Es folgt eine JSON-Darstellung der Ressource.The following is a JSON representation of the resource.

{
  "activeModalities": ["unknown | audio | video | videoBasedScreenSharing | data"],
  "answeredBy": {"@odata.type": "microsoft.graph.participantInfo"},
  "callRoutes": [{"@odata.type": "microsoft.graph.callRoute"}],
  "callbackUri": "String",
  "chatInfo": {"@odata.type": "microsoft.graph.chatInfo"},
  "direction": "incoming | outgoing",
  "id": "String (identifier)",
  "mediaConfig": {"@odata.type": "microsoft.graph.mediaConfig"},
  "meetingCapability": {"@odata.type": "microsoft.graph.meetingCapability"},
  "meetingInfo": {"@odata.type": "microsoft.graph.meetingInfo"},
  "myParticipantId": "String",
  "requestedModalities": ["unknown | audio | video | videoBasedScreenSharing | data"],
  "resultInfo": {"@odata.type": "microsoft.graph.resultInfo"},
  "ringingTimeoutInSeconds": 1024,
  "routingPolicies": ["none | noMissedCall | disableForwardingExceptPhone | disableForwarding"],
  "source": {"@odata.type": "microsoft.graph.participantInfo"},
  "state": "incoming | establishing | ringing | established | hold | transferring | transferAccepted | redirecting | terminating | terminated",
  "subject": "String",
  "targets": [{"@odata.type": "microsoft.graph.participantInfo"}],
  "tenantId": "String",
  "terminationReason": "String",
  "toneInfo": {"@odata.type": "microsoft.graph.toneInfo"}
}

Hinweis: In einer mit Microsoft Teams geplanten Besprechung finden Sie eine Teilnahme-URL.Note: You will find join URL from a meeting scheduled with Microsoft Teams. So extrahieren Sie die Daten aus der URL und füllen chatInfo und meetingInfo.Here's how to extract the data from the URL and fill chatInfo and meetingInfo.

https://teams.microsoft.com/l/meetup-join/19%3ameeting_NTg0NmQ3NTctZDVkZC00YzRhLThmNmEtOGQ3M2E0ODdmZDZk%40thread.v2/0?context=%7b%22Tid%22%3a%2272f988bf-86f1-41af-91ab-2d7cd011db47%22%2c%22Oid%22%3a%224b444206-207c-42f8-92a6-e332b41c88a2%22%7d
decodes to:
https://teams.microsoft.com/l/meetup-join/19:meeting_NTg0NmQ3NTctZDVkZC00YzRhLThmNmEtOGQ3M2E0ODdmZDZk@thread.v2/0?context={"Tid":"72f988bf-86f1-41af-91ab-2d7cd011db47","Oid":"4b444206-207c-42f8-92a6-e332b41c88a2"}
{
  "chatInfo": {
    "threadId": "19:meeting_NTg0NmQ3NTctZDVkZC00YzRhLThmNmEtOGQ3M2E0ODdmZDZk@thread.v2",
    "messageId": "0",
    "replyChainMessageId": "0"
  },
  "meetingInfo": {
    "@odata.type": "#microsoft.graph.organizerMeetingInfo",
    "organizer": {
      "user": {
        "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
        "id": "4b444206-207c-42f8-92a6-e332b41c88a2"
      }
    }
  }
}