Tartsa együtt a márkát és a felhasználási esetet
Használja a fiókjához tartozó márkaazonosítót és egy olyan felhasználásieset-értéket, amelyet ugyanennek a márkának a minősítési listája adott vissza. Az ügyfélmunkafolyamat a szolgáltatói kérés előtt ellenőrzi a tulajdonjogot. Győződjön meg arról, hogy a visszaadott objektum usecase mezője megegyezik a kiválasztott értékkel. Az egyik márkára vagy felhasználási esetre vonatkozó lekérdezés nem határoz meg követelményeket egy másikra.
Olvassa el az aktuális követelményeket
| Mező | Hogyan használja a portál |
|---|---|
| minSubUsecases / maxSubUsecases | Az al-felhasználási esetek minimális és maximális száma ehhez a kiválasztáshoz. Az értékeket az érvényes al-felhasználásieset-katalógusból válassza, ne szabad szövegként adja meg. |
| mnoMetadata | Szolgáltatóspecifikus követelmények szolgáltatóazonosító szerint kulcsolva. A szolgáltató kiválasztásához az aktuális válaszban szereplő azonosítókat használja. |
| mnoSupport / qualify | Szolgáltatói támogatás és minősítés. A portál kizárja azokat a szolgáltatókat, amelyeknél bármelyik mező kifejezetten false értékkel van jelölve, és legalább egy jogosult kiválasztott szolgáltatót igényel. |
| minMsgSamples | Egy szolgáltatóhoz szükséges mintaszám. A portál legalább egy nem üres mintát igényel, és a jogosult kiválasztott szolgáltatók közötti legmagasabb minimumot teljesíti. |
| reqSubscriberOptin / reqSubscriberOptout / reqSubscriberHelp | Kötelező előfizetői nyilatkozatok. Ahol kötelező, a megfelelő nyilatkozatnak true értékűnek kell lennie. Az engedélyezett nyilatkozatokhoz a kulcsszó- és válaszüzenet-mezők is szükségesek. |
| noEmbeddedLink / noEmbeddedPhone | Beágyazott hivatkozásokra vagy telefonszámokra vonatkozó korlátozások. A portál elutasítja a megadott funkciót, ha egy jogosult kiválasztott szolgáltató tiltja azt. |
Alkalmazza együtt a kiválasztott szolgáltatók követelményeit
A szolgáltatói követelmények eltérhetnek. Ha nincs megadva kifejezett szolgáltatólista, a portál a válaszban szereplő összes szolgáltatói metaadatot figyelembe veszi; egy nem üres lista az ellenőrzéseket a kiválasztott azonosítókra korlátozza. Ne csak az első szolgáltató mintaszámát vagy nyilatkozatait használja. Válassza ki a szolgáltatókat a válaszból, ellenőrizze a támogatást és a minősítést, teljesítse a legmagasabb alkalmazandó mintaminimumot, és tegyen eleget a kötelező feliratkozási, leiratkozási és segítségkérési nyilatkozatoknak a teljes kiválasztásra nézve. A portál elutasítja azokat a kiválasztott szolgáltatóazonosítókat, amelyek hiányoznak az aktuális válaszból, és elutasítja a jogosult szolgáltató nélküli kiválasztást.
A követelmények azt írják le, hogy mit kell megadni; nem bizonyítják, hogy az ügyfél hozzájárulási folyamata vagy kampánytartalma megfelel ezeknek a követelményeknek. Gyűjtsön valósághű, reprezentatív mintákat és nyilatkozatokat. Ne kapcsolja be automatikusan a nyilatkozatokat csak azért, hogy az űrlap átmenjen.
Készítse elő a mintákat és az előfizetői válaszokat
Az aktuális kampányűrlap a sample1 és sample5 közötti mezőket használja az üzenetmintákhoz. Ha a követelmények nem teljesíthetők a rendelkezésre álló űrlapon belül, álljon meg, és rendezze a kiválasztást az ügyfélszolgálattal. Engedélyezett előfizetői nyilatkozat esetén adja meg a hozzá tartozó kulcsszavakat és válaszszöveget: optinKeywords/optinMessage, optoutKeywords/optoutMessage és helpKeywords/helpMessage. A minták legyenek összhangban a kiválasztott felhasználási esettel és a tényleges ügyfélüzenetekkel.
Ellenőrzés minden regisztrációs kérés előtt
Frissítse a követelményeket, ha a márka, a felhasználási eset vagy a szolgáltatókiválasztás megváltozik. A portál a létrehozás előtt újra ellenőrzi a kiválasztott felhasználási esetet, az al-felhasználási esetek számát, a szolgáltatói jogosultságot, a mintákat és a nyilatkozatokat. A fiók árazását és a regisztrációs feltételeket külön tekintse át. Ez a GET nem regisztrál és nem hagy jóvá kampányt, nem osztja meg azt az üzenetküldő szolgáltatóval, és nem rendel hozzá telefonszámot. A létrehozás és a kiépítés külön műveletek.
A sikertelen követelmény-lekérdezés kezelése
Ha a kérés sikertelen, váratlan JSON-t ad vissza, vagy nem egyezik a kiválasztott felhasználási esettel, hagyja az űrlapot befejezetlenül, és engedje, hogy az ügyfél a hiba elhárítása után újra próbálkozzon. Ne helyettesítse a nem elérhető követelményeket üres objektummal, és ne feltételezze, hogy a hiányzó adat azt jelenti, hogy nincsenek követelmények. Tartsa tiszteletben a Retry-After fejlécet, és használjon visszavárakozást a sebességkorlátok és a rendelkezésre állási hibák esetén.
Kérés
Használjon engedélyezett API-fiókot HTTPS-en keresztül, engedélyezett forrás-IP-címről. Az aktuális útvonal támogatja a fiók hitelesítési szabályzatát, beleértve a Basic hitelesítést és az engedélyezett bearer API-fiókokat. Ne használjon szolgáltatói hitelesítő adatokat.
GET kérés a márkaazonosítóval és a kiválasztott felhasználásieset-értékkel az URL-útvonalban. Kéréstörzs nem szükséges.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID/usecase/$USECASE"| Név | Típus | Kötelező | Leírás |
|---|---|---|---|
brand_id | string | Igen | A hitelesített MultiTEL-fiókjához társított nyilvántartási márkaazonosító. A márkaazonosítót használja, ne helyi adatbázissor-azonosítót, kampányazonosítót vagy cégadószámot. Egyetlen URL-útvonalszegmensként kódolja. |
usecase | string | Igen | Az ugyanennek a márkának a minősítési listájából kiválasztott, géppel olvasható usecase érték. Őrizze meg a kis- és nagybetűit; ne küldjön lefordított megjelenítési címkét. Egyetlen URL-útvonalszegmensként kódolja. |
Válasz
Az aktuális TCR útvonal közvetlenül a nyilvántartás JSON-törzsét adja vissza, és megőrzi annak HTTP-állapotát. Nem adja hozzá az örökölt v3 status/response borítékot. A rövidített, kitalált példa nem élő minősítési eredmény. Felhasználás előtt ellenőrizze a HTTP-állapotot és a várt JSON-szerkezetet. A portál olyan objektumot vár, amelynek usecase mezője megegyezik a kiválasztott felhasználási esettel. A szolgáltatói követelmények a mnoMetadata alatt találhatók, szolgáltatóazonosító szerint kulcsolva. A példában szereplő szolgáltatóazonosító és követelmények kitaláltak. Más szolgáltatói mezők is visszaadhatók.
Szemléltető válaszszerkezet; nem élő fiókadat és nem aktuális árajánlat.
{
"usecase": "2FA",
"minSubUsecases": 0,
"maxSubUsecases": 0,
"mnoMetadata": {
"12345": {
"mnoSupport": true,
"qualify": true,
"minMsgSamples": 1,
"reqSubscriberOptin": true,
"reqSubscriberOptout": true,
"reqSubscriberHelp": true,
"noEmbeddedLink": false,
"noEmbeddedPhone": false
}
}
}Hibák
- 401: A fiók hitelesítése sikertelen. Ellenőrizze az API hitelesítő adatait, az engedélyezett állapotot és az alkalmazandó forrás-IP-korlátozásokat.
- 404: A márka nincs társítva a hitelesített fiókhoz, vagy a szolgáltató nem találja a kért márkát vagy kiválasztást. A helyi tulajdonjogi elutasítás a szolgáltatói kérés előtt kerül visszaadásra.
- Egyéb nyilvántartási hibák: A felsőbb szintű HTTP-állapot és törzs megőrződik. Az érvénytelen vagy nem elérhető felhasználási eset nem sikeres üres követelménykészlet.
- 429: Elérte a fiók vagy a megosztott szolgáltatói kéréskorlátot. Tartsa tiszteletben a Retry-After fejlécet.
- 502/503: Átviteli, szolgáltatói vagy sebességkorlátozói rendelkezésre állási hiba. Őrizze meg az űrlapot, és próbálja újra visszavárakozással.
Rendelkezésre állás és mellékhatások
- Az átnézett GET ellenőrzi a meglévő márka tulajdonjogát, kapcsolatba lép a nyilvántartással, és kérésnaplózási rekordokat ír. Nem hoz létre márkát vagy kampányt, és nem számít fel regisztrációs díjat.
- A szolgáltatói díj-metaadat nem MultiTEL ügyfél kiskereskedelmi árajánlat. A portál a későbbi regisztrációs kérés előtt külön tekinti át a fiók árazását.
- A minősítés és a követelmények változhatnak. Beküldés előtt frissítse őket a kiválasztott márkához és felhasználási esethez. A sikeres lekérdezés nem jelent kampányjóváhagyást, számkiosztást vagy engedélyt az üzenetküldés megkezdésére.