Minősítsen egy márkát a kampányának regisztrálása előtt
A 10DLC kampány leírja a regisztrált vállalkozás által küldeni szándékozott üzeneteket, a címzettek hozzájárulásának módját, valamint azt, hogyan kaphatnak segítséget vagy hogyan állíthatják le az üzeneteket. Ez az API hozza létre a nyilvántartási rekordot; az éles szolgáltatói aktiválás elvégzése külön fiókbeállítási lépés. Használjon egy saját tulajdonú márkát a márkaregisztrációból, majd töltse be annak elérhető használati eseteit és a kiválasztott használati eset aktuális követelményeit.
Használja az aktuális minősítési eredményt az al-használati esetek, a jogosult hálózatazonosítók, az üzenetminták és a feliratkozási/leiratkozási/súgónyilatkozatok kiválasztásához. A követelmények márkánként és hálózatonként eltérhetnek. Ne nyújtsa be a példa azonosítóit, és ne másolja a hozzájárulási leírását eltérő folyamatot alkalmazó vállalkozás számára.
Tartsa külön a sandbox- és az éles környezetet
Sandbox-gyakorlathoz használjon saját tesztmárkát és egy aktuális használati esetet, amelyre az jogosult. A TRIAL értéket csak akkor használja, ha azt az adott minősítés kínálja. A portál ellenőrzi, hogy a kiválasztott márka és a kampány környezete megegyezik-e. A közvetlen API-kérés nem futtatja le Ön helyett a portál teljes varázsló-érvényesítését, ezért őrizze meg ezt az elkülönítést az integrációjában.
Az éles kampány létrehozása díjköteles, és nem teszi automatikusan küldésre készé a számot. Tartsa a kampány környezetét összhangban a márkájával, és élő kampány létrehozása előtt tekintse át a díjat és az alkalmazandó feltételeket.
Nyújtsa be a kampány JSON-ját
Készítse el a campaign.json fájlt a minősített értékeivel. Az R000000 azt jelenti, hogy nincs viszonteladó; csak akkor használja, ha ez a szándékolt konfiguráció. A szokásos MultiTEL viszonteladói konfigurációhoz az engedélyezett MultiTEL LLC viszonteladó-azonosítót a fiókja viszonteladó-gyűjteményéből vagy a portál előkészítő folyamatából szerezze be, ne pedig más azonosítójának beégetésével.
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
'https://api.multitel.net/tcr/v2/reseller?companyName=MultiTEL%20LLC&recordsPerPage=500'A következő JSON egy saját tulajdonú tesztmárkához tartozó próbakampányt szemléltet. Cserélje le a márkát, a használati esetet, a viszonteladót és a hozzájárulási szöveget azokra az értékekre, amelyek ténylegesen jogosultak az Ön tesztjére.
{
"brandId": "B123ABC",
"channelId": "10DLC",
"usecase": "TRIAL",
"subUsecases": [],
"resellerId": "R000000",
"description": "Trial account notices requested by users of the example application.",
"messageFlow": "Test users explicitly select an unchecked consent box before requesting these trial notices.",
"sample1": "Example application: your requested account notice is available. Reply STOP to stop notices.",
"subscriberOptin": true,
"optinKeywords": "START",
"optinMessage": "You are subscribed to the example application's requested account notices.",
"subscriberOptout": true,
"optoutKeywords": "STOP",
"optoutMessage": "You will no longer receive the example application's account notices.",
"subscriberHelp": true,
"helpKeywords": "HELP",
"helpMessage": "For help with example account notices, contact support@example.invalid.",
"embeddedLink": false,
"embeddedPhone": false,
"numberPool": false,
"ageGated": false,
"directLending": false,
"termsAndConditions": true,
"autoRenewal": false,
"mnoIds": [],
"referenceId": "your-trial-reference"
}Állítsa a termsAndConditions értékét true értékre csak azután, hogy a jogosult személy áttekintette és elfogadta az alkalmazandó feltételeket. A példa nem minősül az Ön nevében adott hozzájárulásnak. A jelzőkhöz JSON logikai értékeket használjon, ne idézőjelbe tett sztringeket.
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--header 'Content-Type: application/json' \
--header "Idempotency-Key: $IDEMPOTENCY_KEY" \
--data-binary @campaign.json \
'https://api.multitel.net/tcr/v2/campaignBuilder'Kampánymezők és feltételes követelmények
| Mezők | Mit kell megadni |
|---|---|
| brandId, channelId, usecase | Az Ön saját tulajdonú márkája, a 10DLC csatorna és egy jogosult aktuális használatieset-kód. A minősítésből származó kódokat használja, ne lefordított címkéket. |
| subUsecases | A jogosult al-használatieset-kódok tömbje. Tartsa be a kiválasztott minősítés minimális és maximális darabszámát. |
| resellerId | Egy engedélyezett viszonteladó-azonosító. A fiók által birtokolt útvonal elfogadja a saját viszonteladókat, a beállított megosztott viszonteladóját vagy a szándékos viszonteladó nélküli értéket. A nem kapcsolódó viszonteladót a rendszer elutasítja. |
| description, messageFlow | Írja le a tényleges célt és a hozzájárulás gyűjtésének módját. Mindegyiknek 40–4096 karaktert kell tartalmaznia. Tüntesse fel a valós felhasználói műveletet, űrlapot vagy folyamatot; ne találjon ki olyan hozzájárulást, amelyet az alkalmazása nem gyűjt. |
| sample1 … sample5 | Reprezentatív üzenetek, általában 20–1024 karakter üzenetenként. A portál legalább egyet megkövetel; a jogosult hálózatok többet is megkövetelhetnek. Adja meg az aktuális minősítés által megkövetelt darabszámot. |
| subscriberOptin, subscriberOptout, subscriberHelp | Deklarálja a támogatott címzettfolyamatokat pontosan ezekkel a mezőnevekkel. Amikor egy folyamat engedélyezve van, adja meg annak kulcsszó- és üzenetmezőit. A hálózati követelmények bizonyos folyamatokat kötelezővé tehetnek. |
| optinKeywords, optoutKeywords, helpKeywords | A ténylegesen felismert kulcsszavak, legfeljebb 255 karakter. Ezeknek meg kell egyezniük a fogadó alkalmazás viselkedésével. |
| optinMessage, optoutMessage, helpMessage | A megfelelő üzenetek. Az aktuálisan közzétett mezőszabályok 20–1024 karaktert írnak elő. Tüntessen fel valós támogatási és leiratkozási viselkedést. |
| embeddedLink, embeddedPhone, embeddedLinkSample | A beágyazott hivatkozásokat vagy telefonszámokat valósághűen deklarálja. Egy egyébként jogosult hálózat megtilthatja őket. A hivatkozásminta legfeljebb 255 karaktert engedélyez. |
| mnoIds | A minősítésből származó jogosult numerikus hálózatazonosítók opcionális tömbje. Ne feltételezze, hogy minden hálózat támogatja a kiválasztott használati esetet. |
| numberPool, ageGated, directLending | Az alkalmazandó kampányjellemzők JSON logikai értékekként. A tényleges szolgáltatásnak megfelelően válassza ki őket. |
| privacyPolicyLink, termsAndConditionsLink | Az Ön vonatkozó nyilvános szabályzati és feltétel-URL-jei, ha alkalmazandók, legfeljebb 2048 karakter egyenként. Ezeknek a tényleges üzenetküldő szolgáltatást kell leírniuk. |
| termsAndConditions | Az alkalmazandó kampányfeltételek kifejezett elfogadása. A portál true értéket követel meg, és varázslója az aktuális egyéni megerősítéseket is begyűjti. |
| autoRenewal | Azt jelzi, hogy a kampány megújul-e. Az alapértelmezett érték true. A megújítás letiltása nem szünteti meg az éles kampányhoz már társított minimális kötelezettségvállalást. |
| referenceId, tag | Az Ön kampányhivatkozása, legfeljebb 50 karakter, és az opcionális címkék. A referenceId nem az Idempotency-Key fejléc. |
A közzétett séma némi következetlen nagybetűhasználatot tartalmaz a leíró táblázatokban. Az aktuális portálkérés a subscriberOptin és a subscriberOptout mezőket használja a fent bemutatottak szerint. Tartsa meg pontosan ezt a kis- és nagybetűhasználatot. Ez az útmutató a bérlői 10DLC munkafolyamatot tárgyalja; ne következtessen arra, hogy egy másik csatorna kötelező mezői vagy aktiválási lépései megegyeznek.
Azonos szándékolt kérés biztonságos újrapróbálása
Használjon egy Idempotency-Key fejlécet ehhez a szándékolt létrehozáshoz. A kulcs 1–128 nyomtatható ASCII-karakter szóközök nélkül, és a tulajdonos fiók hatókörébe tartozik. Újrapróbálkozáskor tartsa változatlanul a HTTP-metódust, az elérési utat, a lekérdezési sztringet és a törzs pontos bájtjait. Az újraformázott JSON-fájl akkor is ütközik, ha értékei egyenértékűek.
A folyamatban lévő duplikátum HTTP 409 választ adhat Retry-After fejléccel; a befejezett kérések visszajátszhatják tárolt válaszukat. A gyorsítótárazott hiba nem bizonyítja, hogy a nyilvántartás semmit sem hozott létre. Mentse a campaignId és requestId értékeket, valamint a korrelációs fejléceket, vizsgálja meg a meglévő kampányt, és egyeztesse a részleges hibát, mielőtt új kulcsot fontolna meg.
A kampányazonosító nem a végleges küldési beállítás
A válasz HTTP-állapotot és közvetlen JSON-t használ. Sikeres létrehozáskor őrizze meg a campaignId értékét, és olvassa be annak aktuális állapotát:
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"A portál aktuális éles munkafolyamata a kampányt az üzenetküldő szolgáltatóval is megosztja, és a márkát/kampányt betölti a küldő fiókba. Ezek a nyilvános létrehozási hívástól különálló műveletek. A nyilvántartási kampány akkor is létezhet, ha egy későbbi megosztási vagy szolgáltatóbetöltési lépés sikertelen.
Használja a portál integrált éles létrehozási munkafolyamatát, amikor a kombinált regisztrációs, megosztási és szolgáltatóbetöltési sorrendre van szüksége. Közvetlenül ezzel az API-val már létrehozott éles kampány esetén őrizze meg annak kampányazonosítóját, és a fiók szolgáltatói beállítását egyeztesse a támogatáson keresztül. A jelenlegi ügyfél-felület nem kínál általános folytatás gombot minden közvetlenül létrehozott éles kampányhoz. Ne hozzon létre újabb regisztrációt az aktiválás újrapróbálásához. Erősítse meg, hogy a kampány aktív és a szolgáltatói beállítás befejeződött, mielőtt küldőszámot rendelne hozzá. A számnak is saját tulajdonúnak, aktívnak és SMS-képesnek kell lennie. A kampány létrehozása nem küld üzeneteket.
Éles kampányok díjai
| Használati eset | Havi díj |
|---|---|
| LOW_VOLUME, UCAAS_LOW | $1.67 |
| SOLE_PROPRIETOR | $2.23 |
| CHARITY | $3.34 |
| EMERGENCY | $5.56 |
| AGENTS_FRANCHISES | $33.34 |
| Egyéb beállított tartalék használati esetek | $11.12 |
Ezeket a kiskereskedelmi összegeket az aktuális portálkonfigurációval szemben ellenőrizték október 24-én (2026-ban). Éles benyújtás előtt erősítse meg az aktuális minősített használati esetet és a megjelenített árat. A nyilvántartási minősítési válaszban szereplő monthlyFee nem automatikusan az Ön MultiTEL kiskereskedelmi ára.
Az aktuális portál három hónapos minimális kötelezettségvállalást ír elő a nem politikai éles kampányokra. Megerősítés előtt tekintse át az alkalmazandó feltételeket és a megújítási választást. A regisztráció, a szám bérlete, a kiegészítő ellenőrzés és az üzenethasználat külön díjak. A sikeres létrehozási válasz önmagában nem bizonyítja, hogy minden számlázási vagy szolgáltatóaktiválási lépés befejeződött.
Érvényesítési és részleges hibák kezelése
Olvassa be a HTTP status értékét és a visszaadott JSON-t. Az érvényesítési hibák code/description objektumok tömbjei lehetnek; a helyi hibák ezzel szemben message, status mezőket tartalmazó objektumok, és egyes feldolgozási hibáknál requestId mezőt is tartalmazhatnak.
| HTTP-eredmény | Következő lépés |
|---|---|
| 400 | Javítsa ki a konkrét mezőket vagy az idempotenciakulcsot. Olvassa be újra az aktuális minősítést, a megkövetelt mintadarabszámot és a címzettfolyamatokra vonatkozó követelményeket. |
| 401, 403 vagy 404 | Ellenőrizze az API-hitelesítő adatokat és az engedélyezett forrás-IP-címet, majd a márka/viszonteladó tulajdonjogát és engedélyeit. Ne használjon másik fiókból származó azonosítókat. |
| 402 | Tekintse át az éles fedezetet és a vásárlási engedélyt, mielőtt újrapróbálná ugyanazt a szándékolt létrehozást. |
| 409 | Különböztesse meg a folyamatban lévő visszajátszást az ugyanazon kulcsot használó módosított kéréstől. Egyeztetéskor őrizze meg a meglévő kampány és a kérés adatait. |
| 429 vagy a korlátozó nem érhető el | Vegye figyelembe a Retry-After fejlécet, ha jelen van, és őrizze meg az eredeti kulcsot és a pontos kérést. |
| 500 vagy 502 | A létrehozás már megtörténhetett. Mentse az összes campaignId és requestId értéket, ellenőrizze a meglévő kampányt, és duplikátum létrehozása helyett folytassa vagy egyeztesse annak aktiválását. |