callRecord: getPstnCalls

  • Статья

Пространство имен: microsoft.graph.callRecords

Получение журнала вызовов ТСОП в виде коллекции записей pstnCallLogRow .

Примечание.

Этот API не возвращает сведения о тарифных планах Telstra или Softbank .

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба Правительство США L4 Правительство США L5 (DOD) Китай управляется 21Vianet
✅ ✅ ✅ ❌

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения Разрешения с наименьшими привилегиями Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись) Не поддерживается. Не поддерживается.
Делегированные (личная учетная запись Майкрософт) Не поддерживается. Не поддерживается.
Приложение CallRecords.Read.All Недоступно.

HTTP-запрос

GET /communications/callRecords/getPstnCalls(fromDateTime={fromDateTime},toDateTime={toDateTime})

Параметры функции

В URL-адресе запроса укажите перечисленные ниже параметры запроса и их значения. В приведенной ниже таблице указаны параметры, которые можно использовать с этой функцией.

Параметр Тип Описание
fromDateTime DateTimeOffset Начало диапазона времени для запроса. UTC, включительно.
Диапазон времени основан на времени начала вызова.
toDateTime DateTimeOffset Конец диапазона времени для запроса. UTC, включительно.

Важно!

Значения fromDateTime и toDateTime не могут быть более 90 дней.

Заголовки запросов

Имя Описание
Авторизация Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.

Отклик

В случае успешного 200 OK выполнения эта функция возвращает код отклика и коллекцию записей pstnCallLogRow в тексте отклика.

Если в диапазоне дат содержится более 1000 записей, текст также включает в себя @odata.nextLink URL-адрес для запроса следующей страницы записей вызовов. Последняя страница в диапазоне дат не имеет @odata.nextLink. Дополнительные сведения см. в разделе Разбиение данных Microsoft Graph в приложении по страницам.

Пример

В следующем примере показано получение коллекции записей для вызовов ТСОП, произошедших в указанном диапазоне дат. Ответ включает "@odata.count": 1000 перечисление количества записей в этом первом ответе и @odata.nextLink получение записей, превышающих первые 1000. Для удобства чтения в ответе отображается только коллекция из одной записи. Предположим, что в этом диапазоне дат есть более 1000 вызовов.

Запрос

Ниже показан пример запроса.

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

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

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"
}

Связанные материалы