Selecteer een bestaand merk in uw account
Begin met de merk-ID uit het register die al aan uw MultiTEL-account is gekoppeld. Deze opvraging maakt geen merk aan en koppelt geen merk van iemand anders aan uw account. De huidige klantworkflow controleert het eigendom voordat de toegestane toepassingen worden opgevraagd. Als de opvraging 404 retourneert, controleer dan het geselecteerde account en merk in plaats van een lokale rij-ID in te vullen.
Stel de toepassingskeuzes samen op basis van dit resultaat
De algemene toepassingscatalogus beschrijft de opties van het register. Deze merkspecifieke opvraging levert de keuzes voor het geselecteerde merk. Bewaar elke geretourneerde usecase-waarde en combineer die met de weergavenaam en beschrijving uit de catalogus. Bied niet alle vermeldingen uit de algemene catalogus aan alsof het merk voor elk daarvan in aanmerking komt.
Het portaal verwacht dat dit antwoord een JSON-lijst is. Als het antwoord ontbreekt, ongeldig is opgebouwd of een fout bevat, behoud dan het formulier van de klant en geef aan dat de toegestane toepassingen niet konden worden geladen. Beschouw dit niet stilzwijgend als goedkeuring voor een standaardtoepassing. Het register kan meer velden retourneren dan in het verkorte voorbeeld worden getoond.
Laad de vereisten voor de geselecteerde toepassing
Nadat een klant een geretourneerde toepassingswaarde heeft gekozen, vraagt u /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} op voor hetzelfde merk. Dat antwoord bevat de grenzen voor subtoepassingen en de vereisten per telecomaanbieder. Gebruik het om voorbeeldberichten, toestemming en andere vereiste verklaringen te verzamelen. Alleen de lijst met toegestane toepassingen is niet voldoende om een volledige campagneregistratie samen te stellen.
Controleer de accountprijzen afzonderlijk
Providervelden zoals monthlyFee, quarterlyFee of annualFee bevatten, wanneer ze worden geretourneerd, metagegevens over providerkosten. Ze vervangen niet de accountprijs van de klant of de registratievoorwaarden. Het huidige portaal haalt de verkoopprijzen voor campagnes afzonderlijk op en combineert die met de gegevens over toegestane toepassingen voor het controlescherm. Leid geen klanttarief af uit de vast geprogrammeerde prijzen in de oude hulpfunctie voor enumeraties.
Vernieuw de gegevens wanneer het merk of de toepassing verandert
Verwijder bij het wisselen van merk de keuzes van het vorige merk en laad de toegestane toepassingen voor de nieuwe selectie. Vernieuw de vereisten voor de geselecteerde toepassing vóór het indienen. Deze GET-verzoeken dienen geen registratie in, activeren geen campagne en wijzen geen nummers toe.
Verzoek
Gebruik een ingeschakeld API-account via HTTPS vanaf een toegestaan bron-IP-adres. De huidige route ondersteunt het authenticatiebeleid van het account, waaronder Basic-authenticatie en ingeschakelde API-accounts met bearertokens. Gebruik geen inloggegevens van de provider.
GET met de merk-ID in het URL-pad. Een verzoekbody is niet vereist.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"| Naam | Type | Verplicht | Beschrijving |
|---|---|---|---|
brand_id | tekenreeks | Ja | De merk-ID uit het register die aan uw geauthenticeerde MultiTEL-account is gekoppeld. Gebruik de merk-ID, niet een lokale databaserij-ID, campagne-ID of fiscaal bedrijfsnummer. Codeer deze als één URL-padsegment. |
Antwoord
De huidige TCR-route retourneert de JSON-body van het register rechtstreeks en behoudt de HTTP-status ervan. De oude status/response-envelop van v3 wordt niet toegevoegd. Het verkorte fictieve voorbeeld is geen werkelijk resultaat van een opvraging van toegestane toepassingen. Controleer vóór gebruik de HTTP-status en de verwachte JSON-structuur. Het huidige portaal verwacht een lijst met records over toegestane toepassingen, die elk een usecase aangeven. Het combineert die records met de usecase-catalogus voor weergavenamen en haalt verkoopprijzen afzonderlijk op. Er kunnen aanvullende providervelden aanwezig zijn.
Illustratieve antwoordstructuur; geen actuele accountgegevens of geldige prijsopgave.
[
{
"usecase": "2FA"
}
]Fouten
- 401: Accountauthenticatie mislukt. Controleer de API-inloggegevens, of het account is ingeschakeld en de toepasselijke beperkingen voor bron-IP-adressen.
- 404: Het merk is niet gekoppeld aan het geauthenticeerde account, of de provider kan het opgevraagde merk of de selectie niet vinden. Een lokale weigering op basis van eigendom wordt geretourneerd voordat een verzoek naar de provider wordt verstuurd.
- Andere registerfouten: de HTTP-status en de antwoordbody van het achterliggende systeem blijven behouden. Een ongeldige of niet-beschikbare toepassing betekent niet dat er een geslaagd antwoord met een lege verzameling vereisten is.
- 429: De verzoeklimiet van het account of de gedeelde verzoeklimiet van de provider is bereikt. Houd u aan Retry-After.
- 502/503: Transportfout of onbeschikbaarheid van de provider of verzoekbegrenzer. Behoud het formulier en probeer het opnieuw met oplopende wachttijden.
Beschikbaarheid en neveneffecten
- Het beoordeelde GET-verzoek controleert het eigendom van het bestaande merk, neemt contact op met het register en schrijft auditrecords over het verzoek. Het maakt geen merk of campagne aan en brengt geen registratiekosten in rekening.
- Metagegevens over providerkosten zijn geen prijsopgave voor een MultiTEL-klant. Het portaal controleert de accountprijzen afzonderlijk voordat later een registratieverzoek wordt ingediend.
- De toegestane toepassingen en vereisten kunnen veranderen. Vernieuw ze vóór het indienen voor het geselecteerde merk en de geselecteerde toepassing. Een geslaagde opvraging is geen campagnegoedkeuring, nummertoewijzing of toestemming om berichten te gaan versturen.