Hämta kataloger för registrering av meddelandetjänster

Hämta alternativen innan du bygger ett registreringsformulär

Använd den aktuella katalogen för registrering av meddelandetjänster för att fylla i valalternativ i stället för att hårdkoda registervärden. För ett varumärkesformulär hämtar portalen kataloger för företagstyp, bransch, typ av alternativ företagsidentifierare, relation till varumärket, land, amerikansk delstat och börs. För ett kampanjformulär hämtar den användningsfall, giltiga underanvändningsfall och anslutningspartner. Behåll varje returnerat maskinvärde tillsammans med dess visningstext; använd värdet, inte en översatt visningstext, när du bygger en senare begäran.

Välj en katalog

Hantera svaret från TCR direkt

Svarskroppen kommer direkt från TCR-API:et. Till skillnad från många äldre /v3-slutpunkter har det inget tillagt status/response-omslag. Kontrollera HTTP-statusen innan du tolkar svaret. En katalog kan innehålla visningstexter i form av strängar eller strukturerade definitioner, så utgå inte från att alla värden har samma fält. Om HTTP-begäran lyckas men svarskroppen inte är giltig JSON med förväntad struktur ska du rapportera att uppslaget misslyckades i stället för att tyst ersätta svaret med en tom lista.

Skilj katalogalternativ från behörighetsprövning och prissättning

En allmän katalog över användningsfall visar inte vilka användningsfall ett enskilt varumärke är kvalificerat för. Den nuvarande portalen gör ett varumärkesspecifikt uppslag för att kontrollera behörigheten innan en kampanj skapas och kontrollerar kraven för den valda operatören. På samma sätt är en leverantörs avgiftsmetadata inte kontots slutliga kundpris. Granska det tillämpliga kontopriset och registreringsvillkoren separat. Att hämta en katalog innebär inte att ett varumärke, en kampanj eller ett nummer för meddelanden godkänns.

Hantera kataloger som inte är tillgängliga

Behåll kundens formulärinmatningar om ett uppslag misslyckas. Visa felet, följ Retry-After när det returneras och öka väntetiden mellan återförsöken. Hämta inte alla kataloger om och om igen och behandla inte ett fel på grund av anropsbegränsning eller överföring som en tom, giltig katalog. Denna GET-begäran kräver ingen idempotensnyckel och spelas inte upp igen från idempotenslagret för ändringsanrop.

Begäran

Använd ett aktiverat API-konto via HTTPS från en tillåten käll-IP-adress. Den aktuella routen stöder kontots autentiseringspolicy, inklusive Basic-autentisering och aktiverade API-konton med bearer-autentisering. Använd inte leverantörens inloggningsuppgifter.

Gör en GET-begäran med ett katalognamn som stöds i sökvägen. Skicka tillämpliga katalogfilter i frågesträngen. Ingen begärandekropp behövs.

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

Svar

Denna TCR-route returnerar registrets svarskropp direkt med dess HTTP-status. Den använder inte det äldre v3-omslaget status.code/status.msg/response. Katalogernas strukturer varierar: vissa kopplar värden till beskrivande objekt, andra kopplar värden till strängar. Behåll de maskinläsbara nycklarna när du senare skickar in ett formulär. Det förkortade, fiktiva exemplet för usecase visar en avbildning med objekt som värden, inte en aktuell katalog eller ett garanterat fullständigt schema. Kontrollera både HTTP-statusen och att JSON-strukturen är den förväntade.

Illustration av svarets struktur; inte aktuella kontouppgifter eller en aktuell offert.

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

Fel

• 401: Kontoautentiseringen misslyckades. Kontrollera API-autentiseringsuppgifterna, att kontot är aktiverat och tillämpliga begränsningar för käll-IP-adresser.
• 400/404 och andra registerfel: Ogiltig eller otillgänglig katalog eller ogiltigt eller otillgängligt filter. Den aktuella routen behåller den bakomliggande tjänstens HTTP-status och svarskropp; det finns inget universellt v3-felomslag.
• 429: Kontots eller leverantörens gemensamma anropsgräns har nåtts. Följ Retry-After och öka väntetiden mellan återförsöken.
• 502: Registret kunde inte nås. Tillgängligheten är okänd; ersätt inte svaret med tomma valalternativ och behandla det som ett lyckat resultat.
• 503: Anropsbegränsaren eller den bakomliggande tjänsten är inte tillgänglig. Granska svarskroppen och en eventuell Retry-After-header innan du försöker igen.

Tillgänglighet och sidoeffekter

• Denna GET-begäran för kataloger skapar inte något varumärke eller någon kampanj, skickar inte in någon registrering, reserverar inte någon resurs och debiterar inte någon registreringsavgift i det granskade flödet. Den kontaktar leverantören och skriver granskningsposter för begäran.
• Katalogdefinitioner och eventuell avgiftsmetadata från leverantören utgör inte en offert med kundpriser. Den nuvarande portalen hämtar kampanjernas kundpriser separat; den äldre hjälpfunktionen getCampaignPrice och gamla prisannoteringar för uppräkningsvärden får inte behandlas som denna routes prissättningskontrakt.
• Att en katalogpost stöds är inget bevis på att ett visst varumärke är kvalificerat för det användningsfallet. Slutför den varumärkesspecifika behörighetsprövningen, försäkringarna, samtycket och granskningen av kontots prissättning innan du senare skickar en registreringsbegäran.