Numbri määramine sõnumikampaaniale

Saatmisnumbri määramine kampaaniale

Kasutage seda toimingut pärast seda, kui teie sõnumibränd ja tootmiskampaania on registreeritud ning kampaania on aktiivne. See seob ühe teie konto SMS-toega numbri kampaaniaga. See ei loo brändi, ei loo ega kinnita kampaaniat, ei osta numbrit ega saada sõnumit.

Praegune portaal kasutab seda marsruuti kampaania määramisel numbrile. Avalik API võtab vastu kampaania identifikaatori; brändi tuletab see kontole kuuluvast kampaaniast, mitte ei võta vastu eraldi brändi identifikaatorit.

Päring

Saatke vormikodeeringus POST päring üle HTTPS-i, kasutades oma lubatud API kontot ja selle lubatud lähte-IP-aadressi. Kasutage oma konto tegelikku numbrit ja kampaania identifikaatoreid. Selles näites olev number on väljamõeldud.

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'

Kampaania määramise parameetrid
Parameeter	Kohustuslik	Tähendus
action	Jah	Kasutage väärtust add määramiseks või delete numbri praeguse kampaaniaseose eemaldamiseks. Tähesuurus ja ümbritsevad tühikud normaliseeritakse.
campaign	Toimingu add korral	campaignId ehk autenditud kontole kuuluva kampaania identifikaator, mille olek on ACTIVE. Ka selle bränd peab kuuluma kontole. Selgesõnaliselt liivakastiks märgitud kampaaniat ei saa määrata reaalsetele saatmisnumbritele. Jätke see parameeter toimingu delete korral ära; eemaldamisel kasutatakse numbri olemasolevat seost.
number	Jah	Teile kuuluv, aktiivne, tühistamata ja SMS-toega saatmisnumber. Põhja-Ameerika numbri puhul kasutage riigikoodi 1, millele järgneb numbri kümme numbrimärki, ilma plussmärgita. Töötleja eemaldab mittenumbrilised märgid ning otsib ka plussiga algavaid ja kümnekohalisi vasteid. See normaliseerimine ei ole üldine telefoninumbri kehtivuse kontroll.

Toiming muudab ühte numbrit. Sellel ei ole lehekülgedeks jaotamist, hulgiparameetrit ega proovikäivituse valikut. Ärge kasutage kampaania loomise lõpp-punkti ainult selleks, et siduda number olemasoleva kampaaniaga.

Praeguse seose eemaldamine

Kasutage action=delete koos teile kuuluva numbriga. See eemaldab numbri saatmiskampaania seose ja tühjendab selle numbri salvestatud brändi/kampaania väljad. See ei kustuta kampaaniat ega brändi, ei vabasta telefoninumbrit, ei tühista numbri teenust ega peata kampaania korduvat arveldamist.

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

Vastus ja kontrollimine

See väljamõeldud näide illustreerib tavalist API vastuse ümbrist ja valitud tulemuse välju. Tagastatud number säilitab teie kontol salvestatud vormingu. brandId ja campaignId on pärast edukat eemaldamist tühjad stringid.

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

providerStatus on sõnumipartneri HTTP olek. Töötleja aktsepteerib 2xx transpordivastuse ja uuendab seejärel kohalikku numbrikirjet; see ei tõlgenda partneri vastuse sisu eraldi äritasandi vastuvõtutulemuse saamiseks. Edukas vastus ei ole seetõttu tõend, et sõnumside registreerimine on lõpule viidud või et kohaletoimetamine õnnestub. Vaadake enne tootmisliikluse saatmist portaalis üle numbri kampaania olek.

Ärge käsitlege ainuüksi kohalikku seost kohaletoimetamise heakskiiduna. Kampaania ja brändi heakskiit, numbri ettevalmistamine, konto õigused, sisureeglid ja tavalised sõnumsidepiirangud kehtivad endiselt.

Vead ja osalised tulemused

401: töötlejal ei ole saadaval autenditud kontot.
400: action või number puudub või on kehtetu või add päringus puudub kampaania identifikaator.
404: number ei ole teile kuuluv, aktiivne ja tühistamata SMS-number.
409: kampaania ei ole kontole saadaval, selle olek ei ole ACTIVE, see on selgesõnaliselt liivakast või selle bränd ei ole kontole saadaval.
503: sõnumsideintegratsioon ei ole saadaval. Võtke ühendust toega, selle asemel et muuta konto mandaate või välja mõelda konfiguratsiooniväärtusi.
502: sõnumsidepäring ebaõnnestus, aegus või tagastas HTTP oleku, mis ei ole 2xx. providerStatus võidakse tagastada. Aegumine ei tõenda, et partner ei teinud mingit muudatust.
500 koos partial=true: sõnumipartner tagastas eduka HTTP oleku, kuid kohalikku seost ei õnnestunud kinnitada. Enne uuesti proovimist kontrollige portaalis numbri olekut ja lahendage võimalikud lahknevused või võtke ühendust toega.

Kontrollige lisaks HTTP tulemusele ka API olekukoodi ja vastuse sisu. Ärge proovige aegumist või osalist tulemust pimesi uuesti. Sellel töötlejal ei ole päringutasandi idempotentsusvõtit, tehingulist tagasipööramist ega kampaania registreerimise lõpuleviimise kontrolli. Korduv ühtiv kohalik määramine võib tagastada edu isegi siis, kui andmebaas teatab, et ühtegi rida ei muudetud.

Ulatus ja mõjud

See toiming muudab saatmisnumbri marsruutimist ja selle salvestatud kampaania/brändi seost. Ülevaadatud töötlejas ei sisalda see otsest konto debiteerimist, kampaania loomist, ostu ega sõnumi saatmist. See ei ole hinnapakkumine ega tasuta teenuse lubadus: olemasolevad numbri, kampaania ja sõnumside tasud jätkuvad vastavalt teie konto tingimustele.

Portaalis eemaldab teisele kampaaniale üleminek kõigepealt eelmise seose ja lisab seejärel uue. Need on eraldi päringud. Kui teine päring ebaõnnestub, võib varasem seos olla juba eemaldatud. Ärge eeldage, et need kaks päringut pööratakse koos tagasi.