call リソースの種類call resource type

重要

Microsoft Graph の/betaバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでは、これらの API の使用はサポートされていません。Use of these APIs in production applications is not supported.

アプリケーションに関して着信が存在する場合か、アプリケーションによって app/callsPOST を介して発信が作成されると、call リソースが作成されます。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.

通話はピアツーピアまたはマルチパーティ通話として設定できます。Calls can be set up as a peer-to-peer or as a multiparty call. マルチパーティ通話を作成または参加する場合、chatInfomeetingInfo を指定します。For creating or joining a multiparty call, supply the chatInfo and meetingInfo. これらを指定しないと、新しい臨時会議が自動的に作成されます。If these are not supplied, a new ad hoc meeting is created automatically. 着信の場合、高可用性ストアにこれらの値が記録されるので、アプリケーションがクラッシュしたときに、アプリケーションが通話に再度参加できるようになります。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.

アプリケーションでは同じ ID を複数回にわたり招待することはできませんが、同じ会議に何度も参加することは可能です。Although the same identity cannot be invited multiple times, it is possible for an application to join the same meeting multiple times. アプリケーションが参加するたびに、対象会議に対する個別の通話 id が提供されます。Each time the application joins, a distinct call id is provided for that call to the meeting. クライアントが異なる参加者として表示されるように、会議に参加するために別々の ID を使用することをお勧めします。We recommend that you use separate identities to join the meeting in order for the clients to display them as different participants.

メソッドMethods

メソッドMethod 戻り値の型Return Type 説明Description
call を取得するGet call callcall call オブジェクトのプロパティを読み取ります。Read properties of the call object.
削除するDelete アクティブな call を削除または切断します。Delete or Hang-up an active call.
Call 処理Call Handling
応答するAnswer 着信に応答します。Answer an incoming call.
拒否するReject 着信を拒否します。Reject an incoming call.
リダイレクトするRedirect 着信をリダイレクトします。Redirect an incoming call.
転送するTransfer 通話を転送しますTransfer a call
マルチパーティMulti-party
参加者を一覧表示するList participants participant コレクションparticipant collection participant オブジェクト コレクションを取得します。Get a participant object collection.
参加者を招待するInvite Participants commsOperationcommsOperation アクティブな通話に参加者を招待します。Invite participants to the active call.
すべての参加者をミュートするMute All Participants commsOperationcommsOperation 通話ですべての参加者をミュートします。Mute all participants in the call.
参加者をミュートするMute participant commsOperationcommsOperation グループ通話の参加者をミュートします。Mute a participant in the group call.
オーディオ ミキサーを構成するConfigure Audio Mixer commsOperationcommsOperation マルチパーティ会話の音声を構成します。Configure audio in multiparty conversation.
audioRoutingGroup を作成するCreate audioRoutingGroup audioRoutingGroupaudioRoutingGroup audioRoutingGroups コレクションに投稿して、新しい audioRoutingGroup を作成します。Create a new audioRoutingGroup by posting to the audioRoutingGroups collection.
audioRoutingGroups を一覧表示する (List audioRoutingGroups)List audioRoutingGroups audioRoutingGroup コレクションaudioRoutingGroup collection audioRoutingGroup オブジェクト コレクションを取得します。Get a audioRoutingGroup object collection.
対話型音声応答Interactive-Voice-Response
PlayPromptPlayPrompt playPromptOperationplayPromptOperation 通話でプロンプトを再生します。Play prompt in the call.
録音するRecord recordOperationrecordOperation 通話から短い音声クリップを録音します。Record a short audio clip from the call.
CancelMediaProcessingCancelMediaProcessing commsOperationcommsOperation メディア処理を取り消します。Cancel media processing.
SubscribeToToneSubscribeToTone commsOperationcommsOperation DTMF トーンを登録します。Subscribe to DTMF tones.
自分の参加に関する操作Self Participant Operations
ミュートするMute commsOperationcommsOperation 通話で自分をミュートします。Mute self in the call.
ミュート解除するUnmute commsOperationcommsOperation 通話で自分のミュートを解除します。Unmute self in the call.
ChangeScreenSharingRoleChangeScreenSharingRole 通話中に画面共有を開始および停止します。Start and stop sharing screen in the call.

プロパティProperties

プロパティProperty Type 説明Description
activeModalitiesactiveModalities String コレクションString Collection アクティブなモダリティの一覧。The list of active modalities. 可能な値は、unknownaudiovideovideoBasedScreenSharingdata です。Possible values are: unknown, audio, video, videoBasedScreenSharing, data. 読み取り専用です。Read-only. サーバーによって生成されます。Server generated.
answeredByansweredBy participantInfoparticipantInfo 通話に応答した参加者。The participant that answered the call. 読み取り専用です。Read-only. サーバーによって生成されます。Server generated.
callRoutescallRoutes callRoute コレクションcallRoute collection 再通話したときのルーティング情報。The routing information on how the call was retargeted. 読み取り専用です。Read-only. サーバーによって生成されます。Server generated.
callbackUricallbackUri StringString コールバック時のコールバック URL。The callback or subscription ID on which callbacks will be delivered. https である必要があります。Must be https.
chatInfochatInfo chatInfochatInfo チャット情報。The chat information. 会議のシナリオに必要な情報。Required information for meeting scenarios.
方向direction StringString 通話方向。The direction of the call. 使用可能な値: incomingoutgoingThe possible value are incoming or outgoing. 読み取り専用です。Read-only. サーバーによって生成されます。Server generated.
idid StringString 通話 ID。読み取り専用。The call id. Read-only. サーバーによって生成されます。Server generated.
mediaConfigmediaConfig appHostedMediaConfig または serviceHostedMediaConfigappHostedMediaConfig or serviceHostedMediaConfig メディア構成。The media configuration. ピア ツー ピア通話の作成または会議への参加に必要な情報。Required information for creating peer to peer calls or joining meetings.
mediaStatemediaState callMediaStatecallMediaState 読み取り専用。Read-only. サーバーによって生成されます。Server generated. 通話メディアの状態。The call state.
meetingCapabilitymeetingCapability meetingCapabilitymeetingCapability 会議の機能が含まれます。Contains the capabilities of a meeting. 読み取り専用。Read-only. サーバーによって生成されます。Server generated.
meetingInfomeetingInfo organizerMeetingInfo または tokenMeetingInfoorganizerMeetingInfo or tokenMeetingInfo 会議の情報。The meeting information. 会議のシナリオに必要な情報。Required information for meeting scenarios.
myParticipantIdmyParticipantId StringString 読み取り専用です。Read-only. サーバーによって生成されます。Server generated.
requestedModalitiesrequestedModalities String コレクションString collection 要求されたモダリティの一覧。The list of requested modalities. 可能な値は、unknownaudiovideovideoBasedScreenSharingdata です。Possible values are: unknown, audio, video, videoBasedScreenSharing, data.
resultInforesultInfo resultInforesultInfo 結果の情報。The result information. たとえば、終了理由を保持できます。For example can hold termination reason. 読み取り専用です。Read-only. サーバーによって生成されます。Server generated.
ringingTimeoutInSecondsringingTimeoutInSeconds Int32Int32 発信ピア ツー ピア通話の呼び出しタイムアウト (秒単位)。Ringing timeout for outgoing peer to peer calls この属性の最大値は 115 秒です。The max value for this attribute is 115 seconds.
routingPoliciesroutingPolicies String collectionString collection このプロパティは、ピア ツー ピア通話にのみ適用されます。This property is applicable for peer to peer calls only. 可能な値は、nonenoMissedCalldisableForwardingExceptPhonedisableForwardingpreferSkypeForBusiness です。Possible values are: none, noMissedCall, disableForwardingExceptPhone, disableForwarding, preferSkypeForBusiness.
sourcesource participantInfoparticipantInfo 通話の発信者。The originator of the call.
statestate StringString 通話状態。The call state. 可能な値は、incomingestablishingringingestablishedholdtransferringtransferAcceptedredirectingterminatingterminated です。Possible values are: incoming, establishing, ringing, established, hold, transferring, transferAccepted, redirecting, terminating, terminated. 読み取り専用です。Read-only. サーバーによって生成されます。Server generated.
subjectsubject StringString 会話の件名。The subject of the conversation.
Targetstargets participantInfo コレクションparticipantInfo collection 通話対象。The targets of the call. ピア ツー ピア通話の作成に必要な情報。Required information for creating peer to peer call.
tenantIdtenantId StringString 読み取り専用です。Read-only. サーバーによって生成されます。Server generated. Azure Active Directory の tenantIdtenantIdin Azure Active Directory
terminationReasonterminationReason StringString 読み取り専用です。Read-only. サーバーによって生成されます。Server generated.
toneInfotoneInfo toneInfotoneInfo 読み取り専用です。Read-only. サーバーによって生成されます。Server generated.

注: Server generated というマークの付いたプロパティは、app/callsPOST 処理時に無視されます。Note: Properties marked as Server generated are ignored when processing POST on app/calls.

リレーションシップRelationships

リレーションシップRelationship Type 説明Description
audioRoutingGroupsaudioRoutingGroups audioRoutingGroup コレクションaudioRoutingGroup collection 読み取り専用です。Read-only. Null 許容型。Nullable.
operationsoperations commsOperationコレクションcommsOperation collection 読み取り専用。Null 許容型です。Read-only. Nullable.
participantsparticipants participant コレクションparticipant collection 読み取り専用。Null 許容型です。Read-only. Nullable.

JSON 表記JSON representation

リソースの JSON 表記を次に示します。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"},
  "mediaState": {"@odata.type": "#microsoft.graph.callMediaState"},
  "meetingCapability": {"@odata.type": "#microsoft.graph.meetingCapability"},
  "meetingInfo": {"@odata.type": "#microsoft.graph.meetingInfo"},
  "myParticipantId": "String",
  "replacesContext": "String",
  "requestedModalities": ["unknown | audio | video | videoBasedScreenSharing | data"],
  "resultInfo": {"@odata.type": "#microsoft.graph.resultInfo"},
  "ringingTimeoutInSeconds": 99,
  "routingPolicies": ["none | noMissedCall | disableForwardingExceptPhone | disableForwarding | preferSkypeForBusiness"],
  "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"}
}

注: Microsoft Teams でスケジュール設定された会議の参加 URL が見つかります。Note: You will find join URL from a meeting scheduled with Microsoft Teams. その URL からデータを抽出し、chatInfomeetingInfo に情報を設定する方法について次に示します。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"
      }
    }
  }
}