Numerio priskyrimas žinučių kampanijai

Siuntimo numerio priskyrimas kampanijai

Naudokite šią operaciją po to, kai jūsų žinučių prekės ženklas ir gamybinė kampanija yra užregistruoti, o kampanija yra aktyvi. Ji susieja vieną jūsų paskyros numerį, kuriame įjungtos SMS, su kampanija. Ji nesukuria prekės ženklo, nesukuria ir nepatvirtina kampanijos, neperka numerio ir nesiunčia žinutės.

Dabartinis portalas naudoja šį maršrutą priskirdamas kampaniją numeriui. Viešoji API priima kampanijos identifikatorių; prekės ženklą ji išveda iš paskyrai priklausančios kampanijos, o ne priima atskirą prekės ženklo identifikatorių.

Užklausa

Siųskite formos koduotės POST užklausą HTTPS protokolu, naudodami savo įjungtą API paskyrą ir jai leidžiamą šaltinio IP adresą. Naudokite tikrąjį numerį ir kampanijos identifikatorius iš savo paskyros. Šiame pavyzdyje pateiktas numeris yra išgalvotas.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --data-urlencode 'action=add' \
  --data-urlencode "campaign=$CAMPAIGN_ID" \
  --data-urlencode 'number=12025550123' \
  'https://api.multitel.net/v3/campaign'

Kampanijos priskyrimo parametrai
Parametras	Privalomas	Reikšmė
action	Taip	Naudokite add, kad priskirtumėte, arba delete, kad pašalintumėte dabartinį numerio susiejimą su kampanija. Raidžių registras ir aplinkiniai tarpai normalizuojami.
campaign	Kai add	campaignId, t. y. autentifikuotai paskyrai priklausančios kampanijos, kurios būsena yra ACTIVE, identifikatorius. Jos prekės ženklas taip pat turi priklausyti paskyrai. Kampanijos, aiškiai pažymėtos kaip smėliadėžės, negalima priskirti realiems siuntimo numeriams. Praleiskite šį parametrą, kai naudojate delete; šalinant naudojamas esamas numerio susiejimas.
number	Taip	Jums priklausantis, aktyvus, neanuliuotas siuntimo numeris su įjungtomis SMS. Šiaurės Amerikos numeriui naudokite šalies kodą 1 ir po jo dešimt numerio skaitmenų, be pliuso ženklo. Apdorojimo modulis pašalina neskaitmeninius simbolius ir taip pat ieško atitikmenų su pliuso priešdėliu bei dešimties skaitmenų atitikmenų. Šis normalizavimas nėra bendra telefono numerio galiojimo patikra.

Operacija pakeičia vieną numerį. Ji neturi puslapiavimo, paketinio parametro ar bandomojo vykdymo parinkties. Nenaudokite kampanijos kūrimo galinio taško vien tam, kad susietumėte numerį su esama kampanija.

Dabartinio susiejimo pašalinimas

Naudokite action=delete su jums priklausančiu numeriu. Tai pašalina jo susiejimą su siuntimo kampanija ir išvalo to numerio išsaugotus prekės ženklo / kampanijos laukus. Tai neištrina kampanijos ar prekės ženklo, neatlaisvina telefono numerio, neatšaukia numerio paslaugos ir nesustabdo periodinio kampanijos apmokestinimo.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --data-urlencode 'action=delete' \
  --data-urlencode 'number=12025550123' \
  'https://api.multitel.net/v3/campaign'

Atsakymas ir patikrinimas

Šis išgalvotas pavyzdys iliustruoja įprastą API atsakymo apvalkalą ir pasirinktus rezultato laukus. Grąžintas numeris išlaiko jūsų paskyroje išsaugotą formatą. Po sėkmingo pašalinimo brandId ir campaignId yra tuščios eilutės.

{
  "status": {"code": 200, "msg": "Campaign assignment updated."},
  "response": {
    "number": "+12025550123",
    "brandId": "BRAND_FROM_ACCOUNT",
    "campaignId": "CAMPAIGN_FROM_ACCOUNT",
    "providerStatus": 200
  }
}

providerStatus yra žinučių partnerio HTTP būsena. Apdorojimo modulis priima 2xx transporto atsakymą ir tada atnaujina vietinį numerio įrašą; jis neinterpretuoja partnerio atsakymo turinio, kad gautų atskirą verslo lygmens priėmimo rezultatą. Todėl sėkmingas atsakymas nėra įrodymas, kad žinučių registracija užbaigta arba kad pristatymas pavyks. Prieš siųsdami gamybinį srautą, portale peržiūrėkite numerio kampanijos būseną.

Nelaikykite vien vietinio susiejimo pristatymo patvirtinimu. Kampanijos ir prekės ženklo patvirtinimas, numerio parengimas, paskyros leidimai, turinio taisyklės ir įprasti žinučių siuntimo apribojimai tebegalioja.

Klaidos ir daliniai rezultatai

401: apdorojimo moduliui nepasiekiama jokia autentifikuota paskyra.
400: trūksta action arba number arba jie netinkami, arba add užklausoje nėra kampanijos identifikatoriaus.
404: numeris nėra jums priklausantis, aktyvus, neanuliuotas SMS numeris.
409: kampanija nepasiekiama paskyrai, jos būsena nėra ACTIVE, ji aiškiai pažymėta kaip smėliadėžė arba jos prekės ženklas nepasiekiamas paskyrai.
503: žinučių integracija nepasiekiama. Kreipkitės į palaikymo tarnybą, užuot keitę paskyros prisijungimo duomenis ar kūrę konfigūracijos reikšmes.
502: žinučių užklausa nepavyko, baigėsi jos laikas arba ji grąžino HTTP būseną, kuri nėra 2xx. Gali būti grąžinta providerStatus. Laiko pabaiga neįrodo, kad partneris nepadarė jokio pakeitimo.
500 su partial=true: žinučių partneris grąžino sėkmingą HTTP būseną, tačiau vietinio susiejimo nepavyko patvirtinti. Prieš bandydami dar kartą, suderinkite numerį portale arba kreipkitės į palaikymo tarnybą.

Be HTTP rezultato, patikrinkite ir API būsenos kodą bei atsakymo turinį. Nekartokite laiko pabaigos ar dalinio rezultato aklai. Šis apdorojimo modulis neturi užklausos lygmens idempotentiškumo rakto, transakcinio atšaukimo ar kampanijos registracijos užbaigimo patikros. Pakartotas sutampantis vietinis priskyrimas gali grąžinti sėkmę net tada, kai duomenų bazė praneša, kad nė viena eilutė nepakeista.

Apimtis ir poveikis

Ši operacija keičia siuntimo numerio maršrutizavimą ir jo išsaugotą susiejimą su kampanija / prekės ženklu. Peržiūrėtame apdorojimo modulyje ji neapima tiesioginio paskyros nurašymo, kampanijos kūrimo, pirkimo ar žinutės siuntimo. Tai nėra kainos pasiūlymas ar nemokamos paslaugos pažadas: esami numerio, kampanijos ir žinučių siuntimo mokesčiai toliau taikomi pagal jūsų paskyros sąlygas.

Portale pereinant prie kitos kampanijos pirmiausia pašalinamas ankstesnis susiejimas, o tada pridedamas naujas. Tai yra atskiros užklausos. Jei antroji užklausa nepavyksta, ankstesnis susiejimas gali būti jau pašalintas. Nemanykite, kad abi užklausos atšaukiamos kartu.