Korrigjoni një fushatë pa krijuar një regjistrim tjetër
Përdoreni këtë rrugë për të rishikuar përshkrimin e një fushate ekzistuese, shembujt e mesazheve, shpjegimin e pëlqimit ose karakteristikat e mbështetura të përmbajtjes. Ruani identifikuesin e fushatës dhe markën/rastin e saj aktual të përdorimit. Një regjistrim i ri nuk është mekanizmi i riprovimit për korrigjimin e një fushate ekzistuese.
Autentikohuni me një llogari API të aktivizuar përmes HTTPS, nga një adresë IP burimore e lejuar. Mund të përdorni vetëm një fushatë që i përket asaj llogarie. Lexoni gjendjen e saj aktuale përpara se të përgatitni ndryshimet; fushatat e skaduara nuk mund të përditësohen përmes kësaj rrjedhe pune.
curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"Zgjidhni fushat që kanë ndryshuar vërtet
Përgatitni campaign-update.json me ndryshimet e mbështetura. Portali aktual dërgon vetëm fushat e ndryshuara të fushatës dhe nuk dërgon brandId, usecase, campaignId apo informacion gjendjeje që shfaqet vetëm në përgjigje. Edhe përditësimet e drejtpërdrejta përmes API përdorin një objekt JSON me fusha, jo strukturën mbështjellëse changes/version të portalit.
| Fushat | Çfarë duhet të jepni |
|---|---|
| description, messageFlow | Një përshkrim i saktë i shërbimit dhe i mënyrës se si njerëzit japin pëlqimin, marrin mesazhe dhe tërheqin pëlqimin. Secila fushë lejon 40–4096 karaktere. |
| sample1–sample5 | Shembuj realistë për këtë fushatë, me 20–1024 karaktere për çdo shembull jo të zbrazët. Ruani numrin e shembujve të kërkuar nga rasti i përdorimit për të cilin është kualifikuar fushata; mos dërgoni mesazhe pa lidhje me të. |
| helpMessage, optinMessage, optoutMessage | Përgjigjet përkatëse që u shfaqen marrësve, deri në 1024 karaktere. Kur kërkohet, plotësoni minimumin prej 20 karakteresh dhe shpjegoni shërbimin real. Shqyrtoni kërkesat aktuale për pëlqimin përpara se të zbrazni një fushë. |
| optinKeywords, optoutKeywords, helpKeywords | Fjalë kyçe të ndara me presje, pa hapësira, deri në 255 karaktere. Mbani përputhje ndërmjet përgjigjeve dhe mënyrës se si fjalët kyçe trajtohen në funksionimin real. |
| privacyPolicyLink, termsAndConditionsLink | Adresa URL publike përkatëse, deri në 2048 karaktere, që përshkruajnë praktikat reale të këtij shërbimi. |
| embeddedLinkSample | Një lidhje përfaqësuese që do të përfshihet në mesazhe, deri në 255 karaktere. |
| numberPool, embeddedLink, embeddedPhone, ageGated, directLending | Karakteristikat reale të fushatës si vlera buleane JSON. Përdorni false, jo vargun tekstual "false", kur çaktivizoni njërën prej tyre. |
| autoRenewal | Skema publike e API e mbështet këtë vlerë buleane JSON, megjithëse redaktuesi i zakonshëm i përmbajtjes së fushatës në portal nuk e ofron. Çaktivizimi i rinovimit nuk anulon një angazhim minimal ekzistues dhe nuk fshin tarifat që tashmë duhen paguar. |
| resellerId | Skema ofron edhe lidhjen me një rishitës. Kjo nuk përfshihet në formularin e zakonshëm të portalit për korrigjimin e përmbajtjes. Mos e përdorni këtë fushë për të transferuar një fushatë nga një klient te një tjetër dhe mos supozoni se API do të konfigurojë shërbimin e operatorit për një rishitës tjetër. |
Skema e përditësimit nuk ofron brandId, usecase, subscriberOptin, subscriberOptout ose subscriberHelp si fusha të ndryshueshme. Mos kopjoni në një përditësim të gjithë trupin e të dhënave për krijimin e fushatës. Konsultoni kualifikimin aktual kur shqyrtoni kërkesat për mesazhet.
Dërgoni një korrigjim të përqendruar
Ky shembull përshkruan, për ilustrim, një shërbim kujtese për takimet. Përshtateni me shërbimin real të fushatës dhe rrjedhën e saj të marrjes së pëlqimit përpara se ta përdorni.
{
"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"Për të njëjtin dërgim të synuar, ruani të njëjtin çelës, të njëjtën metodë dhe rrugë, si dhe saktësisht të njëjtët bajte të parametrave të kërkimit dhe të trupit të kërkesës. Përmbajtja e ndryshuar kërkon një kërkesë të shqyrtuar veçmas; mos i ndërroni çelësat verbërisht pas skadimit të kohës së pritjes. Një kërkesë e përfunduar mund të kthejë sërish një gabim të ruajtur në memorien e përkohshme, ndërsa një dublikatë në përpunim mund të kthejë 409 me Retry-After.
Lexojeni sërish fushatën
HTTP 200 kthen drejtpërdrejt një objekt JSON të fushatës. Verifikoni campaignId, më pas merrni të njëjtën fushatë me GET dhe krahasoni fushat e synuara. Një ruajtje e suksesshme nuk kërkon vetvetiu një rishqyrtim tjetër nga operatori, nuk ndryshon caktimet e numrave, nuk aktivizon dërgimin dhe nuk dërgon mesazh.
Portali kontrollon versionin e formularit përpara ruajtjes dhe e lexon sërish fushatën më pas. Pika fundore publike PUT nuk e zbaton atë kontroll të versionit të portalit: bashkërendoni redaktimet e njëkohshme. Një çelës idempotence nuk e zbulon përditësimin e bërë nga një redaktues tjetër.
Nëse portali shfaq një refuzim nga shqyrtimi që ende nuk është zgjidhur, korrigjoni fillimisht përmbajtjen dhe më pas përdorni veprimin e veçantë për të kërkuar rishqyrtim, kur është i disponueshëm. Ky veprim kontrollon fushatën aktuale në prodhim dhe gjendjen e ndarjes së saj me palët e tjera. Vetëm ruajtja e përmbajtjes nuk e aktivizon këtë veprim dhe ekzistenca e një identifikuesi të fushatës nuk dëshmon miratim.
Përditësimet e zakonshme të fushatës me PUT nuk shkaktojnë një debitim të veçantë për regjistrimin e fushatës në shërbimin aktual. Tarifat mujore ekzistuese, angazhimet minimale, qiraja e numrave dhe tarifimi i përdorimit të mesazheve vazhdojnë të zbatohen. Për tarifat e fushatës të konfiguruara aktualisht, shihni tarifat e fushatës.
Trajtoni kufizimet dhe rezultatet e pasigurta
Për HTTP 400, lexoni gabimin për fushën përkatëse dhe kontrolloni gjatësitë, tekstin e pëlqimit dhe gjendjen e fushatës. Për 401, 403 ose 404, kontrolloni kredencialet e API, adresën IP burimore të lejuar dhe pronësinë. Për 429, respektoni Retry-After. Në rast përgjigjeje 500, 502 ose ndërprerjeje të kërkesës, ruani identifikuesin e fushatës dhe çdo requestId, pastaj verifikoni e rakordoni të dhënat e regjistrimit ekzistues përpara një dërgimi tjetër.
Kopja lokale e gjendjes varet nga trupi i përgjigjes së kthyer. Një përgjigje e pjesshme jo e zbrazët mund të mos përfshijë fusha të mëparshme, përfshirë metadatat e rinovimit; një përgjigje e zbrazët mund të mbajë vlera të vjetruara. Verifikoni rezultatin e plotë të GET në vend që ta trajtoni vetëm suksesin si provë se çdo fushë është ruajtur. Raportoni dallimet e pazgjidhura përmes shërbimit të mbështetjes. Kjo rrugë nuk i përditëson caktimet te operatorët në mënyrë atomike dhe nuk ofron një veprim të përgjithshëm për rikuperimin e aktivizimit te operatori.