Cette page a été traduite par traduction automatique. Cliquez ici pour voir la version originale en anglais.

Send Alert

Créer une alerte email avec HTTP POST

développer tous les éléments de la page

Requête

Méthode HTTP

POST

URL

https://api.thingspeak.com/alerts/send

Paramètres d'URL

Aucun paramètre disponible

Headers

Les en-têtes ThingSpeak-Alerts-API-Key et Content-Type sont obligatoires. L'en-tête Accept est facultatif.

NamePrioritéDescriptionType de valeur
ThingSpeak-Alerts-API-KeyRequis

Spécifiez la clé API des alertes, que vous pouvez trouver dans votre profil. Cette clé est différente des clés d'API de canal et d'API d'utilisateur.

chaîne de caractère

Content-TypeRequis

  • application/json

  • application/x-www-form-urlencoded

chaîne de caractère

Paramètres du corps de la requête

NomPrioritéDescriptionType de valeur
subjectFacultatif

Spécifiez l'objet du message électronique, jusqu'à 60 caractères.

chaîne de caractère

bodyFacultatif

Spécifiez le corps du message électronique, jusqu'à 500 caractères.

chaîne de caractère

Réponse

Succès

Code HTTP status

202 Accepted

Erreur

Vous pouvez utiliser l'en-tête Accept pour contrôler les détails fournis avec les messages d'erreur. Fournissez l'en-tête Accept avec la valeur application/json,application/problem+json et le serveur renvoie des messages d'erreur détaillés ainsi que le code de réponse HTTP standard.

Pour la liste complète des erreurs HTTP possibles, voir Codes d'erreur.

Exemples

développer tout

Utilisez POSTMAN pour effectuer des requêtes HTTP à l’aide de l’API RESTful pour ThingSpeak.

Créez une alerte avec un objet et un corps détaillés.

  1. Créez la requête POST. Dans POSTMAN, sélectionnez POST dans la liste des verbes HTTP et entrez https://api.thingspeak.com/alerts/send dans la barre d'adresse.

  2. Entrez les en-têtes. Sélectionnez l'onglet Headers. Saisissez ces paires clé/valeur.

    CléValeur
    Thingspeak-Alerts-API-KeyXXXXXXXXXXXXXXXX
    Content-Typeapplication/json

  3. Entrez les informations sur Body. Sélectionnez l’onglet Body, puis sélectionnez raw. Entrez ce code JSON.

    {
    "subject": "ThingSpeak Alert email",
    "body": "The water level has reached its limit"
}

La réponse est au format JSON. La valeur de réponse du serveur est 202 OK, indiquant une requête acceptée. Le mail est envoyé peu de temps après.

Utilisez MATLAB® pour générer une alerte lorsque la valeur moyenne d'un canal est supérieure à un seuil défini. Cet exemple utilise ThingSpeak canal 276330, qui contient des données de température de bureau en direct dans le champ 7. Notez que vous pouvez écrire le code suivant dans n'importe quel environnement MATLAB, y compris MATLAB Analysis et le desktop MATLAB.

Définissez la clé d'API des alertes et l'URL de la requête. Votre clé API d'alertes se trouve à Account > My Profile.

Lire les données du canal et calculer la valeur moyenne des données.

data = thingSpeakRead(276330,"NumMinutes", 100);
aveTemp = mean(data(:, 7));

Définissez la clé d'API des alertes et l'URL de la requête. Votre clé API d'alertes se trouve à Account > My Profile.

apiKey = 'XXXXXXXXXXXXXXXX';
alertURL = "https://api.thingspeak.com/alerts/send";

La demande d'envoi d'alertes nécessite un en-tête de clé d'API. Créez weboptions pour que webwrite puisse écrire correctement votre requête HTTP. Créez également le corps et l'objet de l'e-mail.

Conseil

Lorsque vous créez une alerte dans MATLAB à l'aide de webwrite, l'en-tête Content-Type requis est automatiquement spécifié.

options = weboptions("HeaderFields", ["ThingSpeak-Alerts-API-Key", apiKey ]);
alertBody = sprintf("The temperature is %0.2f°F.", aveTemp);
alertSubject = sprintf("🌡 Temperature exceeded 60.0°F!");

Si la température est supérieure à 60 °F, envoyez une alerte.

if aveTemp > 60.0
    webwrite(alertURL, "body", alertBody, "subject", alertSubject, options);
end

L'horodatage utilisé dans l'e-mail se trouve dans le fuseau horaire défini dans vos paramètres ThingSpeak, que vous pouvez trouver dans Account > My Profile. Vous pouvez utiliser l'appel API Get Alert History pour suivre l'état de votre e-mail.

Vous pouvez maintenant utiliser l'application TimeControl pour planifier l'exécution de ce code à intervalles réguliers. Accédez à Apps > TimeControl et sélectionnez un nouveau TimeControl. Réglez Frequency sur Recurring et Recurrence sur 100 minutes. Sélectionnez l'analyse Action comme MATLAB et choisissez le nom de l'analyse MATLAB que vous avez écrite à l'étape précédente. Enregistrez le TimeControl.

Lorsque la température moyenne dépasse 60 ℉, vous recevrez un e-mail de ThingSpeak.

Limites

  • Les utilisateurs sont limités à 2 alertes toutes les 30 minutes. La limite de débit est appliquée au moment de la requête, et non au moment de l'envoi de l'e-mail. Si vous dépassez la limite de requêtes, l'API renvoie le code de réponse 429.

Voir aussi

Fonctions

Rubriques