Välj ett befintligt varumärke på ditt konto
Utgå från det varumärkes-ID i registret som redan är kopplat till ditt MultiTEL-konto. Den här uppslagningen skapar inget varumärke och kopplar inte någon annans varumärke till ditt konto. Det nuvarande kundflödet kontrollerar ägarskapet innan det begär uppgifter om vilka användningsfall varumärket är kvalificerat för. Om uppslagningen returnerar 404 ska du kontrollera det valda kontot och varumärket i stället för att ersätta identifieraren med ett lokalt rad-ID.
Skapa alternativen för användningsfall utifrån detta resultat
Den allmänna katalogen över användningsfall beskriver registrets alternativ. Den här varumärkesspecifika uppslagningen ger alternativen för det valda varumärket. Behåll varje returnerat usecase-värde och kombinera det med katalogens visningsnamn och beskrivning. Erbjud inte alla poster i den allmänna katalogen som om varumärket vore kvalificerat för dem.
Portalen förväntar sig att svaret är en JSON-lista. Om svaret saknas, är felaktigt formaterat eller är ett fel ska du bevara kundens formulär och visa att kvalificeringsuppgifterna inte kunde hämtas. Tolka det inte utan vidare som ett godkännande för ett förvalt användningsfall. Registret kan returnera fler fält än de som visas i det förkortade exemplet.
Hämta kraven för det valda användningsfallet
När kunden har valt ett av de returnerade värdena för användningsfall ska du anropa /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} för samma varumärke. Det svaret anger gränser för underanvändningsfall och operatörsspecifika krav. Använd det för att samla in exempelmeddelanden, samtycke och andra obligatoriska försäkringar. Enbart kvalificeringslistan räcker inte för att sammanställa en fullständig kampanjregistrering.
Granska kontots priser separat
Leverantörsfält som monthlyFee, quarterlyFee eller annualFee, när de returneras, beskriver metadata om leverantörens avgifter. De ersätter inte priset för kundens konto eller registreringsvillkoren. Den nuvarande portalen hämtar kampanjernas kundpriser separat och kombinerar dem med kvalificeringsuppgifterna på granskningssidan. Härled inte en kundavgift från de hårdkodade priserna i den gamla hjälpfunktionen för uppräkningstyper.
Uppdatera när varumärket eller användningsfallet ändras
Ta bort det föregående varumärkets alternativ när du byter varumärke och hämta kvalificeringsuppgifter för det nya valet. Uppdatera kraven för det valda användningsfallet innan registreringen skickas in. Dessa GET-anrop skickar inte in någon registrering, aktiverar ingen kampanj och tilldelar inga nummer.
Begäran
Använd ett aktiverat API-konto via HTTPS från en tillåten käll-IP-adress. Den nuvarande rutten stöder kontots autentiseringspolicy, inklusive Basic-autentisering och aktiverade API-konton med bärartoken. Använd inte leverantörens autentiseringsuppgifter.
GET med varumärkets identifierare i URL-sökvägen. Ingen begärandekropp krävs.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"| Namn | Typ | Obligatorisk | Beskrivning |
|---|---|---|---|
brand_id | sträng | Ja | Det varumärkes-ID i registret som är kopplat till ditt autentiserade MultiTEL-konto. Använd varumärkets ID, inte ett lokalt databasrad-ID, kampanj-ID eller skatteregistreringsnummer för företaget. Koda det som ett enda segment i URL-sökvägen. |
Svar
Den nuvarande TCR-rutten returnerar registrets JSON-kropp direkt och bevarar dess HTTP-status. Den lägger inte till det äldre status/response-omslaget från v3. Det förkortade, fiktiva exemplet är inget aktuellt kvalificeringsresultat. Kontrollera HTTP-statusen och den förväntade JSON-strukturen innan du använder svaret. Den nuvarande portalen förväntar sig en lista med kvalificeringsposter där varje post identifierar ett usecase. Den kombinerar posterna med usecase-katalogen för att få visningsnamn och hämtar kundpriser separat. Ytterligare leverantörsfält kan förekomma.
Illustration av svarets struktur; inga aktuella kontouppgifter eller någon aktuell offert.
[
{
"usecase": "2FA"
}
]Fel
- 401: Autentiseringen av kontot misslyckades. Kontrollera API-autentiseringsuppgifterna, att kontot är aktiverat och vilka begränsningar för käll-IP-adresser som gäller.
- 404: Varumärket är inte kopplat till det autentiserade kontot, eller så kan leverantören inte hitta det begärda varumärket eller valet. Om den lokala ägarskapskontrollen nekar åtkomst returneras avslaget innan något anrop görs till leverantören.
- Andra registerfel: Det överordnade systemets HTTP-status och svarskropp bevaras. Ett ogiltigt eller otillgängligt användningsfall är inte ett lyckat svar med en tom uppsättning krav.
- 429: Kontots anropsgräns eller den delade anropsgränsen hos leverantören har nåtts. Följ Retry-After.
- 502/503: Tillgänglighetsfel i transporten, hos leverantören eller i anropsbegränsaren. Bevara formuläret och försök igen med successivt längre väntetid.
Tillgänglighet och sidoeffekter
- Det granskade GET-anropet kontrollerar ägarskapet för det befintliga varumärket, kontaktar registret och skriver granskningsloggposter för anropet. Det skapar inget varumärke eller någon kampanj och debiterar ingen registreringsavgift.
- Metadata om leverantörens avgifter är ingen offert med kundpriser från MultiTEL. Portalen granskar kontots priser separat före en senare registreringsbegäran.
- Kvalificering och krav kan ändras. Uppdatera dem för det valda varumärket och användningsfallet innan registreringen skickas in. En lyckad uppslagning innebär inte att kampanjen är godkänd, att nummer har tilldelats eller att det är tillåtet att börja skicka meddelanden.