Fejlesztők

DELETE/tcr/v2/campaign/{campaignId}

Üzenetküldési kampány inaktiválása

Kampány kivezetése, a hozzárendelt telefonszámok egyeztetése és az üres sikeres válasz értelmezése.

Ezen az oldalon
  1. Meglévő üzenetküldési kampány inaktiválása
  2. Először szüntesse meg az érintett számok hozzárendeléseit
  3. Küldje el a kívánt inaktiválási kérelmet
  4. Ellenőrizze a regisztrációt és a hozzárendeléseket is
  5. A kivezetés különálló művelet a fiók pénzügyi elszámolásától

Meglévő üzenetküldési kampány inaktiválása

Ezt a végpontot a fiók tulajdonában lévő kampány kivezetéséhez használja. Őrizze meg a kampány azonosítóját az egyeztetéshez és az előzmények nyomon követéséhez. Tartalmi javításokhoz vagy a hozzájárulási szöveg frissítéséhez használja inkább az Üzenetküldési kampány frissítése lehetőséget.

Végezze el a hitelesítést engedélyezett API-fiókkal, HTTPS kapcsolaton, engedélyezett forrás-IP-címről. Először kérdezze le a kampányt, és ellenőrizze a hozzá tartozó márkát és a küldéshez használt telefonszámokat. Az inaktiválás módosítja a regisztrációt; nem hoz létre helyettesítő kampányt, és nem helyez át számokat másik kampányba.

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

Először szüntesse meg az érintett számok hozzárendeléseit

A kampányok nyilvános DELETE művelete nem választja le a telefonszámokat az üzenetküldési szolgáltatóról, és nem törli a helyi hozzárendelésüket. Használja a szám kampányhoz rendelésének megszüntetésére szolgáló munkafolyamatot a fiók tulajdonában lévő összes érintett számhoz, majd ellenőrizze a hozzárendelésüket. A hozzárendelés megszüntetése nem szabadítja fel a telefonszámot.

A portál átfogóbb Márka törlése munkafolyamata a márka törlése előtt elvégzi a kampányok és számok rendbetételét. Ne használja ezt a műveletet, ha meg szeretné tartani a márkát és annak többi kampányát. A jelenlegi általános kampányszerkesztőben nincs külön kampánytörlő gomb, amely megfelelne ennek a közvetlen API-végpontnak.

Küldje el a kívánt inaktiválási kérelmet

A kampányazonosító és az érintett küldési beállítások áttekintése után küldjön DELETE kérést JSON törzs nélkül:

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"

A dokumentált sikeres válasz HTTP 204, üres törzzsel. A HTTP-állapotkódot ellenőrizze; ne várjon JSON formátumú status/response válaszburkolót. Elfogadott törlés esetén a jelenlegi szolgáltatás helyileg töröltnek és lejártnak jelöli a kampány erőforrását, a régi kampányrekordját pedig lejártnak jelöli. A törlés nem terjed ki automatikusan a márkára.

Ehhez a kívánt kéréshez egyetlen idempotenciakulcsot használjon, és az ismétléshez őrizze meg pontosan a metódust, az elérési utat, a lekérdezést és a törzs bájtjait. Egy már feldolgozás alatt álló kérés ismételt példánya 409 választ adhat Retry-After fejléccel; befejezett kéréseknél a tárolt eredmény adható vissza újra. Egy gyorsítótárazott hiba vagy megszakadt kapcsolat nem bizonyítja, hogy a nyilvántartás végrehajtotta-e már a műveletet. Őrizze meg a kampányazonosítót és a requestId értékét, ha rendelkezésre áll.

Ellenőrizze a regisztrációt és a hozzárendeléseket is

A kérés után ellenőrizze a portálon a kampány aktuális állapotát és az érintett számokat. Az API a kivezetés után is megőrizheti a tulajdonosi viszony helyi metaadatait, így a fiókhoz tartozó azonosító továbbra is ellenőrizhető; ne feltételezze, hogy ugyanannak az azonosítónak mindig helyi 404 választ kell adnia. A visszaadott állapotot, illetve a kivezetett rekord elérhetőségét a nyilvántartás határozza meg.

Ha egy szám hozzárendelése megmarad, rendezze ezt a meglévő hozzárendelést. Ne hozzon létre másik kampányt pusztán az inaktiválás újrapróbálásához, és ne feltételezze, hogy a HTTP 204 válasz bizonyítja a szolgáltatói oldali rendbetétel megtörténtét. Ha a helyi szinkronizálás a kérés nyilvántartás általi elfogadása után meghiúsul, az API 500 választ adhat akkor is, ha a külső inaktiválás már megtörtént.

Az inaktiválás eredményei
EredményKövetkező lépés
204Nem várható választörzs. Ellenőrizze a kampány állapotát és a külön kezelt számhozzárendeléseket.
400Olvassa el a kapott, érvényesítéssel vagy a nyilvántartás állapotával kapcsolatos hibaüzenetet. Ellenőrizze a kampány pontos azonosítóját és meglévő állapotát.
401, 403, 404Ellenőrizze az API hitelesítő adatait, az engedélyezett forrás-IP-címet és azt, hogy az erőforrás a fiók tulajdonában van-e. Ne használja helyette más ügyfél azonosítóját.
409, 429Különböztesse meg a folyamatban lévő vagy ütköző idempotens kérést a kérési gyakoriság korlátozásától; ha van Retry-After fejléc, tartsa be az abban megadott várakozási időt.
500, 502 vagy időtúllépésŐrizze meg a kérés részleteit, kérdezze le a meglévő kampányt, és újabb beküldés előtt egyeztesse az állapotot.

A kivezetés különálló művelet a fiók pénzügyi elszámolásától

A jelenlegi DELETE szolgáltatás nem indít azonnali kampányregisztrációs díjterhelést. Ez nem jelent visszatérítési ígéretet, nem szüntet meg meglévő kötelezettségvállalást, és nem szabadítja fel a bérelt számokat. Ellenőrizze a portálon a fiókra vonatkozó kampányfeltételeket és a kiegyenlítetlen számlákat. A számbérlés és az üzenetforgalom elszámolása elkülönül a kampányregisztrációtól.

Ha a kampányok és hozzárendelések egyeztetése után a vállalkozás teljes regisztrációját kivezeti, folytassa a márka kivezetésével.