L’API On-Premises ne sera bientôt plus disponible. Consultez notre document Abandon progressif de l’API On-Premises pour de plus amples détails, mais aussi pour connaître la procédure de migration vers notre API Cloud nouvelle génération.
Paramètres d’application
Les paramètres d’application de votre client WhatsApp Business On-Premises.
Conditions requises
- Les demandes doivent être faites avec votre compte
admin - Toutes les réponses doivent inclure
200 OK HTTPS
Consultation
Obtenez les paramètres d’application actuels pour votre client WhatsApp Business On-Premises
Exemple
Envoyez une demande GET au point de terminaison /v1/settings/application pour obtenir tous les paramètres d’application actuels.
GET /v1/settings/application
En cas de réussite, la réponse renvoyée comprend le code 200 OK et une charge utile JSON contenant un objet application répertoriant tous les paramètres d’application actuels et leurs valeurs.
Exemple de réponse
{
"settings": {
"application": {
"callback_backoff_delay_ms": 3000,
"callback_persist": true,
"garbagecollector_enable": {
"media": false,
"messages": true
},
"heartbeat_interval": 5,
"max_callback_backoff_delay_ms": 900000,
"media": {
"auto_download": [
"image",
"video",
"voice",
"sticker",
"audio",
"document"
]
},
"notify_user_change_number": true,
"show_security_notifications": true,
"unhealthy_interval": 30,
"wa_id": "16315551019",
"webhooks": {
"url": "<Webhook URL, https>",
"max_concurrent_requests": max-concurrent-requests,
"message": { // Available for v2.41.2 and above
"sent": true,
"delivered": true,
"read": false
},
},
"verbose_logging": false,
"log_level" : "info"
},
},
"meta": {
"api_status": "stable",
"version": "3.0.1"
}
}
Arêtes
| Arête | Description |
|---|---|
Utilisez cette arête pour gérer une liste des fournisseurs de contenus multimédias pour l’envoi de liens multimédias. |
Mise à jour
Pour mettre à jour vos paramètres d’application, envoyez une requête PATCH au point de terminaison /v1/settings/application avec un objet JSON contenant les noms et valeurs des champs à définir.
Pour les campagnes de messagerie impliquant un grand volume de messages, il est recommandé de désactiver la collecte des déchets automatique en définissant garbagecollector_enable.messages sur false, et de la réactiver à la fin de la campagne en la redéfinissant sur true.
Vous pouvez vérifier si la collecte des déchets automatique est désactivée en envoyant une requête GET au point de terminaison /v1/settings/application et en consultant la propriété garbagecollector_enable.
Exemple de requête
PATCH /v1/settings/application
{
"callback_persist": true | false,
"max_callback_backoff_delay_ms": max-delay-in-ms,
"media": {
"auto_download": ["audio", "document", "voice", "video", "image", "sticker"]
}
"callback_backoff_delay_ms": "delay-in-ms",
"heartbeat_interval": heartbeat-interval-in-secs,
"unhealthy_interval": unhealthy-interval-in-secs,
"webhooks": {
# See the Webhooks Parameters table below for more information
"max_concurrent_requests": max-concurrent-requests,
"url": "<Webhook URL, https>",
"message": { // Available on v2.41.2 and above
"sent": false,
"delivered": true,
"read": false
},
},
"axolotl_context_striping_disabled": false | true,
"notify_user_change_number": false | true,
"show_security_notifications": false | true,
# Available on v2.49.1 and above
"garbagecollector_enable": {
"messages": true | false,
"media": true | false
}
"skip_referral_media_download": true | false,
"webhook_payload_conversation_pricingmodel_disabled": false | true
# Available on v2.51.1 and above
"verbose_logging": false | true,
"log_level" : log-level-str,
}
En cas de réussite, la réponse contient 200 OK avec null ou un objet JSON.
Si une erreur se produit, consultez les messages d’erreur et de statut.
Paramètres
Certains paramètres exigent que la Coreapp soit redémarrée pour que les modifications soient prises en compte. Il s’agit des paramètres callback_persist, garbagecollector_enable, verbose_logging, log_level et webhooks.max_concurrent_requests.
| Nom | Description |
|---|---|
type : booléen | Affecte les limites de connexion à la base de données. Les performances en sortie et en entrée sont améliorées avec la Valeurs : Redémarrage de la Coreapp requis. |
type : chaîne | Délai de réémission d’un rappel ayant échoué, en millisecondes. Ce paramètre permet de configurer la durée pendant laquelle la réémission est repoussée avant une nouvelle tentative de rappel. Le délai de réémission augmente cette valeur de manière linéaire chaque fois qu’un rappel n’obtient pas la réponse Par défaut : 3 000 |
type : booléen | Stocke les rappels sur disque jusqu’à ce que le webhook en accuse réception ou non. Afin de s’assurer qu’ils sont bien distribués, les messages et les rappels sont stockés dans une base de données locale avant d’en être supprimés. Ainsi, les rappels sont protégés en cas de panne du client ou du serveur de l’API WhatsApp Business. Valeurs : |
type : booléen | Ce champ est devenu obsolète depuis la version 2.49. Active la collecte automatique des déchets de la base de données des messages afin de faciliter la gestion de la base de données. Ce paramètre est défini sur Valeurs : Redémarrage de la Coreapp requis. |
type : objet de collecte des déchets | Active la collecte automatique des déchets des messages et des contenus multimédias. Il est recommandé d’activer la collecte automatique des déchets des messages et des contenus multimédias pour garantir la suppression des lignes et fichiers obsolètes ou inutilisés. Si la collecte des déchets est désactivée, vous pouvez la démarrer en utilisant les points de terminaison Redémarrage de la Coreapp requis. |
type : nombre entier | Intervalle de surveillance des nœuds Coreapp par le maître nœud, exprimé en secondes. Par défaut : 5 |
type : chaîne | Délai maximum pour un rappel ayant échoué, en millisecondes. Pour plus d’informations, lisez la description de Par défaut : 900 000 |
type : tableau | Liste des contenus multimédias à télécharger automatiquement. Pour plus d’informations, consultez Télécharger automatiquement les paramètres de contenu multimédia. |
type : booléen | Affecte la notification système Valeurs : |
type : booléen | À partir de la version 2.35, vous ne pouvez plus réactiver le paramètre Permet la suppression ou le stockage des messages individuels dans une base de données locale une fois qu’ils ont été distribués ou lus. Les messages envoyés sont stockés dans une base de données locale. Cette base de données est utilisée comme historique de l’application. Comme l’entreprise conserve son propre historique, vous pouvez choisir que les messages transitent (
Nous vous recommandons de désactiver Valeurs : Redémarrage de la Coreapp requis. |
type : booléen | Si ce paramètre est activé, vous recevrez une notification Webhook Valeurs : |
type : booléen | Si ce paramètres est défini sur Par défaut : |
type : nombre entier | Nombre maximal de secondes qu’un nœud maître attend qu’un nœud Coreapp réponde à une pulsation avant de le considérer en mauvaise santé et de lancer le processus de basculement. Par défaut : 30 |
type : booléen | Ce champ est devenu obsolète depuis la version 2.39. Contrôle l’inclusion des charges utiles d’informations sur les conversations et les tarifs dans les notifications relatives au statut des messages. Valeurs : Le redémarrage de la Coreapp n’est pas requis. |
type : objet webhooks | Obligatoire lorsque vous utilisez des webhooks. Fournissez l’URL de votre webhook. Si l’URL du webhook n’est pas définie, les rappels seront abandonnés. Pour voir et tester simplement vos webhooks, reportez-vous à l’exemple d’app de test. Vous pouvez valider les évènements webhook en spécifiant un secret partagé comme paramètre de requête lorsque vous définissez l'URL du Webhook. Exemple : URL du webhook. Par exemple : Si l’URL du webhook n’est pas définie, les rappels sont abandonnés. Les rappels constituent un canal important pour la distribution des notifications en temps opportun et des erreurs hors bande. Nous vous recommandons donc vivement de configurer le point de terminaison de l’URL du Webhook. Pour plus de détails sur les champs des Webhooks, consultez le tableau des paramètres des Webhooks ci-dessous. | `log_level`
type : booléen | Active la consignation détaillée dans les Coreapps. Ce niveau de consignation doit être utilisé uniquement pour les tests en raison du volume élevé d’informations retournées. S’il est défini sur Valeurs : |
type : objet webhooks | Configure le niveau de consignation des Coreapps. Chaque niveau réduit progressivement la quantité de journaux affichés : Valeurs : |
Paramètres de Webhooks
| Nom | Description |
|---|---|
type : nombre entier | Configure le nombre maximal de demandes de rappel en ligne qui sont envoyées. Valeurs : |
type : chaîne | Les notifications entrantes et sortantes sont acheminées vers cette URL. Pour plus d’informations, consultez la documentation sur les Webhooks. Un point de terminaison HTTPS est requis ; les communications HTTP ne fonctionnent pas. |
type : Objet Messages Disponible à partir de la version 2.41.2 | Imbriqué dans l’objet L’entreprise peut choisir de recevoir ces notifications de webhook ou non en définissant les valeurs sur |
Paramètres du contenu multimédia
| Nom | Description |
|---|---|
type : tableau | Spécifie les types de contenu multimédia à télécharger automatiquement. Valeurs : |
Paramètres de la collecte des déchets
| Nom | Description |
|---|---|
type : booléen | Configure la collecte des déchets des messages. Valeurs : |
type : booléen | Configure la collecte des déchets des contenus multimédias. Valeurs : |
Réinitialisation des paramètres par défaut
Pour réinitialiser tous les paramètres par défaut des applications, envoyez une demande DELETE au point de terminaison /v1/settings/application.
Exemple de requête
DELETE /v1/settings/application
En cas de réussite, la réponse contient 200 OK avec null ou {}.
Si une erreur se produit, consultez les messages d’erreur et de statut.