Korrigeer ’n veldtog sonder om nog ’n registrasie te skep
Gebruik hierdie roete om ’n bestaande veldtog se beskrywing, boodskapvoorbeelde, verduideliking van toestemming of ondersteunde inhoudskenmerke te hersien. Behou die veldtog-ID en die huidige handelsmerk en gebruiksgeval. ’n Nuwe registrasie is nie die meganisme om ’n bestaande veldtogkorreksie weer te probeer nie.
Staaf jou identiteit met ’n geaktiveerde API-rekening oor HTTPS vanaf ’n toegelate bron-IP-adres. Slegs ’n veldtog wat aan daardie rekening behoort, is beskikbaar. Lees die huidige toestand voordat jy veranderinge voorberei; vervalde veldtogte kan nie deur hierdie werkvloei bygewerk word nie.
curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"Kies die velde wat werklik verander het
Berei campaign-update.json met die ondersteunde veranderinge voor. Die huidige portaal stuur slegs gewysigde veldtogvelde en stuur nie brandId, usecase, campaignId of statusinligting wat slegs in antwoorde voorkom nie. Direkte API-bywerkings gebruik ook ’n JSON-objek met velde, nie die portaal se changes/version-omhulsel nie.
| Velde | Wat om te verskaf |
|---|---|
| description, messageFlow | ’n Akkurate beskrywing van die diens en hoe mense toestemming gee, boodskappe ontvang en toestemming terugtrek. Elkeen laat 40–4096 karakters toe. |
| sample1–sample5 | Realistiese voorbeelde vir hierdie veldtog, met 20–1024 karakters per nieleë voorbeeld. Behou die aantal voorbeelde wat die gekwalifiseerde gebruiksgeval vereis; moenie onverwante boodskappe stuur nie. |
| helpMessage, optinMessage, optoutMessage | Toepaslike antwoorde wat aan ontvangers gewys word, tot 1024 karakters. Voldoen waar nodig aan die minimum van 20 karakters en verduidelik die werklike diens. Gaan die huidige toestemmingsvereistes na voordat jy ’n veld leegmaak. |
| optinKeywords, optoutKeywords, helpKeywords | Komma-geskeide sleutelwoorde sonder spasies, tot 255 karakters. Hou antwoorde en die werklike hantering van sleutelwoorde in ooreenstemming. |
| privacyPolicyLink, termsAndConditionsLink | Toepaslike openbare webadresse, tot 2048 karakters, wat hierdie diens se werklike praktyke beskryf. |
| embeddedLinkSample | ’n Verteenwoordigende skakel wat in die boodskappe sal voorkom, tot 255 karakters. |
| numberPool, embeddedLink, embeddedPhone, ageGated, directLending | Werklike veldtogkenmerke as JSON-Boole-waardes. Gebruik false, nie die string "false" nie, wanneer jy een deaktiveer. |
| autoRenewal | Die openbare API-skema ondersteun hierdie JSON-Boole-waarde, hoewel die portaal se gewone redigeerder vir veldtoginhoud dit nie beskikbaar stel nie. Die deaktivering van hernuwing kanselleer nie ’n bestaande minimumverbintenis of skeld reeds verskuldigde heffings kwyt nie. |
| resellerId | Die skema maak ook voorsiening vir koppeling aan ’n herverkoper. Dit val buite die portaal se gewone vorm vir inhoudskorreksies. Moenie hierdie veld gebruik om ’n veldtog tussen klante te verskuif of aanneem dat die API die netwerkoperateur se diens vir ’n ander herverkoper sal opstel nie. |
Die bywerkingskema bied nie brandId, usecase, subscriberOptin, subscriberOptout of subscriberHelp as wysigbare velde nie. Moenie ’n volledige datalading vir veldtogskepping na ’n bywerking kopieer nie. Raadpleeg die huidige kwalifikasie wanneer jy boodskapvereistes nagaan.
Dien ’n gerigte korreksie in
Hierdie voorbeeld illustreer ’n diens vir afspraakherinnerings. Pas dit by die veldtog se werklike diens en toestemmingsproses aan voordat jy dit gebruik.
{
"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"Behou dieselfde sleutel en presies dieselfde metode, pad, navraag en liggaamsgrepe vir dieselfde beoogde indiening. Gewysigde inhoud vereis ’n versoek wat afsonderlik nagegaan is; moenie sleutels blindelings vervang nadat die wagtyd verstryk het nie. ’n Voltooide versoek kan ’n fout uit die kas weer teruggee, en ’n duplikaat wat nog verwerk word, kan 409 saam met Retry-After teruggee.
Lees die veldtog weer
HTTP 200 gee direk ’n JSON-objek vir die veldtog terug. Verifieer campaignId, haal dan dieselfde veldtog met GET op en vergelyk die beoogde velde. ’n Suksesvolle stooraksie versoek nie op sigself nog ’n hersiening deur die netwerkoperateur, verander nie nommertoewysings, aktiveer nie versending en stuur nie ’n boodskap nie.
Die portaal kontroleer ’n vormweergawe voordat dit stoor en lees die veldtog daarna weer. Die openbare PUT-eindpunt dwing nie daardie portaalweergawe af nie: koördineer gelyktydige wysigings. ’n Idempotensiesleutel bespeur nie ’n ander redigeerder se bywerking nie.
As die portaal ’n onopgeloste afkeuring ná hersiening wys, korrigeer eers die inhoud en gebruik dan die afsonderlike aksie om hersiening aan te vra wanneer dit beskikbaar is. Daardie aksie kontroleer die huidige veldtog in die produksieomgewing en die deelstatus. Om bloot inhoud te stoor, roep dit nie aan nie, en die bestaan van ’n veldtog-ID bewys nie goedkeuring nie.
Gewone PUT-bywerkings van veldtogte veroorsaak nie ’n afsonderlike debitering vir veldtogregistrasie in die huidige diens nie. Bestaande maandelikse fooie, minimumverbintenisse, nommerhuur en boodskapgebruik bly van toepassing. Vir die veldtogtariewe wat tans opgestel is, sien veldtogfooie.
Hanteer beperkings en onsekere resultate
Lees by HTTP 400 die fout op veldvlak en kontroleer lengtes, toestemmingsteks en die veldtog se toestand. Kontroleer by 401, 403 of 404 die API-aanmeldbesonderhede, toegelate bron-IP-adres en eienaarskap. Hou by 429 by Retry-After. Behou by 500, 502 of ’n onderbreekte versoek die veldtog-ID en enige requestId, en gaan die bestaande rekord na en versoen dit voordat jy weer indien.
Die plaaslike momentopname hang af van die liggaam wat teruggestuur word. ’n Nieleë gedeeltelike antwoord kan ouer velde weglaat, insluitend hernuwingsmetadata; ’n leë antwoord kan verouderde waardes behou. Verifieer die volledige GET-resultaat eerder as om sukses alleen as bewys te beskou dat elke veld behoue gebly het. Meld onopgeloste verskille by ondersteuning aan. Hierdie roete werk nie netwerkoperateurtoewysings atomies by nie en bied nie ’n algemene herstelaksie vir netwerkoperateuraktivering nie.