删除呼叫
命名空间:microsoft.graph
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
删除或挂起活动呼叫。 对于组呼叫,这只会删除呼叫腿,基础组调用仍将继续。
此 API 可用于以下国家级云部署。
全局服务 | 美国政府 L4 | 美国政府 L5 (DOD) | 由世纪互联运营的中国 |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
权限类型 | 最低特权权限 | 更高特权权限 |
---|---|---|
委派(工作或学校帐户) | 不支持。 | 不支持。 |
委派(个人 Microsoft 帐户) | 不支持。 | 不支持。 |
应用程序 | Calls.Initiate.All | Calls.AccessMedia.All |
注意:创建调用时,将检查权限;调用此 API 时,不会创建其他权限检查。 Calls.AccessMedia.All 仅对使用应用托管媒体的调用是必需的。
HTTP 请求
DELETE /app/calls/{id}
DELETE /communications/calls/{id}
注意:
/app
路径已弃用。 今后将使用/communications
路径。
请求标头
名称 | 说明 |
---|---|
Authorization | 持有者 {token}。 必填。 详细了解 身份验证和授权。 |
请求正文
请勿提供此方法的请求正文。
响应
如果成功,此方法返回 204 No Content
响应代码。 它不会在响应正文中返回任何内容。
示例
请求
下面为请求示例。
DELETE https://graph.microsoft.com/beta/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896
响应
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 204 No Content
通知 - 终止
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": "terminating"
}
}
]
}
通知 - 已终止
POST https://bot.contoso.com/api/calls
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.commsNotifications",
"value": [
{
"@odata.type": "#microsoft.graph.commsNotification",
"changeType": "deleted",
"resourceUrl": "/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896",
"resourceData": {
"@odata.type": "#microsoft.graph.call",
"state": "terminated",
"resultInfo": {
"@odata.type": "#microsoft.graph.resultInfo",
"code": "200",
"subcode": "5001",
"message": "The conversation has ended."
}
}
}
]
}
调用结束原因代码
以下是呼叫终止时通过通知收到的一些常见错误代码。
代码 | 子代码 | 终止原因 |
---|---|---|
200 | 4097 | 呼叫由呼叫中的其他参与者结束。 |
200 | 4521 | 呼叫由对等呼叫中的其他参与者结束。 |
200 | 5000 | 已由另一个参与者从对话中删除。 |
200 | 5001 | 谈话已经结束。 |
200 | 5002 | 当所有其他参与者都离开通话时,对话已结束。 |
200 | 5003 | 谈话已经结束。 |
200 | 5007 | 会话已结束,因为组的发起方呼叫离开会话。 |
200 | 5010 | 对话已结束,因为只有一个参与者留在对话中。 |
200 | 5012 | 对话已经结束,因为传入的名册中没有参与者。 |
200 | 5013 | 会话已结束,因为没有其他人加入组呼叫。 |
200 | 5014 | 会话已结束,因为我们无法确定组呼叫的潜在主机。 |
200 | 5020 | 对话已经结束,因为传入的名册中没有非隐藏的参与者。 |
200 | 5030 | 聊天在分组讨论室持续时间过后结束。 |
200 | 5300 | 参与者已被另一个参与者从对话中删除。 |
200 | 5855 | 大厅非活动超时后,在大厅中等待的参与者已从对话中删除。 |
200 | 7000 | 聊天已由机器人结束。 |
200 | 7015 | 呼叫在传输成功完成时结束。 |
200 | 10550 | 聊天已由机器人结束。 |
200 | 18503 | 对等呼叫中的另一个参与者离开了对话。 |
200 | 540000/560000 | 呼叫由 PSTN 用户结束。 |
408 | 8537 | 保持“活动”超时,清理了非活动调用。 |
408 | 1106 | 在分配的时间内,未收到呼叫接受的确认。 |
408 | 10057 | 由于没有来自被调用方终结点的信号,呼叫超时。 |
410 | 301005 | 媒体连接失败。 |
480 | 10037 | 未找到被调用方终结点。 |
480 | 10076 | 无法联系到被调用方。 |
480 | 10134 | 由于无法路由呼叫,呼叫被拒绝。 |
480 | 10199 | 已拒绝呼叫,因为对用户禁用专用呼叫。 |
500 | 1005 | 服务器遇到机器人媒体的连接错误。 检查机器人与 Microsoft 之间的媒体连接。 |