Szám hozzárendelése üzenetküldési kampányhoz

Küldőszám hozzárendelése kampányhoz

Ezt a műveletet azután használja, hogy az üzenetküldési márkája és az éles kampánya regisztrálva van, és a kampány aktív. A művelet a fiókjában lévő egyik SMS-képes számot társítja a kampányhoz. Nem hoz létre márkát, nem hoz létre és nem hagy jóvá kampányt, nem vásárol számot, és nem küld üzenetet.

A jelenlegi portál ezt az útvonalat használja, amikor kampányt rendel egy számhoz. A nyilvános API kampányazonosítót fogad el; a márkát a fiók tulajdonában lévő kampányból származtatja, ahelyett hogy külön márkaazonosítót fogadna el.

Kérés

Küldjön form-encoded POST kérést HTTPS-en keresztül az engedélyezett API-fiókjával és annak engedélyezett forrás-IP-címéről. A fiókjából származó tényleges szám- és kampányazonosítókat használja. A példában szereplő szám kitalált.

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'

Kampány-hozzárendelési paraméterek
Paraméter	Kötelező	Jelentés
action	Igen	A hozzárendeléshez az add, a szám jelenlegi kampány-hozzárendelésének eltávolításához a delete értéket használja. A kis- és nagybetűk, valamint a körülötte lévő szóközök normalizálva vannak.
campaign	add esetén	A campaignId értéke egy olyan ACTIVE állapotú kampánynak, amely a hitelesített fiók tulajdonában van. A márkájának is a fiókhoz kell tartoznia. A kifejezetten sandboxként megjelölt kampány nem rendelhető éles küldőszámokhoz. delete esetén hagyja el ezt a paramétert; az eltávolítás a szám meglévő hozzárendelését használja.
number	Igen	A saját tulajdonú, aktív, nem érvénytelenített, SMS-képes küldőszám. Észak-amerikai szám esetén az 1 országkódot, majd a szám tíz számjegyét adja meg, pluszjel nélkül. A kezelő eltávolítja a nem számjegy karaktereket, és a pluszjellel kezdődő, valamint a tízjegyű megfelelőket is megkeresi. Ez a normalizálás nem általános telefonszám-érvényességi ellenőrzés.

A művelet egyetlen számot módosít. Nincs lapozása, kötegelt paramétere vagy próbafuttatási lehetősége. Ne használjon kampánylétrehozó végpontot pusztán azért, hogy egy számot egy meglévő kampányhoz csatoljon.

A jelenlegi hozzárendelés eltávolítása

Használja az action=delete értéket a saját tulajdonú számmal. Ez eltávolítja a szám küldőkampány-hozzárendelését, és törli a számhoz mentett márka/kampány mezőket. Nem törli a kampányt vagy a márkát, nem adja vissza a telefonszámot, nem mondja le a szám szolgáltatását, és nem állítja le a kampány ismétlődő számlázását.

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

Válasz és ellenőrzés

Ez a kitalált példa a szokásos API-válaszborítékot és néhány kiválasztott eredménymezőt szemlélteti. A visszaadott szám megőrzi a fiókjában tárolt formátumot. A brandId és a campaignId sikeres eltávolítás után üres karakterlánc.

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

A providerStatus az üzenetküldési partner HTTP-állapota. A kezelő elfogadja a 2xx átviteli választ, majd frissíti a helyi számrekordot; nem értelmezi a partner válaszának törzsét külön üzleti szintű elfogadási eredmény céljából. A sikeres válasz ezért nem bizonyítja, hogy az üzenetküldési regisztráció befejeződött, vagy hogy a kézbesítés sikeres lesz. Éles forgalom küldése előtt ellenőrizze a szám kampányállapotát a portálon.

A helyi hozzárendelést önmagában ne tekintse kézbesítési jóváhagyásnak. A kampány és a márka jóváhagyása, a szám kiosztása, a fiók jogosultságai, a tartalmi szabályok és a szokásos üzenetküldési korlátok továbbra is érvényesek.

Hibák és részleges eredmények

401: a kezelő számára nem áll rendelkezésre hitelesített fiók.
400: az action vagy a number hiányzik/érvénytelen, vagy egy add kérés nem tartalmaz kampányazonosítót.
404: a szám nem saját tulajdonú, aktív, nem érvénytelenített SMS-szám.
409: a kampány nem érhető el a fiók számára, nem ACTIVE állapotú, kifejezetten sandbox, vagy a márkája nem érhető el a fiók számára.
503: az üzenetküldési integráció nem érhető el. Forduljon az ügyfélszolgálathoz ahelyett, hogy módosítaná a fiók hitelesítő adatait vagy konfigurációs értékeket találna ki.
502: az üzenetküldési kérés sikertelen volt, időtúllépés történt, vagy nem 2xx HTTP-állapot érkezett vissza. A providerStatus visszaadható. Az időtúllépés nem bizonyítja, hogy a partner nem hajtott végre módosítást.
500 a partial=true értékkel: az üzenetküldési partner sikeres HTTP-állapotot adott vissza, de a helyi hozzárendelést nem sikerült megerősíteni. Újrapróbálkozás előtt egyeztesse a számot a portálon, vagy forduljon az ügyfélszolgálathoz.

Ellenőrizze az API-állapotkódot és a válasz törzsét, valamint a HTTP-eredményt is. Ne próbálja meg vakon újra az időtúllépést vagy a részleges eredményt. Ez a kezelő nem rendelkezik kérésszintű idempotenciakulccsal, tranzakciós visszagörgetéssel vagy a kampányregisztráció befejezésének ellenőrzésével. Egy megismételt, egyező helyi hozzárendelés akkor is sikert adhat vissza, ha az adatbázis nem jelez módosított sorokat.

Hatókör és hatások

Ez a művelet a küldőszám útválasztását és a mentett kampány/márka hozzárendelését módosítja. Az átnézett kezelőben nem tartalmaz közvetlen fiókterhelést, kampánylétrehozást, vásárlást vagy üzenetküldést. Ez nem árajánlat és nem ingyenes szolgáltatás ígérete: a meglévő szám-, kampány- és üzenetküldési díjak a fiókja feltételei szerint továbbra is érvényesek.

A portálon egy másik kampányra váltás először eltávolítja a korábbi hozzárendelést, majd hozzáadja az újat. Ezek külön kérések. Ha a második kérés sikertelen, a korábbi hozzárendelés már eltávolítva lehet. Ne feltételezze, hogy a két kérés együtt kerül visszagörgetésre.