Les en merkevares kampanjekrav

Hold merkevaren og bruksområdet sammen

Bruk merkevare-ID-en på kontoen din og en bruksområdeverdi som er returnert av den samme merkevarens kvalifiseringsliste. Kundearbeidsflyten kontrollerer eierskap før leverandørforespørselen. Bekreft at det returnerte objektets usecase samsvarer med den valgte verdien. Et oppslag for én merkevare eller ett bruksområde fastsetter ikke krav for en annen.

Les de gjeldende kravene

Bruk de valgte operatørenes krav samlet

Operatørkrav kan variere. Når ingen eksplisitt operatørliste er oppgitt, tar portalen hensyn til alle operatørmetadata i svaret; en ikke-tom liste begrenser kontrollene til de valgte ID-ene. Ikke bruk bare den første operatørens antall eksempler eller erklæringer. Velg operatører fra svaret, kontroller støtte og kvalifisering, oppfyll det høyeste gjeldende minimumet for eksempler, og oppfyll påkrevde erklæringer for påmelding, avmelding og hjelp på tvers av det valget. Portalen avviser valgte operatør-ID-er som mangler i det gjeldende svaret, og avviser et valg uten noen kvalifisert operatør.

Kravene beskriver hva som må leveres; de beviser ikke at kundens samtykkeprosess eller kampanjeinnhold oppfyller disse kravene. Samle inn sannferdige, representative eksempler og erklæringer. Ikke slå på erklæringer automatisk for å få et skjema til å bli godkjent.

Forbered eksempler og abonnentsvar

Det gjeldende kampanjeskjemaet bruker sample1 til og med sample5 for meldingseksempler. Hvis kravene ikke kan oppfylles innenfor det tilgjengelige skjemaet, stopp og avklar valget med kundestøtte. For en aktivert abonnenterklæring oppgir du de tilhørende nøkkelordene og svarteksten: optinKeywords/optinMessage, optoutKeywords/optoutMessage og helpKeywords/helpMessage. Hold eksemplene i samsvar med det valgte bruksområdet og faktisk kundekommunikasjon.

Gjennomgå før enhver registreringsforespørsel

Oppdater kravene når merkevaren, bruksområdet eller operatørvalget endres. Portalen validerer på nytt det valgte bruksområdet, antall under-bruksområder, operatørkvalifisering, eksempler og erklæringer før opprettelse. Gjennomgå kontoprising og registreringsvilkår separat. Denne GET-forespørselen registrerer eller godkjenner ikke en kampanje, deler den ikke med meldingsoperatøren og tildeler ikke et telefonnummer. Opprettelse og klargjøring er separate operasjoner.

Håndter et mislykket kravoppslag

Hvis forespørselen mislykkes, returnerer uventet JSON eller ikke samsvarer med det valgte bruksområdet, hold skjemaet ufullstendig og la kunden prøve på nytt etter at feilen er løst. Ikke erstatt utilgjengelige krav med et tomt objekt, og ikke anta at manglende data betyr ingen krav. Respekter Retry-After og bruk økende ventetid mellom forsøk ved hastighetsbegrensninger og tilgjengelighetsfeil.

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 bærertoken. Ikke bruk leverandørlegitimasjon.

GET med merkevare-ID-en og den valgte bruksområdeverdien i URL-stien. Ingen forespørselskropp er påkrevd.

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

Svar

Den gjeldende TCR-ruten returnerer registerets JSON-kropp direkte og bevarer HTTP-statusen. Den legger ikke til den eldre v3-status/response-konvolutten. Det forkortede fiktive eksemplet er ikke et reelt kvalifiseringsresultat. Kontroller HTTP-status og forventet JSON-form før du bruker det. Portalen forventer et objekt hvis usecase samsvarer med det valgte bruksområdet. Operatørkrav ligger under mnoMetadata, nøklet etter operatør-ID. Eksempelets operatør-ID og krav er fiktive. Andre leverandørfelt kan bli returnert.

Illustrerende svarform; ikke reelle kontodata eller et gjeldende pristilbud.

{
  "usecase": "2FA",
  "minSubUsecases": 0,
  "maxSubUsecases": 0,
  "mnoMetadata": {
    "12345": {
      "mnoSupport": true,
      "qualify": true,
      "minMsgSamples": 1,
      "reqSubscriberOptin": true,
      "reqSubscriberOptout": true,
      "reqSubscriberHelp": true,
      "noEmbeddedLink": false,
      "noEmbeddedPhone": false
    }
  }
}

Feil

• 401: Kontoautentisering mislyktes. Kontroller API-legitimasjonen, aktivert tilstand og gjeldende kilde-IP-begrensninger.
• 404: Merkevaren er ikke knyttet til den autentiserte kontoen, eller leverandøren finner ikke den forespurte merkevaren eller det forespurte valget. Et lokalt eierskapsavslag returneres før en leverandørforespørsel.
• Andre registerfeil: Oppstrøms HTTP-status og -kropp bevares. Et ugyldig eller utilgjengelig bruksområde er ikke et vellykket tomt kravsett.
• 429: Kontoens eller den delte leverandørens forespørselsgrense er nådd. Respekter Retry-After.
• 502/503: Tilgjengelighetsfeil i transport, leverandør eller hastighetsbegrenser. Bevar skjemaet og prøv på nytt med økende ventetid mellom forsøk.

Tilgjengelighet og bivirkninger

• Den gjennomgåtte GET-forespørselen kontrollerer eksisterende merkevareeierskap, kontakter registeret og skriver forespørselsrevisjonsposter. Den oppretter ikke en merkevare eller kampanje og belaster ikke et registreringsgebyr.
• Leverandørens gebyrmetadata er ikke et MultiTEL-pristilbud til kunden. Portalen gjennomgår kontoprising separat før en senere registreringsforespørsel.
• Kvalifisering og krav kan endres. Oppdater dem for den valgte merkevaren og det valgte bruksområdet før innsending. Et vellykket oppslag er ikke en kampanjegodkjenning, nummertildeling eller tillatelse til å begynne å sende meldinger.