callRecord: getPstnCalls

Namespace: microsoft.graph.callRecords

Obtenha um log de chamadas PSTN como uma coleção de entradas pstnCallLogRow .

Observação

Essa API não retorna informações para planos de chamadas da Telstra .

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

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos 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 com privilégios mais elevados
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/getPstnCalls(fromDateTime={fromDateTime},toDateTime={toDateTime})

Parâmetros de função

Na URL da solicitação, forneça os seguintes parâmetros de consulta com valores. A tabela a seguir mostra os parâmetros que podem ser usados com esta função.

Parâmetro Tipo Descrição
fromDateTime DateTimeOffset Início do intervalo de tempo para consulta. UTC, inclusive.
O intervalo de tempo é baseado na hora de início da chamada.
toDateTime DateTimeOffset Fim do intervalo de tempo para consulta. UTC, inclusive.

Importante

Os valores fromDateTime e toDateTime não podem ter mais de um intervalo de datas de 90 dias.

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

Resposta

Se for bem-sucedida, essa função retornará um 200 OK código de resposta e uma coleção de entradas pstnCallLogRow no corpo da resposta.

Se houver mais de 1.000 entradas no intervalo de datas, o corpo também incluirá um @odata.nextLink com uma URL para consultar a próxima página de entradas de chamada. A última página no intervalo de datas não tem @odata.nextLink. Para obter mais informações, consulte paginação de dados do Microsoft Graph em seu aplicativo.

Exemplo

O exemplo a seguir mostra a obtenção de uma coleção de registros para chamadas PSTN que ocorreram no intervalo de datas especificado. A resposta inclui "@odata.count": 1000 enumerar o número de registros nessa primeira resposta e @odata.nextLink obter registros além dos primeiros 1.000. Para legibilidade, a resposta mostra apenas uma coleção de um registro. Suponha que haja mais de 1.000 chamadas nesse intervalo de datas.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/v1.0/communications/callRecords/getPstnCalls(fromDateTime=2019-11-01,toDateTime=2019-12-01)

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.callRecords.pstnCallLogRow)",
    "@odata.count": 1000,
    "value": [
        {
            "id": "9c4984c7-6c3c-427d-a30c-bd0b2eacee90",
            "callId": "1835317186_112562680@61.221.3.176",
            "userId": "db03c14b-06eb-4189-939b-7cbf3a20ba27",
            "userPrincipalName": "richard.malk@contoso.com",
            "userDisplayName": "Richard Malk",
            "startDateTime": "2019-11-01T00:00:08.2589935Z",
            "endDateTime": "2019-11-01T00:03:47.2589935Z",
            "duration": 219,
            "charge": 0.00,
            "callType": "user_in",
            "currency": "USD",
            "calleeNumber": "+1234567890",
            "usageCountryCode": "US",
            "tenantCountryCode": "US",
            "connectionCharge": 0.00,
            "callerNumber": "+0123456789",
            "destinationContext": null,
            "destinationName": "United States",
            "conferenceId": null,
            "licenseCapability": "MCOPSTNU",
            "inventoryType": "Subscriber",
            "operator": "Microsoft",
            "callDurationSource": "microsoft"
        }
    ],
    "@odata.nextLink": "https://graph.microsoft.com/v1.0/communications/callRecords/getPstnCalls(from=2019-11-01,to=2019-12-01)?$skip=1000"
}