Numura piešķiršana ziņojumapmaiņas kampaņai

Sūtīšanas numura piešķiršana kampaņai

Izmantojiet šo darbību pēc tam, kad jūsu ziņojumapmaiņas zīmols un produkcijas kampaņa ir reģistrēti un kampaņa ir aktīva. Tā saista vienu jūsu konta numuru ar SMS atbalstu ar kampaņu. Tā neizveido zīmolu, neizveido un neapstiprina kampaņu, nepērk numuru un nesūta ziņojumu.

Pašreizējais portāls izmanto šo maršrutu, piešķirot kampaņu numuram. Publiskā API pieņem kampaņas identifikatoru; zīmolu tā atvasina no konta īpašumā esošās kampaņas, nevis pieņem atsevišķu zīmola identifikatoru.

Pieprasījums

Nosūtiet formas kodējuma POST pieprasījumu, izmantojot HTTPS, savu iespējoto API kontu un tā atļauto avota IP adresi. Izmantojiet sava konta faktiskos numura un kampaņas identifikatorus. Numurs šajā piemērā ir izdomāts.

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'

Kampaņas piešķiršanas parametri
Parametrs	Obligāts	Nozīme
action	Jā	Izmantojiet add, lai piešķirtu, vai delete, lai noņemtu numura pašreizējo kampaņas saistību. Burtu reģistrs un apkārtējās atstarpes tiek normalizētas.
campaign	Vērtībai add	Autentificētā konta īpašumā esošas kampaņas campaignId, kuras statuss ir ACTIVE. Arī tās zīmolam jāpieder kontam. Kampaņu, kas skaidri atzīmēta kā smilškaste, nevar piešķirt reāliem sūtīšanas numuriem. Izlaidiet šo parametru vērtībai delete; noņemšana izmanto numura esošo saistību.
number	Jā	Jūsu īpašumā esošs, aktīvs, neanulēts sūtīšanas numurs ar SMS atbalstu. Ziemeļamerikas numuram izmantojiet valsts kodu 1, kam seko tā desmit cipari, bez plusa zīmes. Apstrādātājs noņem rakstzīmes, kas nav cipari, un meklē arī ekvivalentus ar plusa prefiksu un desmit ciparu ekvivalentus. Šī normalizācija nav vispārīga tālruņa numura derīguma pārbaude.

Darbība maina vienu numuru. Tai nav lapošanas, pakešu parametra vai izmēģinājuma režīma opcijas. Neizmantojiet kampaņas izveides galapunktu tikai tāpēc, lai piesaistītu numuru esošai kampaņai.

Pašreizējās saistības noņemšana

Izmantojiet action=delete ar jūsu īpašumā esošo numuru. Tas noņem numura sūtīšanas kampaņas saistību un notīra šim numuram saglabātos zīmola/kampaņas laukus. Tas nedzēš kampaņu vai zīmolu, neatbrīvo tālruņa numuru, neatceļ numura pakalpojumu un neaptur kampaņas periodisko rēķinu izrakstīšanu.

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

Atbilde un pārbaude

Šis izdomātais piemērs ilustrē parasto API atbildes aploksni un izvēlētos rezultāta laukus. Atgrieztais numurs saglabā jūsu kontā saglabāto formātu. Pēc veiksmīgas noņemšanas brandId un campaignId ir tukšas virknes.

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

providerStatus ir ziņojumapmaiņas partnera HTTP statuss. Apstrādātājs pieņem 2xx transporta atbildi un pēc tam atjaunina vietējo numura ierakstu; tas neinterpretē partnera atbildes saturu, lai iegūtu atsevišķu biznesa līmeņa pieņemšanas rezultātu. Tāpēc veiksmīga atbilde nav pierādījums, ka ziņojumapmaiņas reģistrācija ir pabeigta vai ka piegāde izdosies. Pirms produkcijas datplūsmas sūtīšanas pārskatiet numura kampaņas statusu portālā.

Neuzskatiet vietējo saistību vien par piegādes apstiprinājumu. Joprojām ir spēkā kampaņas un zīmola apstiprināšana, numura nodrošināšana, konta atļaujas, satura noteikumi un parastie ziņojumapmaiņas ierobežojumi.

Kļūdas un daļēji rezultāti

401: apstrādātājam nav pieejams autentificēts konts.
400: action vai number trūkst vai ir nederīgs, vai add pieprasījumam nav kampaņas identifikatora.
404: numurs nav jūsu īpašumā esošs, aktīvs, neanulēts SMS numurs.
409: kampaņa nav pieejama kontam, tās statuss nav ACTIVE, tā ir skaidri atzīmēta kā smilškaste, vai tās zīmols nav pieejams kontam.
503: ziņojumapmaiņas integrācija nav pieejama. Sazinieties ar atbalsta dienestu, nevis mainiet konta akreditācijas datus vai izdomājiet konfigurācijas vērtības.
502: ziņojumapmaiņas pieprasījums neizdevās, iestājās noildze vai tika atgriezts HTTP statuss, kas nav 2xx. Var tikt atgriezts providerStatus. Noildze nepierāda, ka partneris neveica nekādas izmaiņas.
500 ar partial=true: ziņojumapmaiņas partneris atgrieza veiksmīgu HTTP statusu, bet vietējo saistību nevarēja apstiprināt. Pirms atkārtota mēģinājuma saskaņojiet numuru portālā vai sazinieties ar atbalsta dienestu.

Pārbaudiet API statusa kodu un atbildes saturu, ne tikai HTTP rezultātu. Neatkārtojiet noildzi vai daļēju rezultātu akli. Šim apstrādātājam nav pieprasījuma līmeņa idempotences atslēgas, transakciju atcelšanas vai kampaņas reģistrācijas pabeigšanas pārbaudes. Atkārtota, sakrītoša vietējā piešķiršana var atgriezt veiksmīgu rezultātu pat tad, ja datubāze ziņo, ka neviena rinda nav mainīta.

Tvērums un ietekme

Šī darbība maina sūtīšanas numura maršrutēšanu un tā saglabāto kampaņas/zīmola saistību. Pārskatītajā apstrādātājā tā neietver tiešu konta debetu, kampaņas izveidi, pirkumu vai ziņojuma sūtīšanu. Tas nav cenas piedāvājums vai bezmaksas pakalpojuma solījums: esošās numura, kampaņas un ziņojumapmaiņas maksas turpina darboties saskaņā ar jūsu konta noteikumiem.

Portālā, mainot uz citu kampaņu, vispirms tiek noņemta iepriekšējā saistība un pēc tam pievienota jaunā. Tie ir atsevišķi pieprasījumi. Ja otrais pieprasījums neizdodas, iepriekšējā saistība var jau būt noņemta. Nepieņemiet, ka abi pieprasījumi tiek atcelti kopā.