call: subscribeToTone
Пространство имен: microsoft.graph
Важно!
API версии /beta
в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Подпишитесь на DTMF (двухцветную многочастотную сигнализацию), чтобы получать уведомления при нажатии клавиш на панели набора номера.
Это действие поддерживается только для вызовов , инициированных с помощью serviceHostedMediaConfig.
Этот API доступен в следующих национальных облачных развертываниях.
Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
Тип разрешения | Разрешения с наименьшими привилегиями | Более высокие привилегированные разрешения |
---|---|---|
Делегированные (рабочая или учебная учетная запись) | Не поддерживается. | Не поддерживается. |
Делегированные (личная учетная запись Майкрософт) | Не поддерживается. | Не поддерживается. |
Приложение | Calls.AccessMedia.All | Недоступно. |
Примечание: Все предоставленные данные тона не могут сохраняться. Убедитесь, что вы соответствуете законам и нормативным актам вашей области в отношении защиты данных и конфиденциальности сообщений. Дополнительные сведения см. в разделе Условия использования и проконсультируйтесь с вашим адвокатом.
HTTP-запрос
POST /app/calls/{id}/subscribeToTone
POST /communications/calls/{id}/subscribeToTone
Примечание. Путь
/app
является устаревшим. В дальнейшем используйте путь/communications
.
Заголовки запросов
Имя | Описание |
---|---|
Авторизация | Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации. |
Текст запроса
В тексте запроса предоставьте JSON-объект с указанными ниже параметрами.
Параметр | Тип | Описание |
---|---|---|
clientContext | String | Уникальная строка контекста клиента. Может содержать не более 256 символов. |
Отклик
В случае успешного выполнения этот метод возвращает код отклика 200 OK
.
Пример
В приведенном ниже примере показано, как вызывать этот API.
Запрос
Ниже показан пример запроса.
POST https://graph.microsoft.com/beta/communications/calls/{id}/subscribeToTone
Content-Type: application/json
Content-Length: 46
{
"clientContext": "fd1c7836-4d84-4e24-b6aa-23188688cc54"
}
Отклик
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 200 OK
Location: https://graph.microsoft.com/beta/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/operations/0fe0623f-d628-42ed-b4bd-8ac290072cc5
{
"@odata.type": "#microsoft.graph.subscribeToToneOperation",
"clientContext": "clientContext-value",
"id": "0fe0623f-d628-42ed-b4bd-8ac290072cc5",
"resultInfo": null,
"status": "completed"
}
Уведомление — уведомление о тоне
Уведомление содержит сведения о тоне, нажатом в ресурсе toneInfo .
POST https://bot.contoso.com/api/calls
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.commsNotifications",
"value": [
{
"@odata.type": "#microsoft.graph.commsNotification",
"changeType": "updated",
"resourceUrl": "/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896",
"resourceData": {
"@odata.type": "#microsoft.graph.call",
"state": "established",
"toneInfo": {
"@odata.type": "#microsoft.graph.toneInfo",
"sequenceId": 1,
"tone": "tone1"
}
}
}
]
}