callRecord : getSmsLog

Espace de noms : Microsoft.graph.callRecords

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Obtenir le journal d’un SMS envoyé/reçu sous forme d’une collection d’entrées smsLogRow .

Disponibilité de l’API

Cette API est disponible dans les déploiements cloud nationaux suivants.

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet
✅ ✅ ✅ ❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) Non prise en charge. Non prise en charge.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application CallRecords.Read.All Non disponible.

Requête HTTP

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

Paramètres de fonction

Dans l’URL de la demande, indiquez les paramètres de requête suivants avec leurs valeurs.

Paramètre Type Description
fromDateTime DateTimeOffset Début de l’intervalle de temps à interroger. Le type d’horodatage représente les informations de date et d’heure au moyen du format ISO 8601. Il est toujours au format d’heure UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : 2014-01-01T00:00:00Z. Obligatoire.
toDateTime DateTimeOffset Fin de l’intervalle de temps pour la requête. Le type d’horodatage représente les informations de date et d’heure au moyen du format ISO 8601. Il est toujours au format d’heure UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : 2014-01-01T00:00:00Z. Obligatoire.

Importante

Les valeurs fromDateTime et toDateTime ne peuvent pas être supérieures à une plage de dates de 90 jours.

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

En cas de réussite, cette fonction renvoie un 200 OK code de réponse et une collection d’entrées microsoft.graph.callRecords.smsLogRow dans le corps de la réponse.

Si la fonction renvoie plus de 1 000 entrées pour la plage de dates spécifiée, le corps inclut également un @odata.nextLink avec une URL pour interroger la page suivante d’entrées. La dernière page de la plage de dates ne comporte pas de @odata.nextLink. Pour plus d’informations, voir Pagination des données Microsoft Graph dans votre application.

Exemple

L’exemple suivant montre comment obtenir le journal des SMS envoyés/reçus qui se sont produits dans la plage de dates spécifiée. La réponse comprend "@odata.count": 1000 l’énumération du nombre d’enregistrements dans cette première réponse et l’obtention @odata.nextLink des enregistrements au-delà des 1 000 premiers. Pour des raisons de lisibilité, l’objet de réponse contient uniquement une collection d’un seul enregistrement.

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/beta/communications/callRecords/getSmsLog(fromDateTime=2022-11-01,toDateTime=2022-12-01)

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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