Désactiver une campagne de messagerie

Désactiver une campagne de messagerie existante

Utilisez cette route pour mettre hors service une campagne appartenant au compte. Conservez son identifiant pour les rapprochements et l’historique. Pour corriger le contenu ou modifier le texte de consentement, utilisez Mettre à jour une campagne de messagerie à la place.

Authentifiez-vous avec un compte API activé, via HTTPS, depuis une adresse IP source autorisée. Consultez d’abord la campagne et vérifiez la marque et les numéros d’envoi associés. La désactivation modifie l’enregistrement ; elle ne crée pas de campagne de remplacement et ne transfère pas les numéros vers une autre campagne.

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"

Supprimer d’abord les affectations des numéros concernés

L’opération publique DELETE sur une campagne ne dissocie pas les numéros de téléphone auprès de l’opérateur de messagerie et ne supprime pas leur affectation locale. Utilisez la procédure de suppression de l’association d’un numéro à une campagne pour chaque numéro concerné appartenant au compte, puis vérifiez son affectation. La suppression d’une affectation ne libère pas le numéro de téléphone.

La procédure plus globale « Supprimer une marque » du portail effectue le nettoyage des campagnes et des numéros de la marque avant de la supprimer. N’utilisez pas cette action si vous souhaitez conserver la marque et ses autres campagnes. L’éditeur de campagne standard actuel ne propose pas de bouton distinct de suppression de campagne équivalent à cette route directe de l’API.

Envoyer la demande de désactivation prévue

Après avoir vérifié l’identifiant de la campagne et la configuration d’envoi concernée, envoyez DELETE sans corps JSON :

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  --request DELETE \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  "https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"

La réponse de réussite documentée est HTTP 204 avec un corps vide. Examinez le statut HTTP plutôt que d’attendre une enveloppe JSON status/response. Lorsque la suppression est acceptée, le service actuel marque localement la ressource de campagne comme supprimée et expirée, et marque son ancien enregistrement de campagne comme expiré. La suppression ne s’étend pas à la marque.

Utilisez une seule clé d’idempotence pour cette demande et conservez exactement la méthode, le chemin, la chaîne de requête et les octets du corps pour pouvoir la rejouer. Un doublon en cours de traitement peut renvoyer 409 avec Retry-After ; les demandes terminées peuvent renvoyer à nouveau le résultat enregistré. Une erreur mise en cache ou une connexion interrompue ne permet pas de déterminer si le registre a déjà exécuté l’opération. Conservez l’identifiant de la campagne et requestId lorsqu’il est présent.

Vérifier l’enregistrement et les affectations

Après la demande, vérifiez l’état actuel de la campagne et les numéros concernés dans le portail. L’API peut conserver des métadonnées locales d’appartenance après la mise hors service, ce qui permet encore de vérifier un identifiant appartenant au compte ; n’en déduisez pas que ce même identifiant doit toujours renvoyer une erreur locale 404. Le registre détermine le statut renvoyé ou la disponibilité de l’enregistrement mis hors service.

Si un numéro reste affecté, rapprochez les données de cette affectation existante. Ne créez pas une autre campagne simplement pour réessayer la désactivation et ne supposez pas qu’une réponse HTTP 204 prouve que le nettoyage a été effectué chez l’opérateur. Si la synchronisation locale échoue après l’acceptation de la demande par le registre, l’API peut renvoyer 500 alors que la désactivation externe a déjà eu lieu.

Résultats de la désactivation
Résultat	Étape suivante
204	Aucun corps de réponse n’est attendu. Vérifiez l’état de la campagne et les affectations de numéros, qui sont gérées indépendamment.
400	Lisez l’erreur de validation ou d’état du registre fournie. Vérifiez l’identifiant exact de la campagne et son état actuel.
401, 403, 404	Vérifiez les identifiants d’authentification de l’API, l’adresse IP source autorisée et l’appartenance au compte. N’utilisez pas à la place l’identifiant d’un autre client.
409, 429	Distinguez une demande idempotente en cours ou en conflit d’une limitation du débit des requêtes ; respectez Retry-After lorsque cet en-tête est fourni.
500, 502 ou délai d’attente dépassé	Conservez les détails de la demande, consultez la campagne existante et rapprochez les données avant tout nouvel envoi.

La mise hors service est distincte du règlement du compte

Le service DELETE actuel ne déclenche pas de débit immédiat pour l’enregistrement de la campagne. Cela ne garantit aucun remboursement, n’annule aucun engagement existant et ne libère pas les numéros loués. Consultez les conditions applicables aux campagnes du compte et les factures impayées dans le portail. La location des numéros et l’utilisation des messages sont distinctes de l’enregistrement des campagnes.

Si l’ensemble de l’enregistrement de l’entreprise doit être mis hors service après le rapprochement de ses campagnes et de leurs affectations, poursuivez avec la mise hors service de la marque.