Dodjela broja kampanji za slanje poruka

Dodjela broja za slanje kampanji

Ovu operaciju koristite nakon što su vaš brend za slanje poruka i produkcijska kampanja registrirani i kampanja je aktivna. Ona povezuje jedan broj s omogućenim SMS-om na vašem računu s kampanjom. Ne stvara brend, ne stvara niti odobrava kampanju, ne kupuje broj i ne šalje poruku.

Trenutni portal koristi ovu rutu pri dodjeli kampanje broju. Javni API prihvaća identifikator kampanje; brend izvodi iz kampanje u vlasništvu računa umjesto da prihvaća zaseban identifikator brenda.

Zahtjev

Pošaljite POST kodiran kao obrazac putem HTTPS-a koristeći svoj omogućeni API račun i njegovu dopuštenu izvornu IP adresu. Upotrijebite stvarne identifikatore broja i kampanje sa svojeg računa. Broj u ovom primjeru je izmišljen.

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'

Parametri dodjele kampanje
Parametar	Obavezno	Značenje
action	Da	Upotrijebite add za dodjelu ili delete za uklanjanje trenutne povezanosti broja s kampanjom. Velika i mala slova te okolni razmaci se normaliziraju.
campaign	Za add	campaignId kampanje u statusu ACTIVE koja je u vlasništvu autentificiranog računa. Njezin brend također mora pripadati računu. Kampanja izričito označena kao sandbox ne može se dodijeliti aktivnim brojevima za slanje. Izostavite ovaj parametar za delete; uklanjanje koristi postojeću povezanost broja.
number	Da	Broj za slanje koji je u vašem vlasništvu, aktivan, nije poništen i ima omogućen SMS. Za sjevernoamerički broj upotrijebite pozivni broj države 1 iza kojeg slijedi njegovih deset znamenki, bez znaka plus. Rukovatelj uklanja znakove koji nisu znamenke i također traži ekvivalente s prefiksom plus i s deset znamenki. Ova normalizacija nije opća provjera valjanosti telefonskog broja.

Operacija mijenja jedan broj. Nema straničenja, parametra za skupnu obradu ni opcije probnog izvođenja. Ne koristite krajnju točku za stvaranje kampanje samo da biste broj priključili postojećoj kampanji.

Uklanjanje trenutne povezanosti

Upotrijebite action=delete s brojem u vašem vlasništvu. Time se uklanja njegova povezanost s kampanjom za slanje i brišu se spremljena polja brenda/kampanje za taj broj. Ne briše kampanju ni brend, ne oslobađa telefonski broj, ne otkazuje uslugu broja i ne zaustavlja ponavljajuću naplatu kampanje.

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

Odgovor i provjera

Ovaj izmišljeni primjer prikazuje uobičajenu ovojnicu API odgovora i odabrana polja rezultata. Vraćeni broj zadržava format pohranjen na vašem računu. brandId i campaignId prazni su nizovi nakon uspješnog uklanjanja.

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

providerStatus je HTTP status partnera za slanje poruka. Rukovatelj prihvaća transportni odgovor 2xx i zatim ažurira lokalni zapis broja; ne tumači tijelo partnerova odgovora radi zasebnog rezultata prihvaćanja na poslovnoj razini. Uspješan odgovor stoga nije dokaz da je registracija za slanje poruka dovršena ni da će isporuka uspjeti. Prije slanja produkcijskog prometa pregledajte status kampanje broja u portalu.

Ne smatrajte samu lokalnu povezanost odobrenjem za isporuku. I dalje vrijede odobrenje kampanje i brenda, dodjela brojeva, dopuštenja računa, pravila o sadržaju i uobičajena ograničenja slanja poruka.

Pogreške i djelomični rezultati

401: rukovatelju nije dostupan nijedan autentificirani račun.
400: action ili number nedostaje ili je nevaljan, ili zahtjev add nema identifikator kampanje.
404: broj nije SMS broj u vašem vlasništvu koji je aktivan i nije poništen.
409: kampanja nije dostupna računu, nije u statusu ACTIVE, izričito je sandbox ili njezin brend nije dostupan računu.
503: integracija za slanje poruka nije dostupna. Obratite se podršci umjesto da mijenjate vjerodajnice računa ili izmišljate konfiguracijske vrijednosti.
502: zahtjev za slanje poruka nije uspio, istekao je ili je vratio HTTP status koji nije 2xx. providerStatus može biti vraćen. Istek vremena ne dokazuje da partner nije napravio nikakvu promjenu.
500 uz partial=true: partner za slanje poruka vratio je uspješan HTTP status, ali lokalna povezanost nije se mogla potvrditi. Prije ponovnog pokušaja uskladite broj u portalu ili se obratite podršci.

Provjerite API statusni kod i tijelo odgovora, kao i HTTP rezultat. Ne ponavljajte naslijepo zahtjev nakon isteka vremena ili djelomičnog rezultata. Ovaj rukovatelj nema ključ idempotentnosti na razini zahtjeva, transakcijsko vraćanje ni provjeru dovršetka registracije kampanje. Ponovljena podudarna lokalna dodjela može vratiti uspjeh čak i kada baza podataka ne prijavi promijenjene retke.

Opseg i učinci

Ova operacija mijenja usmjeravanje broja za slanje i njegovu spremljenu povezanost s kampanjom/brendom. U pregledanom rukovatelju ne sadrži izravno terećenje računa, stvaranje kampanje, kupnju ni slanje poruke. Ovo nije ponuda cijene ni obećanje besplatne usluge: postojeće naknade za broj, kampanju i slanje poruka i dalje vrijede prema uvjetima vašeg računa.

U portalu se pri promjeni na drugu kampanju najprije uklanja prethodna povezanost, a zatim dodaje nova. To su zasebni zahtjevi. Ako drugi zahtjev ne uspije, ranija povezanost možda je već uklonjena. Nemojte pretpostavljati da se ta dva zahtjeva zajedno vraćaju na prethodno stanje.