call: reject

  • Artículo

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Habilite un bot para rechazar una llamada entrante. La solicitud de llamada entrante puede ser una invitación de un participante en una llamada de grupo o una llamada punto a punto. Si se recibe una invitación a una llamada de grupo, la notificación contiene los parámetros chatInfo y meetingInfo .

Se espera que el bot responda o rechace la llamada antes de que se agote el tiempo de espera de la llamada. El valor de tiempo de espera actual es de 15 segundos.

Esta API no finaliza las llamadas existentes que ya se han respondido. Use la llamada de eliminación para finalizar una llamada.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global Gobierno de EE. UU. L4 Us Government L5 (DOD) China operada por 21Vianet
✅ ❌ ❌ ❌

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) No admitida. No admitida.
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación No admitida. No admitida.

Solicitud HTTP

POST /app/calls/{id}/reject
POST /communications/calls/{id}/reject

Nota: la /app ruta de acceso está en desuso. En el futuro, utilice la ruta de acceso /communications.

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
Tipo de contenido application/json. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione un objeto JSON con los siguientes parámetros.

Parámetro Tipo Descripción
motivo Cadena Motivo de rechazo. Los valores posibles son: None, Busy y Forbidden.
callbackUri Cadena Permite a los bots proporcionar un URI de devolución de llamada específico para que la llamada actual reciba notificaciones posteriores. Si no se establece esta propiedad, en su lugar se usa el URI de devolución de llamada global del bot. El URI debe ser https.

Respuesta

Si se ejecuta correctamente, este método devuelve un código de respuesta 202 Accepted. No devuelve nada en el cuerpo de la respuesta.

Ejemplos

En los ejemplos siguientes se muestra cómo llamar a esta API.

Ejemplo 1: Rechazar una llamada entrante con el motivo "Ocupado"

Solicitud

En los ejemplos siguientes se muestra una solicitud.

POST https://graph.microsoft.com/beta/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/reject
Content-Type: application/json
Content-Length: 24

{
  "reason": "busy"
}
Respuesta

En los ejemplos siguientes se muestra la respuesta.

HTTP/1.1 202 Accepted

Ejemplo 2: Rechazar una llamada entrante con la razón "Ninguno"

Notificación: entrante
POST https://bot.contoso.com/api/call
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.commsNotifications",
  "value": [
    {
      "@odata.type": "#microsoft.graph.commsNotification",
      "changeType": "created",
      "resourceUrl": "/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896",
      "resourceData": {
        "@odata.type": "#microsoft.graph.call",
        "@odata.id": "/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896",
        "state": "incoming",
        "direction": "incoming",
        "source": {
          "identity": {
            "user": {
              "displayName": "John",
              "id": "112f7296-5fa4-42ca-bae8-6a692b15d4b8"
            }
          },
          "region": "westus",
          "languageId": "en-US"
        },
        "targets": [
          {
            "identity": {
              "application": {
                "displayName": "Calling Bot",
                "id": "2891555a-92ff-42e6-80fa-6e1300c6b5c6"
              }
            },
            "region": "westus",
            "languageId": "en-US"
          }
        ],
        "requestedModalities": [ "audio", "video" ]
      }
    }
  ]
}
Solicitud

En los ejemplos siguientes se muestra una solicitud.

POST https://graph.microsoft.com/beta/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/reject
Content-Type: application/json
Content-Length: 24

{
  "reason": "none"
}
Respuesta

En los ejemplos siguientes se muestra la respuesta.

HTTP/1.1 202 Accepted
Notificación: eliminada
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",
        "@odata.id": "/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896"
      }
    }
  ]
}