Vælg et eksisterende brand på din konto
Start med det brand-id i registret, der allerede er knyttet til din MultiTEL-konto. Dette opslag opretter ikke et brand og knytter ikke en andens brand til din konto. Den nuværende kundearbejdsgang kontrollerer ejerskabet, før der anmodes om oplysninger om kvalificering. Hvis opslaget returnerer 404, skal du kontrollere den valgte konto og det valgte brand i stedet for at bruge et lokalt række-id.
Brug dette resultat til at opstille de mulige anvendelser
Det generelle anvendelseskatalog beskriver registrets muligheder. Dette brandspecifikke opslag leverer valgmulighederne for det valgte brand. Bevar hver returneret usecase-værdi, og kombiner den med katalogets visningsnavn og beskrivelse. Tilbyd ikke alle poster i det generelle katalog, som om brandet var kvalificeret til dem.
Portalen forventer, at dette svar er en JSON-liste. Hvis svaret mangler, er forkert formateret eller er en fejl, skal du bevare kundens formular og vise, at oplysningerne om kvalificering ikke kunne indlæses. Behandl det ikke stiltiende som en godkendelse af en standardanvendelse. Registret kan returnere flere felter end dem, der er vist i det forkortede eksempel.
Indlæs kravene til den valgte anvendelse
Når en kunde har valgt en returneret anvendelsesværdi, skal du sende en anmodning til /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} for det samme brand. Svaret angiver grænserne for underanvendelser og operatørspecifikke krav. Brug det til at indsamle beskedeksempler, samtykke og andre påkrævede erklæringer. Listen over kvalificerede anvendelser er ikke i sig selv tilstrækkelig til at udarbejde en fuldstændig kampagneregistrering.
Gennemgå kontoens priser særskilt
Udbyderfelter som monthlyFee, quarterlyFee eller annualFee, når de returneres, beskriver metadata om udbyderens gebyrer. De erstatter ikke prisen på kundens konto eller registreringsvilkårene. Den nuværende portal henter kampagnernes slutkundepriser særskilt og kombinerer dem med oplysninger om kvalificering på sin gennemgangsside. Udled ikke et kundebeløb af de fastkodede priser i den gamle hjælpefunktion til enumerationer.
Opdater, når brandet eller anvendelsen ændres
Kassér det forrige brands valgmuligheder, når du skifter brand, og indlæs oplysninger om kvalificering for det nye valg. Opdater kravene til den valgte anvendelse før indsendelse. Disse GET-anmodninger indsender ikke en registrering, aktiverer ikke en kampagne og tildeler ikke numre.
Anmodning
Brug en aktiveret API-konto via HTTPS fra en tilladt kilde-IP-adresse. Den nuværende rute understøtter kontoens autentificeringspolitik, herunder Basic-autentificering og aktiverede API-konti med bearer-token. Brug ikke udbyderens legitimationsoplysninger.
GET med brandets identifikator i URL-stien. Der kræves ingen anmodningskrop.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
brand_id | tekststreng | Ja | Det brand-id i registret, der er knyttet til din autentificerede MultiTEL-konto. Brug brand-id'et, ikke et lokalt databaserække-id, et kampagne-id eller virksomhedens skattenummer. Kod det som ét URL-stisegment. |
Svar
Den nuværende TCR-rute returnerer registrets JSON-svarindhold direkte og bevarer dets HTTP-status. Den tilføjer ikke den ældre v3-indpakning med status/response. Det forkortede, fiktive eksempel er ikke et aktuelt resultat af en kvalificeringsforespørgsel. Kontroller HTTP-status og den forventede JSON-struktur, før du bruger svaret. Den nuværende portal forventer en liste over kvalificeringsposter, der hver identificerer en usecase. Den kombinerer disse poster med usecase-kataloget for at finde visningsnavne og henter slutkundepriser særskilt. Yderligere udbyderfelter kan forekomme.
Illustration af svarstrukturen; ikke aktuelle kontodata eller et gældende pristilbud.
[
{
"usecase": "2FA"
}
]Fejl
- 401: Kontoautentificeringen mislykkedes. Kontroller API-legitimationsoplysningerne, om kontoen er aktiveret, og de gældende begrænsninger for kilde-IP-adresser.
- 404: Brandet er ikke knyttet til den autentificerede konto, eller udbyderen kan ikke finde det ønskede brand eller valg. En lokal afvisning på grund af manglende ejerskab returneres, før der sendes en anmodning til udbyderen.
- Andre registerfejl: HTTP-status og svarindhold fra det bagvedliggende system bevares. En ugyldig eller utilgængelig anvendelse er ikke et vellykket svar med et tomt sæt krav.
- 429: Kontoens anmodningsgrænse eller den fælles anmodningsgrænse hos udbyderen er nået. Overhold Retry-After.
- 502/503: Fejl i transporten eller manglende tilgængelighed hos udbyderen eller anmodningsbegrænseren. Bevar formularen, og prøv igen med gradvist længere ventetid mellem forsøgene.
Tilgængelighed og sideeffekter
- Den gennemgåede GET kontrollerer ejerskabet af det eksisterende brand, kontakter registret og skriver revisionsposter for anmodningen. Den opretter ikke et brand eller en kampagne og opkræver ikke et registreringsgebyr.
- Metadata om udbydergebyrer er ikke et pristilbud til en MultiTEL-slutkunde. Portalen gennemgår kontoens priser særskilt før en senere registreringsanmodning.
- Kvalificering og krav kan ændre sig. Opdater dem for det valgte brand og den valgte anvendelse før indsendelse. Et vellykket opslag er ikke en kampagnegodkendelse, en nummertildeling eller en tilladelse til at begynde at sende beskeder.