Labojiet kampaņu, neveidojot vēl vienu reģistrāciju
Izmantojiet šo maršrutu, lai labotu esošas kampaņas aprakstu, ziņojumu piemērus, piekrišanas skaidrojumu vai atbalstītos satura raksturlielumus. Saglabājiet kampaņas ID un tās pašreizējo zīmolu un lietojuma scenāriju. Jauna reģistrācija nav veids, kā atkārtoti mēģināt labot esošu kampaņu.
Autentificējieties ar iespējotu API kontu, izmantojot HTTPS savienojumu no atļautas avota IP adreses. Pieejama ir tikai šim kontam piederoša kampaņa. Pirms izmaiņu sagatavošanas nolasiet tās pašreizējo stāvokli; kampaņas, kuru termiņš ir beidzies, šajā darbplūsmā nevar atjaunināt.
curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"Izvēlieties tikai tos laukus, kas patiešām ir mainījušies
Sagatavojiet failu campaign-update.json ar atbalstītajām izmaiņām. Pašreizējais portāls nosūta tikai mainītos kampaņas laukus un nenosūta brandId, usecase, campaignId vai statusa informāciju, kas paredzēta tikai atbildēm. Arī tiešajiem API atjauninājumiem izmanto lauku JSON objektu, nevis portāla changes/version apvalku.
| Lauki | Norādāmā informācija |
|---|---|
| description, messageFlow | Precīzs pakalpojuma apraksts un skaidrojums par to, kā cilvēki sniedz piekrišanu, saņem ziņojumus un atsauc piekrišanu. Katrā laukā atļautas 40–4096 rakstzīmes. |
| sample1–sample5 | Reālistiski šīs kampaņas piemēri ar 20–1024 rakstzīmēm katrā netukšā piemērā. Saglabājiet kvalificētajam lietojuma scenārijam nepieciešamo piemēru skaitu; nesūtiet nesaistītus ziņojumus. |
| helpMessage, optinMessage, optoutMessage | Attiecīgās saņēmējiem paredzētās atbildes, ne garākas par 1024 rakstzīmēm. Ja tas ir obligāti, ievērojiet minimālo 20 rakstzīmju garumu un izskaidrojiet faktisko pakalpojumu. Pirms lauka satura dzēšanas pārskatiet pašreizējās piekrišanas prasības. |
| optinKeywords, optoutKeywords, helpKeywords | Ar komatiem atdalīti atslēgvārdi bez atstarpēm, kopā ne vairāk par 255 rakstzīmēm. Nodrošiniet, lai atbildes atbilstu faktiskajai atslēgvārdu apstrādei. |
| privacyPolicyLink, termsAndConditionsLink | Atbilstošas publiski pieejamas URL adreses, ne garākas par 2048 rakstzīmēm, kurās aprakstīta šī pakalpojuma faktiskā prakse. |
| embeddedLinkSample | Raksturīgs ziņojumos iekļaujamās saites piemērs, ne garāks par 255 rakstzīmēm. |
| numberPool, embeddedLink, embeddedPhone, ageGated, directLending | Faktiskie kampaņas raksturlielumi kā JSON loģiskās vērtības. Lai kādu no tiem atspējotu, izmantojiet false, nevis virkni "false". |
| autoRenewal | Publiskā API shēma atbalsta šo JSON loģisko vērtību, lai gan portāla parastajā kampaņas satura redaktorā tā nav pieejama. Atjaunošanas atspējošana neatceļ esošās minimālās līgumsaistības un nedzēš jau maksājamās summas. |
| resellerId | Shēma piedāvā arī piesaisti tālākpārdevējam. Šī iespēja nav iekļauta portāla parastajā satura labošanas veidlapā. Neizmantojiet šo lauku, lai pārvietotu kampaņu no viena klienta pie cita, un nepieņemiet, ka API konfigurēs operatora pakalpojumu citam tālākpārdevējam. |
Atjaunināšanas shēmā brandId, usecase, subscriberOptin, subscriberOptout un subscriberHelp nav pieejami kā maināmi lauki. Nekopējiet pilnu kampaņas izveides pieprasījuma saturu atjaunināšanas pieprasījumā. Skatiet pašreizējo kvalifikāciju, pārskatot ziņojumu prasības.
Iesniedziet konkrētu labojumu
Šajā piemērā ilustrēts atgādinājumu pakalpojums par ieplānotām vizītēm. Pirms izmantošanas pielāgojiet to kampaņas faktiskajam pakalpojumam un piekrišanas saņemšanas procesam.
{
"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"Atkārtojot vienu un to pašu paredzēto iesniegumu, saglabājiet to pašu atslēgu un precīzi tos pašus metodes, ceļa, vaicājuma un pamatteksta baitus. Mainītam saturam nepieciešams atsevišķi pārskatīts pieprasījums; pēc taimauta akli nemainiet atslēgas. Pabeigts pieprasījums var atkārtoti atgriezt kešatmiņā saglabātu kļūdu, savukārt pieprasījuma, kas vēl tiek apstrādāts, dublikāts var atgriezt 409 ar Retry-After.
Nolasiet kampaņu vēlreiz
HTTP 200 atgriež kampaņas JSON objektu tieši, bez apvalka. Pārbaudiet campaignId, pēc tam nolasiet to pašu kampaņu ar GET un salīdziniet paredzētos laukus. Sekmīga saglabāšana pati par sevi nepieprasa atkārtotu operatora pārskatīšanu, nemaina numuru piesaistes, neaktivizē sūtīšanu un nenosūta ziņojumu.
Portāls pirms saglabāšanas pārbauda veidlapas versiju un pēc tam vēlreiz nolasa kampaņu. Publiskais PUT galapunkts neprasa atbilstību šai portāla versijai: saskaņojiet vienlaicīgus labojumus. Idempotences atslēga neatklāj cita redaktora veiktu atjauninājumu.
Ja portālā redzams vēl neatrisināts pārskatīšanas noraidījums, vispirms izlabojiet saturu un pēc tam izmantojiet atsevišķo pārskatīšanas pieprasīšanas darbību, kad tā ir pieejama. Šī darbība pārbauda pašreizējo kampaņu produkcijas vidē un tās kopīgošanas stāvokli. Tikai satura saglabāšana šo darbību neizsauc, un kampaņas ID esamība neapliecina apstiprinājumu.
Pašreizējā pakalpojumā parasti kampaņas PUT atjauninājumi neizraisa atsevišķu kampaņas reģistrācijas maksas ieturējumu. Joprojām ir spēkā esošās ikmēneša maksas, minimālās līgumsaistības, numuru noma un maksa par ziņojumu izmantošanu. Pašreiz iestatītos kampaņu tarifus skatiet sadaļā kampaņu maksas.
Rīcība ierobežojumu un neskaidru rezultātu gadījumā
Ja saņemat HTTP 400, izlasiet konkrētā lauka kļūdu un pārbaudiet garuma ierobežojumus, piekrišanas tekstu un kampaņas stāvokli. Ja saņemat 401, 403 vai 404, pārbaudiet API akreditācijas datus, atļauto avota IP adresi un piederību kontam. Ja saņemat 429, ievērojiet Retry-After. Ja saņemat 500, 502 vai pieprasījums tiek pārtraukts, saglabājiet kampaņas ID un jebkuru pieejamo requestId, pēc tam pirms atkārtotas iesniegšanas pārbaudiet esošo ierakstu un noskaidrojiet tā atbilstību iecerētajam rezultātam.
Lokālais momentuzņēmums ir atkarīgs no atgrieztā atbildes satura. Netukšā daļējā atbildē var nebūt agrāko lauku, tostarp atjaunošanas metadatu; tukša atbilde var atstāt novecojušas vērtības. Pārbaudiet pilno GET rezultātu, nevis uzskatiet tikai sekmīgu izpildi par pierādījumu tam, ka visi lauki ir saglabāti. Par neatrisinātām atšķirībām ziņojiet atbalsta dienestam. Šis maršruts atomāri neatjaunina operatoru piesaistes un nenodrošina vispārīgu atkopšanas darbību operatora pakalpojuma aktivizēšanai.