Disattivare una campagna di messaggistica esistente
Usa questo endpoint quando devi dismettere una campagna di proprietà dell’account. Conserva l’ID della campagna per le verifiche di allineamento e lo storico. Per correggere i contenuti o aggiornare il testo del consenso, usa Aggiornare una campagna di messaggistica in alternativa.
Autenticati con un account API abilitato tramite HTTPS, da un indirizzo IP di origine consentito. Recupera prima i dati della campagna e verifica il marchio e i numeri di invio associati. La disattivazione modifica la registrazione; non crea una campagna sostitutiva e non sposta i numeri in un’altra campagna.
curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"Rimuovere prima le assegnazioni dei numeri interessati
L’operazione pubblica DELETE sulla campagna non scollega i numeri di telefono dall’operatore di messaggistica e non cancella la loro assegnazione locale. Usa il flusso di rimozione dell’associazione tra numero e campagna per ciascun numero interessato di proprietà dell’account, quindi verificane l’assegnazione. Rimuovere un’assegnazione non comporta il rilascio del numero di telefono.
Il flusso più ampio Elimina marchio del portale esegue le operazioni di pulizia delle campagne e dei numeri del marchio prima di eliminarlo. Non usare questa azione se intendi conservare il marchio e le sue altre campagne. L’attuale editor standard delle campagne non offre un pulsante separato per eliminare una campagna equivalente a questo endpoint API diretto.
Inviare la richiesta di disattivazione prevista
Dopo aver verificato l’ID della campagna e la configurazione di invio interessata, invia DELETE senza corpo 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 risposta di esito positivo documentata è HTTP 204 con corpo vuoto. Controlla il codice di stato HTTP anziché aspettarti un involucro JSON con status/response. Quando l’eliminazione viene accettata, il servizio attuale contrassegna localmente la risorsa della campagna come eliminata e scaduta e contrassegna come scaduto il relativo record nel sistema precedente. L’eliminazione non si propaga al marchio.
Usa un’unica chiave di idempotenza per questa richiesta e conserva esattamente il metodo, il percorso, la stringa di query e i byte del corpo per ripeterla. Una richiesta duplicata mentre l’elaborazione è in corso può restituire 409 con Retry-After; per le richieste completate può essere restituito nuovamente il risultato memorizzato. Un errore memorizzato nella cache o una connessione interrotta non permettono di stabilire se il registro abbia già eseguito l’operazione. Conserva l’ID della campagna e requestId, quando presente.
Verificare sia la registrazione sia le assegnazioni
Dopo la richiesta, controlla nel portale lo stato attuale della campagna e i numeri interessati. L’API può conservare metadati locali sulla proprietà dopo la dismissione, consentendo ancora di verificare un identificativo appartenente all’account; non dedurre che lo stesso ID debba sempre restituire un 404 locale. Il registro determina lo stato restituito o la disponibilità del record dismesso.
Se un numero risulta ancora assegnato, verifica e allinea l’assegnazione esistente. Non creare un’altra campagna solo per ritentare la disattivazione e non presumere che un HTTP 204 dimostri l’avvenuta pulizia presso l’operatore. Se la sincronizzazione locale non riesce dopo che il registro ha accettato la richiesta, l’API può restituire 500 anche se la disattivazione esterna è già avvenuta.
| Esito | Passaggio successivo |
|---|---|
| 204 | Non è previsto alcun corpo della risposta. Verifica lo stato della campagna e le assegnazioni dei numeri, gestite separatamente. |
| 400 | Leggi l’errore restituito relativo alla convalida o allo stato nel registro. Verifica l’esatto ID della campagna e lo stato esistente. |
| 401, 403, 404 | Verifica le credenziali API, l’IP di origine consentito e la proprietà della risorsa da parte dell’account. Non usare al suo posto l’ID di un altro cliente. |
| 409, 429 | Distingui una richiesta idempotente in corso o in conflitto dal superamento dei limiti di frequenza; rispetta Retry-After quando fornito. |
| 500, 502 o tempo di attesa scaduto | Conserva i dettagli della richiesta, recupera i dati della campagna esistente e verifica e allinea lo stato prima di un nuovo invio. |
La dismissione è distinta dal saldo dei conti dell’account
Il servizio DELETE attuale non avvia un addebito immediato per la registrazione della campagna. Questo non garantisce un rimborso, non annulla un impegno esistente e non rilascia i numeri a noleggio. Controlla nel portale le condizioni delle campagne dell’account e le fatture ancora da saldare. Il noleggio dei numeri e il consumo di messaggi sono distinti dalla registrazione della campagna.
Se devi dismettere l’intera registrazione aziendale dopo aver verificato e allineato le relative campagne e assegnazioni, prosegui con la dismissione del marchio.