Kampány javítása újabb regisztráció létrehozása nélkül
Ezzel az útvonallal módosíthatja egy meglévő kampány leírását, üzenetmintáit, a hozzájárulás módjának ismertetését vagy a támogatott tartalmi jellemzőket. Tartsa meg a kampány azonosítóját, valamint a hozzá jelenleg tartozó márkát és felhasználási esetet. Meglévő kampány javításának újbóli megkísérléséhez nem új regisztrációt kell létrehozni.
Hitelesítse magát egy engedélyezett API-fiókkal, HTTPS kapcsolaton keresztül, engedélyezett forrás-IP-címről. Csak az adott fiókhoz tartozó kampány érhető el. A módosítások előkészítése előtt kérdezze le az aktuális állapotát; a lejárt kampányok ezzel a munkafolyamattal nem frissíthetők.
curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"Válassza ki a ténylegesen megváltozott mezőket
Készítse el a támogatott módosításokat tartalmazó campaign-update.json fájlt. A jelenlegi portál csak a megváltozott kampánymezőket küldi el; a brandId, usecase, campaignId mezőket és a kizárólag válaszban szereplő állapotinformációkat nem. A közvetlen API-frissítések is a mezőket tartalmazó JSON-objektumot használják, nem a portál changes/version burkolóstruktúráját.
| Mezők | Megadandó tartalom |
|---|---|
| description, messageFlow | A szolgáltatás pontos leírása, valamint annak ismertetése, hogyan adják meg az érintettek a hozzájárulásukat, hogyan kapnak üzeneteket, és hogyan vonják vissza a hozzájárulásukat. Mindkét mező 40–4096 karaktert enged meg. |
| sample1–sample5 | A kampányra jellemző, életszerű minták; minden nem üres minta 20–1024 karakter hosszúságú lehet. Tartsa meg a minősített felhasználási eset által megkövetelt mintaszámot; ne küldjön a kampányhoz nem kapcsolódó üzeneteket. |
| helpMessage, optinMessage, optoutMessage | A címzetteknek szánt, alkalmazandó válaszüzenetek, legfeljebb 1024 karakterrel. Ahol előírás, tartsa be a 20 karakteres minimumot, és ismertesse a tényleges szolgáltatást. Mező kiürítése előtt tekintse át a hozzájárulásra vonatkozó aktuális követelményeket. |
| optinKeywords, optoutKeywords, helpKeywords | Vesszővel elválasztott kulcsszavak szóközök nélkül, legfeljebb 255 karakterrel. Gondoskodjon arról, hogy a válaszüzenetek és a kulcsszavak tényleges feldolgozása összhangban legyenek. |
| privacyPolicyLink, termsAndConditionsLink | A szolgáltatás tényleges gyakorlatát ismertető, kapcsolódó nyilvános URL-címek, legfeljebb 2048 karakterrel. |
| embeddedLinkSample | Az üzenetekben szereplő hivatkozásokat szemléltető minta, legfeljebb 255 karakterrel. |
| numberPool, embeddedLink, embeddedPhone, ageGated, directLending | A kampány tényleges jellemzői JSON logikai értékekként. Egy jellemző kikapcsolásakor a false értéket használja, ne a "false" karakterláncot. |
| autoRenewal | A nyilvános API sémája támogatja ezt a JSON logikai értéket, bár a portál szokásos kampánytartalom-szerkesztője nem teszi elérhetővé. A megújítás kikapcsolása nem szünteti meg a meglévő minimális vállalási kötelezettséget, és nem törli a már esedékes díjakat. |
| resellerId | A séma viszonteladóhoz rendelést is lehetővé tesz. Ez nem része a portál szokásos tartalomjavító űrlapjának. Ne használja ezt a mezőt kampány ügyfelek közötti áthelyezésére, és ne feltételezze, hogy az API egy másik viszonteladó számára állítja be a távközlési szolgáltatást. |
A frissítési séma nem teszi módosíthatóvá a brandId, usecase, subscriberOptin, subscriberOptout vagy subscriberHelp mezőket. Ne másolja át egy kampány létrehozásának teljes kéréstörzsét egy frissítési kérésbe. Az üzenetkövetelmények áttekintésekor tekintse meg az aktuális minősítés követelményeit.
Küldjön be célzott javítást
Ez a példa egy szemléltető, időpont-emlékeztető szolgáltatást ír le. Használat előtt igazítsa a kampány tényleges szolgáltatásához és hozzájárulási folyamatához.
{
"description": "Appointment reminders requested by customers of the registered business.",
"sample1": "Example business: Your requested appointment reminder is ready. Reply STOP to opt out."
}curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
--request PUT \
--header 'Content-Type: application/json' \
--header "Idempotency-Key: $IDEMPOTENCY_KEY" \
--data-binary @campaign-update.json \
"https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"Ugyanannak a beküldésnek az ismétlésekor tartsa meg ugyanazt a kulcsot, valamint a metódust, az útvonalat, a lekérdezést és a törzset pontosan, bájtról bájtra. A megváltozott tartalom külön felülvizsgált kérést igényel; időtúllépés után ne cserélgesse vaktában a kulcsokat. Egy befejezett kérés megismétlése gyorsítótárazott hibát is visszaadhat, egy még feldolgozás alatt álló kérés ismétlése pedig 409 választ adhat Retry-After fejléccel.
Kérdezze le újra a kampányt
A HTTP 200 válasz közvetlenül egy kampányt leíró JSON-objektumot ad vissza. Ellenőrizze a campaignId értékét, majd kérdezze le ugyanazt a kampányt GET kéréssel, és hasonlítsa össze a módosítani kívánt mezőket. A sikeres mentés önmagában nem kér újabb szolgáltatói felülvizsgálatot, nem módosítja a számok hozzárendelését, nem aktiválja az üzenetküldést, és nem küld üzenetet.
A portál mentés előtt ellenőrzi az űrlap verzióját, utána pedig újra lekérdezi a kampányt. A nyilvános PUT végpont nem ellenőrzi ezt a portálverziót: egyeztessék az egyidejű szerkesztéseket. Az idempotenciakulcs nem észleli egy másik szerkesztő frissítését.
Ha a portál még rendezetlen felülvizsgálati elutasítást jelez, először javítsa a tartalmat, majd ha elérhető, használja a külön felülvizsgálatkérő műveletet. Ez a művelet ellenőrzi az éles kampány aktuális állapotát és megosztási állapotát. A tartalom mentése önmagában nem indítja el ezt a műveletet, és a kampányazonosító megléte nem jelent jóváhagyást.
A jelenlegi szolgáltatásban a szokásos PUT kampányfrissítések nem indítanak külön kampányregisztrációs díjterhelést. A meglévő havi díjak, minimális vállalási kötelezettségek, számbérleti és üzenetforgalmi díjak továbbra is érvényesek. Az aktuálisan beállított kampánydíjakat a következő helyen találja: kampánydíjak.
Korlátozások és bizonytalan eredmények kezelése
HTTP 400 esetén olvassa el a mezőszintű hibát, és ellenőrizze a hosszkorlátokat, a hozzájárulás szövegét és a kampány állapotát. 401, 403 vagy 404 esetén ellenőrizze az API hitelesítő adatait, az engedélyezett forrás-IP-címet és a tulajdonjogot. 429 esetén tartsa be a Retry-After fejléc előírását. 500, 502 vagy megszakadt kérés esetén őrizze meg a kampány azonosítóját és az esetleges requestId értéket, majd újabb beküldés előtt egyeztesse a meglévő rekord tényleges állapotát.
A helyi pillanatkép a visszaadott válasz törzsétől függ. Egy nem üres, részleges válaszból hiányozhatnak korábbi mezők, köztük a megújítás metaadatai; egy üres válasz pedig elavult értékeket hagyhat meg. Ellenőrizze a teljes GET eredményt, és ne tekintse önmagában a sikert annak bizonyítékának, hogy minden mező megmaradt. A fel nem oldott eltéréseket jelezze az ügyfélszolgálatnak. Ez az útvonal nem frissíti atomi művelettel a szolgáltatói hozzárendeléseket, és nem biztosít általános helyreállítási műveletet a szolgáltatói aktiváláshoz.