Læs et brands kampagnekrav

Hold brandet og use casen sammen

Brug brand-id'et på din konto og en use case-værdi, der er returneret af det samme brands kvalifikationsliste. Kundearbejdsgangen kontrollerer ejerskab før udbyderforespørgslen. Bekræft, at det returnerede objekts usecase stemmer overens med den valgte værdi. Et opslag for ét brand eller én use case fastlægger ikke krav for et andet.

Læs de aktuelle krav

Anvend de valgte operatørers krav samlet

Operatørkrav kan variere. Når der ikke angives en eksplicit operatørliste, tager portalen alle operatørmetadata i svaret i betragtning; en ikke-tom liste begrænser kontrollerne til de valgte id'er. Brug ikke kun den første operatørs antal eksempler eller erklæringer. Vælg operatører fra svaret, kontrollér understøttelse og kvalifikation, opfyld det højeste gældende minimum for eksempler, og opfyld påkrævede erklæringer om tilmelding, afmelding og hjælp på tværs af det valg. Portalen afviser valgte operatør-id'er, der mangler i det aktuelle svar, og afviser et valg uden nogen berettiget operatør.

Krav beskriver, hvad der skal leveres; de beviser ikke, at kundens samtykkeproces eller kampagneindhold opfylder disse krav. Indsaml sandfærdige, repræsentative eksempler og erklæringer. Slå ikke automatisk erklæringer til for at få en formular til at gå igennem.

Forbered eksempler og abonnentsvar

Den aktuelle kampagneformular bruger sample1 til og med sample5 til beskedeksempler. Hvis kravene ikke kan opfyldes inden for den tilgængelige formular, skal du stoppe og afklare valget med support. For en aktiveret abonnenterklæring skal du angive dens tilhørende nøgleord og svartekst: optinKeywords/optinMessage, optoutKeywords/optoutMessage og helpKeywords/helpMessage. Hold eksemplerne i overensstemmelse med den valgte use case og den faktiske kundekommunikation.

Gennemgå før enhver registreringsforespørgsel

Opdater kravene, når brandet, use casen eller operatørvalget ændres. Portalen revaliderer den valgte use case, antallet af under-use cases, operatørberettigelse, eksempler og erklæringer før oprettelse. Gennemgå kontoprissætning og registreringsvilkår separat. Denne GET registrerer eller godkender ikke en kampagne, deler den ikke med beskedoperatøren og tildeler ikke et telefonnummer. Oprettelse og provisionering er separate handlinger.

Håndter et mislykket kravopslag

Hvis forespørgslen mislykkes, returnerer uventet JSON eller ikke stemmer overens med den valgte use case, skal formularen forblive ufuldstændig, og kunden skal kunne prøve igen, når fejlen er løst. Erstat ikke utilgængelige krav med et tomt objekt, og antag ikke, at manglende data betyder ingen krav. Respekter Retry-After, og brug backoff ved hastighedsbegrænsninger og tilgængelighedsfejl.

Forespørgsel

Brug en aktiveret API-konto over HTTPS fra en tilladt kilde-IP-adresse. Den aktuelle rute understøtter kontoens autentificeringspolitik, herunder Basic-autentificering og aktiverede bearer-API-konti. Brug ikke udbyderens legitimationsoplysninger.

GET med brand-id'et og den valgte use case-værdi i URL-stien. Der kræves ingen forespørgselstekst.

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 aktuelle TCR-rute returnerer registrets JSON-indhold direkte og bevarer dets HTTP-status. Den tilføjer ikke den ældre v3-status/response-indpakning. Det forkortede fiktive eksempel er ikke et reelt kvalifikationsresultat. Kontrollér HTTP-status og den forventede JSON-form, før du bruger det. Portalen forventer et objekt, hvis usecase stemmer overens med den valgte use case. Operatørkrav findes under mnoMetadata, indekseret efter operatør-id. Eksemplets operatør-id og krav er fiktive. Andre udbyderfelter kan blive returneret.

Illustrativ svarform; ikke reelle kontodata eller et aktuelt tilbud.

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

Fejl

• 401: Kontoautentificering mislykkedes. Kontrollér API-legitimationsoplysningerne, aktiveringstilstanden og gældende kilde-IP-begrænsninger.
• 404: Brandet er ikke knyttet til den autentificerede konto, eller udbyderen kan ikke finde det ønskede brand eller valg. Et lokalt ejerskabsafslag returneres før en udbyderforespørgsel.
• Andre registerfejl: Den opstrøms HTTP-status og det opstrøms indhold bevares. En ugyldig eller utilgængelig use case er ikke et vellykket tomt kravsæt.
• 429: Kontoens eller den delte udbyders forespørgselsgrænse er nået. Respekter Retry-After.
• 502/503: Tilgængelighedsfejl i transport, udbyder eller hastighedsbegrænser. Bevar formularen, og prøv igen med backoff.

Tilgængelighed og bivirkninger

• Den gennemgåede GET kontrollerer eksisterende brandejerskab, kontakter registret og skriver forespørgselsrevisionsposter. Den opretter ikke et brand eller en kampagne og opkræver ikke et registreringsgebyr.
• Udbyderens gebyrmetadata er ikke et MultiTEL-detailtilbud til kunden. Portalen gennemgår kontoprissætning separat før en senere registreringsforespørgsel.
• Kvalifikation og krav kan ændre sig. Opdater dem for det valgte brand og den valgte use case før indsendelse. Et vellykket opslag er ikke en kampagnegodkendelse, nummertildeling eller tilladelse til at begynde at sende beskeder.