callRecord: getSmsLog
Namespace: microsoft.graph.callRecords
Wichtig
Die APIs unter der /beta
Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.
Rufen Sie das Protokoll einer gesendeten/empfangenen SMS als Sammlung von smsLogRow-Einträgen ab.
Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.
Globaler Dienst | US Government L4 | US Government L5 (DOD) | China, betrieben von 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ❌ |
Berechtigungen
Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.
Berechtigungstyp | Berechtigungen mit den geringsten Berechtigungen | Berechtigungen mit höheren Berechtigungen |
---|---|---|
Delegiert (Geschäfts-, Schul- oder Unikonto) | Nicht unterstützt | Nicht unterstützt |
Delegiert (persönliches Microsoft-Konto) | Nicht unterstützt | Nicht unterstützt |
Anwendung | CallRecords.Read.All | Nicht verfügbar. |
HTTP-Anforderung
GET /communications/callRecords/getSmsLog(fromDateTime={fromDateTime},toDateTime={toDateTime})
Funktionsparameter
Stellen Sie in der URL der Anforderung die folgenden Abfrageparameter mit Werten bereit.
Parameter | Typ | Beschreibung |
---|---|---|
fromDateTime | DateTimeOffset | Beginn des abzufragenden Zeitbereichs. Der Timestamp-Typ stellt die Datums- und Uhrzeitinformationen mithilfe des ISO 8601-Formats dar und wird immer in UTC-Zeit angegeben. Zum Beispiel, Mitternacht UTC am 1. Januar 2014 ist 2014-01-01T00:00:00Z . Erforderlich. |
Convert.todatetime | DateTimeOffset | Ende des Abfragezeitbereichs. Der Timestamp-Typ stellt die Datums- und Uhrzeitinformationen mithilfe des ISO 8601-Formats dar und wird immer in UTC-Zeit angegeben. Zum Beispiel, Mitternacht UTC am 1. Januar 2014 ist 2014-01-01T00:00:00Z . Erforderlich. |
Wichtig
Die fromDateTime - und toDateTime-Werte dürfen nicht mehr als ein Datumsbereich von 90 Tagen sein.
Anforderungsheader
Name | Beschreibung |
---|---|
Authorization | Bearer {token}. Erforderlich. Erfahren Sie mehr über die Authentifizierung und Autorisierung. |
Anforderungstext
Geben Sie keinen Anforderungstext für diese Methode an.
Antwort
Bei erfolgreicher Ausführung gibt diese Funktion einen 200 OK
Antwortcode und eine Sammlung von microsoft.graph.callRecords.smsLogRow-Einträgen im Antworttext zurück.
Wenn die Funktion mehr als 1.000 Einträge für den angegebenen Datumsbereich zurückgibt, enthält der Text auch eine @odata.nextLink
mit einer URL zum Abfragen der nächsten Seite von Einträgen. Die letzte Seite im Datumsbereich weist keine auf @odata.nextLink
. Weitere Informationen finden Sie unter Paging von Microsoft Graph-Daten in Ihrer App.
Beispiel
Das folgende Beispiel zeigt, wie Sie das Protokoll der gesendeten/empfangenen SMS abrufen, die im angegebenen Datumsbereich aufgetreten sind. Die Antwort enthält "@odata.count": 1000
das Aufzählen der Anzahl von Datensätzen in dieser ersten Antwort und ein @odata.nextLink
, um Datensätze über die ersten 1.000 zu erhalten. Aus Gründen der Lesbarkeit enthält das Antwortobjekt nur eine Auflistung eines Datensatzes.
Anforderung
Das folgende Beispiel zeigt eine Anfrage.
GET https://graph.microsoft.com/beta/communications/callRecords/getSmsLog(fromDateTime=2022-11-01,toDateTime=2022-12-01)
Antwort
Das folgende Beispiel zeigt die Antwort.
Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.callRecords.smsLogRow)",
"@odata.count": 1000,
"@odata.nextLink": "https://graph.microsoft.com/beta/communications/callRecords/getSmsLog(fromDateTime=2022-11-01,toDateTime=2022-12-01)?$skip=1000",
"value": [
{
"smsId": "ef36b3e8-9922-4763-90e2-f4345c04a5d6",
"userId": "19b900af-fe99-48d6-a9a4-b79c995afc33",
"userPrincipalName": "ruwini.perera@contoso.com",
"userDisplayName": "Ruwini Perera",
"userCountryCode": "US",
"tenantCountryCode": "US",
"sourceNumber": "+12818602122",
"destinationNumber": "+12673173004",
"sentDateTime": "2022-10-06T11:15:48.6113555Z",
"callCharge": 0.00,
"currency": "USD",
"smsType": "sms_in",
"destinationContext": "Domestic",
"destinationName": "United States",
"otherPartyCountryCode": "US",
"licenseCapability": "MCOSMS1",
"smsUnits": 1,
"administrativeUnitInfos": [
{
"id": "639b616c-f164-4a6f-a933-24936b8eb210"
},
{
"id": "cc6ea167-4e92-4c2d-9391-85791e978006"
}
]
}
]
}