Sjekk hvilke bruksområder som er tilgjengelige for en merkevares kampanjer

Velg en eksisterende merkevare på kontoen din

Start med merkevare-ID-en i registeret som allerede er knyttet til MultiTEL-kontoen din. Dette oppslaget oppretter ikke en merkevare og knytter heller ikke noen andres merkevare til kontoen din. Den gjeldende arbeidsflyten for kunder kontrollerer eierskap før den ber om kvalifikasjonsopplysninger. Hvis oppslaget returnerer 404, kontrollerer du valgt konto og merkevare i stedet for å bruke en lokal rad-ID.

Bygg listen over bruksområder fra dette resultatet

Den generelle katalogen over bruksområder beskriver alternativene i registeret. Dette merkevarespesifikke oppslaget gir alternativene for den valgte merkevaren. Behold hver returnerte usecase-verdi og kombiner den med visningsnavnet og beskrivelsen fra katalogen. Ikke tilby alle oppføringene i den generelle katalogen som om merkevaren kvalifiserte for dem.

Portalen forventer at dette svaret er en liste i JSON-format. Hvis svaret mangler, har feil format eller er en feil, beholder du kundens skjema og viser at kvalifikasjonsopplysningene ikke kunne lastes inn. Ikke behandle dette som en godkjenning av et standardbruksområde uten å varsle kunden. Registeret kan returnere flere felt enn dem som vises i det forkortede eksemplet.

Last inn kravene for det valgte bruksområdet

Når kunden har valgt en av de returnerte bruksområdeverdiene, sender du en forespørsel til /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} for den samme merkevaren. Svaret gir grenser for underbruksområder og operatørspesifikke krav. Bruk det til å samle inn meldingseksempler, samtykke og andre påkrevde erklæringer. Kvalifikasjonslisten alene er ikke nok til å utarbeide en fullstendig kampanjeregistrering.

Gjennomgå prisene for kontoen separat

Leverandørfelt som monthlyFee, quarterlyFee eller annualFee, når de returneres, beskriver metadata om leverandørens gebyrer. De erstatter ikke prisen for kundens konto eller registreringsvilkårene. Den gjeldende portalen henter utsalgspriser for kampanjer separat og kombinerer dem med kvalifikasjonsdata på gjennomgangsskjermen. Ikke utled hva kunden skal belastes, fra de hardkodede prisene i den gamle hjelpefunksjonen for opplistingstyper.

Oppdater når merkevaren eller bruksområdet endres

Forkast alternativene for den forrige merkevaren når du bytter merkevare, og last inn kvalifikasjonsopplysninger for det nye valget. Oppdater kravene for det valgte bruksområdet før innsending. Disse GET-forespørslene sender ikke inn en registrering, aktiverer ikke en kampanje og tildeler ikke numre.

Forespørsel

Bruk en aktivert API-konto over HTTPS fra en tillatt kilde-IP-adresse. Den gjeldende ruten støtter kontoens autentiseringspolicy, inkludert Basic-autentisering og aktiverte API-kontoer med bearer-autentisering. Ikke bruk leverandørens påloggingsopplysninger.

GET med merkevareidentifikatoren i URL-banen. Ingen forespørselskropp er nødvendig.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"

Svar

Den gjeldende TCR-ruten returnerer registerets JSON-kropp direkte og bevarer HTTP-statusen. Den legger ikke til den eldre status/response-innpakningen fra v3. Det forkortede, fiktive eksemplet er ikke et faktisk kvalifikasjonsresultat fra et oppslag. Kontroller HTTP-statusen og den forventede JSON-strukturen før du bruker svaret. Den gjeldende portalen forventer en liste med kvalifikasjonsposter som hver identifiserer en usecase. Den kombinerer disse postene med usecase-katalogen for å hente visningsnavn, og henter utsalgspriser separat. Ytterligere leverandørfelt kan forekomme.

Illustrasjon av svarstrukturen; dette er ikke faktiske kontodata eller et gjeldende pristilbud.

[
  {
    "usecase": "2FA"
  }
]

Feil

• 401: Autentisering av kontoen mislyktes. Kontroller API-påloggingsopplysningene, at kontoen er aktivert, og gjeldende begrensninger for kilde-IP-adresser.
• 404: Merkevaren er ikke knyttet til den autentiserte kontoen, eller leverandøren finner ikke den forespurte merkevaren eller det forespurte valget. En lokal avvisning på grunn av eierskap returneres før en forespørsel sendes til leverandøren.
• Andre registerfeil: HTTP-statusen og svarkroppen fra den oppstrøms tjenesten bevares. Et ugyldig eller utilgjengelig bruksområde er ikke et vellykket svar med et tomt sett med krav.
• 429: Forespørselsgrensen for kontoen eller den delte grensen hos leverandøren er nådd. Følg Retry-After.
• 502/503: Overføringsfeil eller utilgjengelig leverandør eller forespørselsbegrenser. Behold skjemaet og prøv på nytt med gradvis lengre ventetid mellom forsøkene.

Tilgjengelighet og sideeffekter

• Den gjennomgåtte GET-forespørselen kontrollerer eierskapet til en eksisterende merkevare, kontakter registeret og skriver revisjonslogger for forespørsler. Den oppretter ikke en merkevare eller kampanje og belaster ikke et registreringsgebyr.
• Metadata om leverandørens gebyrer er ikke et utsalgspristilbud til en MultiTEL-kunde. Portalen gjennomgår prisene for kontoen separat før en senere registreringsforespørsel.
• Kvalifikasjoner og krav kan endres. Oppdater dem for den valgte merkevaren og det valgte bruksområdet før innsending. Et vellykket oppslag er ikke en godkjenning av kampanjen, en tildeling av numre eller en tillatelse til å begynne å sende meldinger.