Üzenetküldési regisztrációs katalógusok betöltése

A választható értékek betöltése a regisztrációs űrlap elkészítése előtt

A választható értékeket az aktuális üzenetküldési regisztrációs katalógusból töltse be, ne a nyilvántartás értékeinek kódba írásával adja meg őket. Márkaűrlap esetén a portál betölti a vállalkozástípusok, iparágak, alternatív vállalkozásazonosító-típusok, márkakapcsolatok, országok, amerikai tagállamok és tőzsdék katalógusait. Kampányűrlap esetén a felhasználási eseteket, az érvényes alárendelt felhasználási eseteket és a kapcsolódási partnereket tölti be. Minden visszakapott gépi értéket őrizzen meg a megjelenítési címkéjével együtt; egy későbbi kérés összeállításakor az értéket használja, ne a lefordított címkét.

Katalógus kiválasztása

A TCR válaszának közvetlen kezelése

A válasz törzse közvetlenül a TCR API válasza. Számos régebbi /v3 végponttal ellentétben nem tartalmaz hozzáadott status/response burkolóstruktúrát. Az értelmezése előtt ellenőrizze a HTTP állapotkódot. Egy katalógus szöveges címkéket vagy strukturált meghatározásokat is tartalmazhat, ezért ne feltételezze, hogy minden érték ugyanazokkal a mezőkkel rendelkezik. Ha a HTTP kérés sikeres, de a törzs nem a várt szerkezetű, érvényes JSON, jelezze a lekérdezés sikertelenségét ahelyett, hogy észrevétlenül üres listával helyettesítené.

A katalógusban választható értékek elkülönítése a jogosultságtól és az árazástól

A felhasználási esetek általános katalógusa nem mutatja meg, hogy egy adott márka mely felhasználási esetekre jogosult. A jelenlegi portál a kampány létrehozása előtt márkaspecifikus jogosultsági lekérdezést végez, és ellenőrzi a kiválasztott távközlési szolgáltató követelményeit. Hasonlóképpen, a beszállító díjmetaadatai nem jelentik a fiók végleges kiskereskedelmi árát. A fiókra vonatkozó árat és a regisztrációs feltételeket külön vizsgálja meg. Egy katalógus betöltése nem hagy jóvá márkát, kampányt vagy üzenetküldésre használt telefonszámot.

A nem elérhető katalógusok kezelése

Ha a lekérdezés sikertelen, őrizze meg az ügyfél által az űrlapon megadott adatokat. Jelenítse meg a hibát, és vegye figyelembe a Retry-After fejlécet, ha szerepel a válaszban, továbbá növekvő várakozási idővel próbálkozzon újra. Ne töltse újra ismételten az összes katalógust, és ne kezeljen egy sebességkorlátozási vagy adatátviteli hibát üres, érvényes katalógusként. Ez a GET kérés nem igényel idempotenciakulcsot, és nem kerül újrajátszásra a módosítási műveletek idempotenciatárából.

Kérés

Használjon engedélyezett API-fiókot HTTPS kapcsolaton keresztül, engedélyezett forrás-IP-címről. A jelenlegi útvonal támogatja a fiók hitelesítési szabályzatát, beleértve a Basic hitelesítést és az engedélyezett, hozzáférési jogkivonattal hitelesítő API-fiókokat. Ne használja a szolgáltató hitelesítő adatait.

Küldjön GET kérést úgy, hogy az útvonalban egy támogatott katalógus neve szerepeljen. A vonatkozó katalógusszűrőket a lekérdezési karakterláncban adja át. Kéréstörzsre nincs szükség.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/enum/usecase?validSubUsecase=true"

Válasz

Ez a TCR útvonal közvetlenül adja vissza a nyilvántartás válaszának törzsét a hozzá tartozó HTTP állapotkóddal. Nem használja a régebbi v3 status.code/status.msg/response burkolóstruktúrát. A katalógusok szerkezete eltérő: egyesek leíró objektumokat rendelnek az értékekhez, mások karakterláncokat. Egy későbbi űrlap elküldésekor őrizze meg a géppel olvasható kulcsokat. A rövidített, kitalált usecase példa objektumértékű leképezést szemléltet, nem élő katalógust vagy garantáltan teljes sémát. Ellenőrizze a HTTP állapotkódot és a várt JSON szerkezetet is.

Szemléltető válaszszerkezet; nem élő fiókadatokat vagy aktuális árajánlatot tartalmaz.

{
  "2FA": {
    "displayName": "Authentication",
    "description": "Example authentication use case"
  }
}

Hibák

• 401: A fiók hitelesítése sikertelen. Ellenőrizze az API hitelesítő adatát, a fiók engedélyezett állapotát és a vonatkozó forrás-IP-korlátozásokat.
• 400/404 és egyéb nyilvántartási hibák: Érvénytelen vagy nem elérhető katalógus vagy szűrő. A jelenlegi útvonal megőrzi a háttérszolgáltatás HTTP állapotkódját és válaszának törzsét; nincs általános v3 hibaburkolóstruktúra.
• 429: A fiókra vonatkozó vagy a szolgáltató megosztott kéréskorlátját elérte. Vegye figyelembe a Retry-After fejlécet, és növekvő várakozási idővel próbálkozzon újra.
• 502: A nyilvántartást nem sikerült elérni. Az elérhetőség ismeretlen; ne adjon vissza üres választási listát sikeres eredményként.
• 503: A kéréskorlátozó vagy a háttérszolgáltatás nem érhető el. Újrapróbálkozás előtt vizsgálja meg a válasz törzsét és az esetlegesen kapott Retry-After fejlécet.

Elérhetőség és mellékhatások

• Ez a katalóguslekérő GET kérés a felülvizsgált végrehajtási útvonalon nem hoz létre márkát vagy kampányt, nem küld be regisztrációt, nem foglal le erőforrást, és nem számít fel regisztrációs díjat. Kapcsolatba lép a szolgáltatóval, és kérésaudit-bejegyzéseket ír.
• A katalógusok meghatározásai és az esetleges beszállítói díjmetaadatok nem minősülnek az ügyfélnek szóló kiskereskedelmi árajánlatnak. A jelenlegi portál külön szerzi be a kampányok kiskereskedelmi árait; a régi getCampaignPrice segédfüggvény és a korábbi felsorolástípusok ármegjegyzései nem tekinthetők az útvonal árazási szerződésének.
• Egy támogatott katalógusbejegyzés nem bizonyítja, hogy egy adott márka jogosult az adott felhasználási esetre. Egy későbbi regisztrációs kérés előtt végezze el a márkaspecifikus jogosultságvizsgálatot, tegye meg a nyilatkozatokat, szerezze be a hozzájárulást, és vizsgálja felül a fiókra vonatkozó árakat.