Partilhar via

Obter callRecord

  • Artigo

Namespace: microsoft.graph.callRecords

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Obtenha as propriedades e relações de um objeto callRecord .

Existem duas formas de obter o ID de uma chamadaRegisto:

  • Subscreva para alterar as notificações para o /communications/callRecords ponto final.
  • Utilize a propriedade callChainId de uma chamada. O registo de chamada só está disponível depois de concluída a chamada associada.

Aviso

É criado um registo de chamada após o fim de uma chamada ou reunião e permanece disponível durante 30 dias. Os pedidos de registos de chamadas com mais de 30 dias recebem uma 404 Not Found resposta.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet
✅ ✅ ✅ ❌

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante) Sem suporte. Sem suporte.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application CallRecords.Read.All Indisponível.

Solicitação HTTP

GET /communications/callRecords/{id}

Cuidado

  • Atualmente, esta API não devolve um registo dos participantes que transmitem um evento em direto.

Parâmetros de consulta opcionais

Este método suporta os seguintes parâmetros de consulta OData para ajudar a personalizar a resposta. Para obter informações gerais, acesse Parâmetros de consulta OData.

Nome Descrição
$select Use o parâmetro de consulta $select para retornar um conjunto de propriedades diferente do padrão definido para um recurso individual ou um conjunto de recursos. Apenas suportado para callRecord recursos e session .
$expand Utilize o $expand parâmetro de consulta para incluir o recurso ou coleção expandido referenciado por uma única relação (participants_v2 ou sessões e segmentos) nos resultados. Para obter um exemplo, veja Obter detalhes da sessão e do segmento.

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Preferir: odata.maxpagesize={x} Especifica um tamanho de página {x} de número inteiro preferencial para resultados paginados. Opcional. Este valor tem de ser igual ou inferior ao tamanho máximo de página permitido.
Preferir: include-unknown-enum-members Permite valores de enumeração evoluíveis para além do valor do sentinel. Para obter mais informações, veja Melhores práticas para trabalhar com o Microsoft Graph. Opcional.
Preferir: omit-values=nulls Remove valores nulos ou vazios da resposta. Opcional.

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Se for bem-sucedido, este método devolve um 200 OK código de resposta e um objeto microsoft.graph.callRecords.callRecord no corpo da resposta. Um pedido para um registo de chamada com mais de 30 dias recebe uma 404 Not Found resposta.

Quando um conjunto de resultados abrange várias páginas, o Microsoft Graph devolve essa página com uma propriedade @odata.nextLink na resposta que contém um URL para a página seguinte de resultados. Se essa propriedade estiver presente, continue a fazer pedidos adicionais com o URL @odata.nextLink em cada resposta, até que todos os resultados sejam devolvidos. Para obter mais informações, veja Paginar dados do Microsoft Graph na sua aplicação. Tamanho máximo da página: 130 entradas para participantes e 60 entradas para sessões.

Exemplos

Exemplo 1: obter detalhes básicos

O exemplo seguinte mostra como obter os detalhes básicos de uma chamadaRegisto.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/communications/callRecords/e523d2ed-2966-4b6b-925b-754a88034cc5

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#communications/callRecords/$entity",
  "version": 1,
  "type": "peerToPeer",
  "modalities": [
    "audio"
  ],
  "lastModifiedDateTime": "2020-02-25T19:00:24.582757Z",
  "startDateTime": "2020-02-25T18:52:21.2169889Z",
  "endDateTime": "2020-02-25T18:52:46.7640013Z",
  "id": "e523d2ed-2966-4b6b-925b-754a88034cc5",
  "organizer_v2@odata.context": "https://graph.microsoft.com/beta/$metadata#communications/callRecords('e523d2ed-2966-4b6b-925b-754a88034cc5')/organizer_v2/$entity",
  "organizer_v2": {
    "id": "821809f5-0000-0000-0000-3b5136c0e777",
    "identity": {
      "user": {
        "id": "821809f5-0000-0000-0000-3b5136c0e777",
        "displayName": "Abbie Wilkins",
        "tenantId": "dc368399-474c-4d40-900c-6265431fd81f"
      }
    }
  },
  "participants_v2@odata.context": "https://graph.microsoft.com/beta/$metadata#communications/callRecords('e523d2ed-2966-4b6b-925b-754a88034cc5')/participants_v2/$entity"
}

Exemplo 2: Obter detalhes da sessão e do segmento

O exemplo seguinte mostra como obter os detalhes completos da sessão e do segmento a partir de uma chamadaRegisto.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/communications/callRecords/e523d2ed-2966-4b6b-925b-754a88034cc5?$expand=sessions($expand=segments)

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#communications/callRecords(sessions(segments()))/$entity",
  "version": 1,
  "type": "peerToPeer",
  "modalities": [
    "audio"
  ],
  "lastModifiedDateTime": "2020-02-25T19:00:24.582757Z",
  "startDateTime": "2020-02-25T18:52:21.2169889Z",
  "endDateTime": "2020-02-25T18:52:46.7640013Z",
  "id": "e523d2ed-2966-4b6b-925b-754a88034cc5",
  "organizer_v2@odata.context": "https://graph.microsoft.com/beta/$metadata#communications/callRecords('e523d2ed-2966-4b6b-925b-754a88034cc5')/organizer_v2/$entity",
  "organizer_v2": {
    "id": "821809f5-0000-0000-0000-3b5136c0e777",
    "identity": {
      "user": {
        "id": "821809f5-0000-0000-0000-3b5136c0e777",
        "displayName": "Abbie Wilkins",
        "tenantId": "dc368399-474c-4d40-900c-6265431fd81f"
      }
    }
  },
  "participants_v2@odata.context": "https://graph.microsoft.com/beta/$metadata#communications/callRecords('e523d2ed-2966-4b6b-925b-754a88034cc5')/participants_v2/$entity",
  "sessions": [
    {
      "modalities": [
        "audio"
      ],
      "startDateTime": "2020-02-25T18:52:21.2169889Z",
      "endDateTime": "2020-02-25T18:52:46.7640013Z",
      "id": "e523d2ed-2966-4b6b-925b-754a88034cc5",
      "isTest": false,
      "caller": {
        "@odata.type": "#microsoft.graph.callRecords.participantEndpoint",
        "name": "machineName_2",
        "userAgent": {
          "@odata.type": "#microsoft.graph.callRecords.clientUserAgent",
          "headerValue": "RTCC/7.0.0.0 UCWA/7.0.0.0 AndroidLync/6.25.0.27 (SM-G930U Android 8.0.0)",
          "platform": "android",
          "productFamily": "skypeForBusiness"
        },
        "associatedIdentity": {
          "id": "821809f5-0000-0000-0000-3b5136c0e777",
          "displayName": "Abbie Wilkins",
          "tenantId": "dc368399-474c-4d40-900c-6265431fd81f",
          "userPrincipalName": "abbie.wilkins@contoso.com"
        }
      },
      "callee": {
        "@odata.type": "#microsoft.graph.callRecords.participantEndpoint",
        "name": "machineName_4",
        "userAgent": {
          "@odata.type": "#microsoft.graph.callRecords.clientUserAgent",
          "headerValue": "UCCAPI/16.0.12527.20122 OC/16.0.12527.20194 (Skype for Business)",
          "platform": "windows",
          "productFamily": "skypeForBusiness"
        },
        "associatedIdentity": {
          "id": "f69e2c00-0000-0000-0000-185e5f5f5d8a",
          "displayName": "Owen Franklin",
          "tenantId": "dc368399-474c-4d40-900c-6265431fd81f",
          "userPrincipalName": "owen.franklin@contoso.com"
        },
        "feedback": {
          "rating": "poor"
        }
      },
      "segments": [
        {
          "startDateTime": "2020-02-25T18:52:21.2169889Z",
          "endDateTime": "2020-02-25T18:52:46.7640013Z",
          "id": "e523d2ed-2966-4b6b-925b-754a88034cc5",
          "media": [
            {
              "label": "main-audio",
              "callerNetwork": {
                "ipAddress": "10.150.0.2",
                "subnet": "10.150.0.0",
                "linkSpeed": 54000000
              },
              "callerDevice": {
                "captureDeviceName": "Default input device",
                "renderDeviceName": "Default output device",
                "receivedSignalLevel": -10
              },
              "streams": [
                {
                  "streamId": "1504545584",
                  "streamDirection": "callerToCallee",
                  "averageAudioDegradation": null,
                  "averageJitter": "PT0.016S"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "sessions@odata.nextLink": "https://graph.microsoft.com/beta/$metadata#communications/callRecords('e523d2ed-2966-4b6b-925b-754a88034cc5')/sessions?$expand=segments&$skiptoken=abc"
}

Exemplo 3: Obter detalhes dos participantes

O exemplo seguinte mostra como expandir a lista completa de participantes paginados para uma chamadaRegisto.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/communications/callRecords/e523d2ed-2966-4b6b-925b-754a88034cc5?$expand=participants_v2

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#communications/callRecords(participants_v2())/$entity",
  "version": 1,
  "type": "peerToPeer",
  "modalities": [
    "audio"
  ],
  "lastModifiedDateTime": "2020-02-25T19:00:24.582757Z",
  "startDateTime": "2020-02-25T18:52:21.2169889Z",
  "endDateTime": "2020-02-25T18:52:46.7640013Z",
  "id": "e523d2ed-2966-4b6b-925b-754a88034cc5",
  "organizer_v2@odata.context": "https://graph.microsoft.com/beta/$metadata#communications/callRecords('e523d2ed-2966-4b6b-925b-754a88034cc5')/organizer_v2/$entity",
  "organizer_v2": {
    "id": "821809f5-0000-0000-0000-3b5136c0e777",
    "identity": {
      "user": {
        "id": "821809f5-0000-0000-0000-3b5136c0e777",
        "displayName": "Abbie Wilkins",
        "tenantId": "dc368399-474c-4d40-900c-6265431fd81f"
      }
    }
  },
  "participants_v2@odata.context": "https://graph.microsoft.com/beta/$metadata#communications/callRecords('e523d2ed-2966-4b6b-925b-754a88034cc5')/participants_v2/$entity",
  "participants_v2@odata.nextLink": "https://graph.microsoft.com/beta/$metadata#communications/callRecords('e523d2ed-2966-4b6b-925b-754a88034cc5')/participants_v2?$skiptoken=abc",
  "participants_v2": [
    {
      "id": "821809f5-0000-0000-0000-3b5136c0e777",
      "identity": {
        "user": {
          "id": "821809f5-0000-0000-0000-3b5136c0e777",
          "displayName": "Abbie Wilkins",
          "tenantId": "dc368399-474c-4d40-900c-6265431fd81f",
          "userPrincipalName": "abbie.wilkins@contoso.com"
        }
      }
    },
    {
      "id": "821809f5-0000-0000-0000-3b5136c0e777",
      "identity": {
        "user": {
          "id": "f69e2c00-0000-0000-0000-185e5f5f5d8a",
          "displayName": "Owen Franklin",
          "tenantId": "dc368399-474c-4d40-900c-6265431fd81f",
          "userPrincipalName": "owen.franklin@contoso.com"
        }
      }
    }
  ]
}