Partilhar via

Listar callRecords

  • 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 a lista de objetos callRecord e suas propriedades. Os resultados podem ser filtrados opcionalmente usando o $filter parâmetro de consulta nas propriedades startDateTime e id do participante. Observe que os registros de chamadas listados não incluem relações expansíveis, como sessões e participants_v2. Você pode expandir essas relações usando Obter callRecord para um registro específico.

Aviso

Um registro de chamada é criado após o término de uma chamada ou reunião e permanece disponível por 30 dias. Essa API não retorna registros de chamadas com mais de 30 dias.

Essa API está disponível nas seguintes implantações nacionais de nuvem.

Serviço global Governo dos EUA L4 GOVERNO DOS EUA L5 (DOD) China operada pela 21Vianet
✅ ✅ ✅ ❌

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões privilegiadas mais altas
Delegado (conta corporativa ou de estudante) Sem suporte. Sem suporte.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Aplicativo CallRecords.Read.All Indisponível.

Solicitação HTTP

GET /communications/callRecords

Parâmetros de consulta opcionais

Esse método dá suporte aos 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.
$filter Use o parâmetro de consulta $filter para recuperar apenas um subconjunto de um conjunto. Só há suporte para as propriedades startDateTime (lt,,le,gt,ge) e participante participants_v2.id (eq).

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 inteiro preferencial {x} tamanho da página para resultados paginados. Esse valor deve ser igual ou menor do que o tamanho máximo de página permitido. Opcional.
Prefer: include-unknown-enum-members Habilita valores de enumeração evoluíveis além do valor sentinela. Para obter mais informações, confira Melhores práticas para trabalhar com o Microsoft Graph. Opcional.
Prefer: 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, esse método retornará um 200 OK código de resposta e uma coleção de objetos microsoft.graph.callRecords.callRecord no corpo da resposta.

Quando um conjunto de resultados abrange várias páginas, o Microsoft Graph retorna essa página com uma propriedade @odata.nextLink na resposta que contém uma URL para a próxima página de resultados. Se essa propriedade estiver presente, continue fazendo solicitações adicionais com a URL @odata.nextLink em cada resposta, até que todos os resultados sejam retornados. Para obter mais informações, confira paginar dados do Microsoft Graph em seu aplicativo. O tamanho da página padrão para registros de chamada é de 60 entradas.

Exemplos

Exemplo 1: Listar todos os registros

O exemplo a seguir mostra como obter todos os objetos callRecord .

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/communications/callRecords

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",
  "value": [
    {
      "id": "3cf3bbc8-b21d-4f2e-bfd0-b13603ae6c65",
      "version": 2,
      "type": "unknown",
      "modalities": [
        "audio"
      ],
      "lastModifiedDateTime": "2023-09-25T10:36:40Z",
      "startDateTime": "2023-09-25T09:28:38Z",
      "endDateTime": "2023-09-25T09:28:41Z",
      "organizer": {
        "user": {
          "id": "821809f5-0000-0000-0000-3b5136c0e777",
          "displayName": "Abbie Wilkins",
          "tenantId": "dc368399-474c-4d40-900c-6265431fd81f"
        }
      },
      "organizer_v2@odata.context": "https://graph.microsoft.com/beta/$metadata#communications/callRecords('3cf3bbc8-b21d-4f2e-bfd0-b13603ae6c65')/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"
          }
        }
      }
    },
    {
      "id": "c3ad8c4b-4a87-4ab1-bef0-284d2f40ed9f",
      "version": 2,
      "type": "unknown",
      "modalities": [
        "audio"
      ],
      "lastModifiedDateTime": "2023-09-25T14:18:13Z",
      "startDateTime": "2023-09-25T14:03:36Z",
      "endDateTime": "2023-09-25T14:03:40Z",
      "organizer": {
        "user": {
          "id": "821809f5-0000-0000-0000-3b5136c0e777",
          "displayName": "Abbie Wilkins",
          "tenantId": "dc368399-474c-4d40-900c-6265431fd81f"
        }
      },
      "organizer_v2@odata.context": "https://graph.microsoft.com/beta/$metadata#communications/callRecords('c3ad8c4b-4a87-4ab1-bef0-284d2f40ed9f')/organizer_v2/$entity",
      "organizer_v2": {
        "id": "+5564981205182",
        "identity": {
          "user": null,
          "acsUser": null,
          "spoolUser": null,
          "phone": {
            "id": "+5564981205182",
            "displayName": null,
            "tenantId": null
          }
        }
      }
    }
  ]
}

Exemplo 2: Filtrar por startDateTime

O exemplo a seguir mostra como obter objetos callRecord filtrados pela propriedade startDateTime .

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/communications/callRecords?$filter=startDateTime ge 2023-09-25T09:25:00Z and startDateTime lt 2023-09-25T09:30:00Z

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",
  "value": [
    {
      "id": "3cf3bbc8-b21d-4f2e-bfd0-b13603ae6c65",
      "version": 2,
      "type": "unknown",
      "modalities": [
        "audio"
      ],
      "lastModifiedDateTime": "2023-09-25T10:36:40Z",
      "startDateTime": "2023-09-25T09:28:38Z",
      "endDateTime": "2023-09-25T09:28:41Z",
      "organizer": {
        "user": {
          "id": "821809f5-0000-0000-0000-3b5136c0e777",
          "displayName": "Abbie Wilkins",
          "tenantId": "dc368399-474c-4d40-900c-6265431fd81f"
        }
      },
      "organizer_v2@odata.context": "https://graph.microsoft.com/beta/$metadata#communications/callRecords('3cf3bbc8-b21d-4f2e-bfd0-b13603ae6c65')/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"
          }
        }
      }
    }
  ]
}

Exemplo 3: Filtrar pela ID do participante

O exemplo a seguir mostra como obter objetos callRecord filtrados pela propriedade id de um participante.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/communications/callRecords?$filter=participants_v2/any(p:p/id eq '821809f5-0000-0000-0000-3b5136c0e777')

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",
  "value": [
    {
      "id": "3cf3bbc8-b21d-4f2e-bfd0-b13603ae6c65",
      "version": 2,
      "type": "unknown",
      "modalities": [
        "audio"
      ],
      "lastModifiedDateTime": "2023-09-25T10:36:40Z",
      "startDateTime": "2023-09-25T09:28:38Z",
      "endDateTime": "2023-09-25T09:28:41Z",
      "organizer": {
        "user": {
          "id": "821809f5-0000-0000-0000-3b5136c0e777",
          "displayName": "Abbie Wilkins",
          "tenantId": "dc368399-474c-4d40-900c-6265431fd81f"
        }
      },
      "organizer_v2@odata.context": "https://graph.microsoft.com/beta/$metadata#communications/callRecords('3cf3bbc8-b21d-4f2e-bfd0-b13603ae6c65')/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"
          }
        }
      }
    }
  ]
}

Conteúdo relacionado