Créer et envoyer une notification (déconseillé)

  • Article

Espace de noms: microsoft.graph

Importante

L’API de notifications Microsoft Graph est déconseillée et cessera de retourner des données d’ici la fin de janvier 2022. Pour une autre expérience de notification, consultez Microsoft Azure Notification Hubs et consultez ce billet de blog pour plus d’informations.

Créez et envoyez une notification ciblant un utilisateur via Microsoft Graph. La notification est stockée dans le magasin de flux de notification Microsoft Graph et envoyée à tous les clients d’application sur tous les points de terminaison d’appareil auxquels l’utilisateur est connecté.

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

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet
✅ ❌ ❌ ❌

Autorisations

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

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) Notifications.ReadWrite.CreatedByApp Non disponible.
Déléguée (compte Microsoft personnel) Notifications.ReadWrite.CreatedByApp Non disponible.
Application Non prise en charge. Non prise en charge.

Requête HTTP

POST /me/notifications/

En-têtes de demande

Nom Description
Autorisation L’en-tête d’autorisation est utilisé pour transmettre les informations d’identification de la partie appelante. Porteur {token}. Obligatoire.
X-UNS-ID UserNotificationSubscriptionId retourné par le service de notification Microsoft Graph après la création d’un abonnement et utilisé pour cibler l’utilisateur spécifique. Obligatoire.
Content-type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON d’un objet de notification .

Réponse

Si elle réussit, cette méthode retourne un 201 Created code de réponse qui indique que la notification a été correctement créée et stockée. La notification est ensuite envoyée à tous les points de terminaison spécifiés avec un abonnement valide.

Le tableau suivant répertorie les codes d’erreur et de réponse possibles qui peuvent être retournés.

Code d'erreur Description
HttpStatusCode.BadRequest Le corps est un tableau (plusieurs notifications ne sont pas prises en charge).
HttpStatusCode.BadRequest Body ne correspond pas au contrat de l’API.
HttpStatusCode.Forbidden L’appelant figure dans la liste bloquée.
HttpStatusCode.MethodNotAllowed La méthode HTTP utilisée n’est pas prise en charge.
HttpStatusCode.BadRequest Des en-têtes non pris en charge sont présents dans la requête. Deux en-têtes ne sont pas pris en charge :

If-Modified-Since
If-Range
HttpStatusCode.UnsupportedMediaType L’en-tête Content-Encoding est présent et a des valeurs d’algorithme de compression autres que Deflate ou Gzip.
HttpStatusCode.BadRequest Charge utile non valide.
HttpStatusCode.Forbidden L’appelant n’est pas autorisé à agir au nom de l’utilisateur ou à envoyer une notification à l’utilisateur.
HttpStatusCode.Unauthorized Le corps de la demande contient des types de données d’activité non valides.
HttpStatusCode.OK Activité créée avec succès.
HttpStatusCode.NotAcceptable La demande a été limitée ou le serveur est occupé.

Exemple

Demande

L’exemple suivant illustre une demande.

POST https://graph.microsoft.com/beta/me/notifications/
Content-type: application/json

{
    "targetHostName": "graphnotifications.sample.windows.com",
    "appNotificationId": "testDirectToastNotification",
    "expirationDateTime": "2019-10-30T23:59:00.000Z",
    "payload": {
        "visualContent": {
            "title": "Hello World!",
            "body": "Notifications are Great!"
        }
    },
    "targetPolicy": {
        "platformTypes": [
    "windows",
    "ios",
    "android"
        ]
    },
    "priority": "High",
    "groupName": "TestGroup",
    "displayTimeToLive": "60"
}

Réponse

Voici un exemple de la réponse correspondante.

HTTP/1.1 201
client-request-id: 71e62feb-8d72-4912-8b2c-4cee9d89e781
content-length: 356
content-type: application/json
location: https://graph.microsoft.com/beta/me/activities/119081f2-f19d-4fa8-817c-7e01092c0f7d
request-id: 71e62feb-8d72-4912-8b2c-4cee9d89e781

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('graphnotify%40contoso.com')/notifications/$entity",
    "displayTimeToLive": 59,
    "expirationDateTime": "2019-10-28T22:05:36.25Z",
    "groupName": "TestGroup",
    "id": "119081f2-f19d-4fa8-817c-7e01092c0f7d",
    "priority": "High",
    "payload": {
        "visualContent": {
            "title": "Hello World!",
            "body": "Notifications are Great!"
        }
    }
}