Тип ресурса call

  • Статья

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Ресурс вызова создается, когда есть входящий вызов для приложения или приложение создает новый исходящий вызов через POST в app/calls.

Вызовы можно настраивать как одноранговые или групповые вызовы. Чтобы создать или присоединиться к групповому вызову, укажите chatInfo и meetingInfo. Если они не предоставляются, автоматически создается новый групповой вызов. Для входящих вызовов записывайте эти значения в высокодоступном хранилище, чтобы приложение повторно присоединилось к вызову в случае своего сбоя.

Хотя одно и то же удостоверение не может быть приглашено несколько раз, приложение может присоединиться к одному и тому же собранию несколько раз. При каждой попытке приложения присоединиться должно предоставляться отдельное удостоверение, чтобы клиенты отображали их как отдельных участников.

Примечание. URL-адрес для присоединения можно получить из собрания, запланированного с помощью Microsoft Teams. Извлеките данные из URL-адреса, как показано, чтобы заполнить свойства chatInfo и 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

преобразуется в:

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"}

Методы

Метод Возвращаемый тип Описание
получение; call Чтение свойств объекта call.
Удаление Нет Удаление или разрыв активного вызова.
KeepAlive Нет Проверка, что вызов остается активным.
Обработка вызовов
Ответ Нет Ответ на входящий вызов.
Reject Нет Отклонение входящего вызова.
Redirect Нет Перенаправление входящего вызова.
Перевод Нет Переключение звонка
Групповые звонки
Перечисление участников Коллекция participant Получение коллекции объектов.
Приглашение участников commsOperation Приглашение участников в активный вызов.
Отключение звука всех участников commsOperation Отключение звука всех участников звонка.
Отключение звука участника muteParticipantOperation Отключение звука участника в групповом вызове.
Создание объекта audioRoutingGroup audioRoutingGroup Создание нового объекта audioRoutingGroup путем публикации в коллекции audioRoutingGroups.
Перечисление AudioRoutingGroups Коллекция audioRoutingGroup Получение коллекции объектов audioRoutingGroup.
Добавление представления "Большая галерея" addLargeGalleryViewOperation Добавление представления "Большая галерея" в вызов.
Интерактивный голосовой ответ
PlayPrompt playPromptOperation Воспроизведение запроса в вызове.
RecordResponse recordOperation Запись короткого голосового ответа звонящего.
CancelMediaProcessing commsOperation Отмена обработки мультимедиа.
SubscribeToTone commsOperation Подписка на тоны DTMF.
SendDtmfTones commsOperation Отправка тонов DTMF в вызове.
Самостоятельные операции участников
Отключение звука muteParticipantOperation Отключение своего звука в вызове.
Включение звука unmuteParticipantOperation Включение своего звука в звонке.
ChangeScreenSharingRole Нет Начало и прекращение демонстрации экрана в звонке.
Запись операций
UpdateRecordingStatus updateRecordingStatusOperation Обновление состояния записи.
Операции ведения журнала
Запись в журнал данных о качестве устройств teleconferenceDeviceQuality Запись в журнал данных о качестве устройств для видеоконференций.

Свойства

Свойство Тип Описание
activeModalities Коллекция modality Список активных модальностей. Возможные значения: unknown, audio, video, videoBasedScreenSharing, data. Только для чтения.
answeredBy participantInfo Участник, ответивший на вызов. Только для чтения.
callRoutes Коллекция callRoute Сведения маршрутизации о том, как был перенаправлен вызов. Только для чтения.
callbackUri String URL-адрес обратного вызова, на который направляются обратные вызовы. Должно быть задано значение https.
callChainId String Уникальный идентификатор всех звонков участника конференции или уникальный идентификатор двух звонков участника в звонке P2P. Необходимо скопировать из Microsoft.Graph.Call.CallChainId.
callOptions outgoingCallOptions Содержит необязательные функции для вызова.
chatInfo chatInfo Сведения о чате. Обязательные сведения для сценариев собраний.
direction callDirection Направление вызова. Возможные значения: incoming или outgoing. Только для чтения.
id String Идентификатор вызова. Только для чтения.
incomingContext incomingContext Контекст, связанный с входящим звонком. Только для чтения. Создается сервером.
mediaConfig appHostedMediaConfig или serviceHostedMediaConfig Настройка мультимедиа. Обязательные сведения для создания одноранговых вызовов или присоединения к собраниям.
mediaState callMediaState Только для чтения. Состояние мультимедиа компонентов вызова.
meetingCapability meetingCapability Содержит возможности собрания. Только для чтения.
meetingInfo organizerMeetingInfo, tokenMeetingInfo или joinMeetingIdMeetingInfo Сведения о собрании. Обязательные сведения для сценариев собраний.
transcription callTranscriptionInfo Сведения расшифровки для звонка. Только для чтения.
myParticipantId String Только для чтения.
requestedModalities Коллекция modality Список запрошенных модальностей. Возможные значения: unknown, audio, video, videoBasedScreenSharing, data.
resultInfo resultInfo Сведения о результате. Например, результат может содержать причину завершения. Только для чтения.
ringingTimeoutInSeconds Int32 Время ожидания звонков в секундах для исходящих одноранговых вызовов. Максимальное значение для этого атрибута составляет 115 секунд.
routingPolicies Коллекция routingPolicy Это свойство применимо только к одноранговым вызовам. Возможные значения: none, noMissedCall, disableForwardingExceptPhone, disableForwarding, preferSkypeForBusiness, unknownFutureValue.
source participantInfo Создатель вызова.
state callState Состояние вызова. Возможные значения: incoming, establishing, ringing, established, hold, transferring, transferAccepted, redirecting, terminating, terminated. Только для чтения.
subject String Тема беседы.
targets Коллекция invitationParticipantInfo Целевые объекты вызова. Обязательные сведения для создания одноранговых вызовов.
tenantId String Только для чтения. tenantIdв Microsoft Entra ID.
terminationReason String Только для чтения.
toneInfo toneInfo Только для чтения.

Связи

Связь Тип Описание
audioRoutingGroups Коллекция audioRoutingGroup Только для чтения. Допускается значение null.
operations Коллекция commsOperation Только для чтения. Допускается значение null.
participants Коллекция participant Только для чтения. Допускается значение null.
contentSharingSessions Коллекция contentSharingSession Только для чтения. Допускается значение null.

Представление JSON

В следующем представлении JSON показан тип ресурса.

{
  "activeModalities": ["String"],
  "answeredBy": {"@odata.type": "#microsoft.graph.participantInfo"},
  "callRoutes": [{"@odata.type": "#microsoft.graph.callRoute"}],
  "callbackUri": "String",
  "callChainId": "String",
  "callOptions": {"@odata.type": "#microsoft.graph.outgoingCallOptions"},
  "chatInfo": {"@odata.type": "#microsoft.graph.chatInfo"},
  "contentSharingSessions": [{ "@odata.type": "microsoft.graph.contentSharingSession" }],
  "direction": "String",
  "id": "String (identifier)",
  "incomingContext": {"@odata.type": "#microsoft.graph.incomingContext"},
  "mediaConfig": {"@odata.type": "#microsoft.graph.mediaConfig"},
  "mediaState": {"@odata.type": "#microsoft.graph.callMediaState"},
  "meetingCapability": {"@odata.type": "#microsoft.graph.meetingCapability"},
  "meetingInfo": {"@odata.type": "#microsoft.graph.meetingInfo"},
  "transcription": {"@odata.type": "#microsoft.graph.callTranscriptionInfo"},
  "myParticipantId": "String",
  "replacesContext": "String",
  "requestedModalities": ["String"],
  "resultInfo": {"@odata.type": "#microsoft.graph.resultInfo"},
  "ringingTimeoutInSeconds": 99,
  "routingPolicies": ["String"],
  "source": {"@odata.type": "#microsoft.graph.participantInfo"},
  "state": "String",
  "subject": "String",
  "targets": [{"@odata.type": "#microsoft.graph.invitationParticipantInfo"}],
  "tenantId": "String",
  "terminationReason": "String",
  "toneInfo": {"@odata.type": "#microsoft.graph.toneInfo"}
}