Sie befinden sich hier:
Spezifikation der API zum Abrufen des Tokens
Verwenden Sie diese Informationen, um eine Tokendarstellung erforderlicher Nur-Textwerte bereitzustellen. Marketing Cloud Engagement verwendet diese API-Methode, um die Tokendarstellung eines Nur-Text-Werts abzurufen.
Engagement sendet eine HTTP-POST-Anforderung an den URI für den Tokenserver, den Sie im Rahmen eines tokenisierten Sendevorgangs bereitstellen. Diese Anforderung enthält eine Liste der Tokenwerte und Ihr Tokenserver antwortet mit der Liste der Tokenwerte und zugeordneten Token.
Wenn die Anforderung ohne ein Token gesendet wird, enthält das Antwort-JSON im Token-Array keine Daten. Wenn die Anforderung nur einen einzigen tokenValue enthält und Ihr Tokenserver kein Token dafür zur Verfügung stellt, enthält die Antwort ein leeres Array für die Token-Eigenschaft in der JSON-Antwort.
Die API ruft die Tokendarstellung von Telefonnummerndaten ab. Das Token wird anstelle der Quell-Telefonnummer aus einer eingehenden SMS-Nachricht in der Datenbank gespeichert.
Voraussetzungen
Aktivieren Sie SSL am Endpunkt. Verwenden Sie die Authentifizierung für einfache oder OAuth-Client-Anmeldeinformationen mit serverseitiger IP-Zulassungsliste, um Clientaufrufe zu authentifizieren.
JSON-Anforderungstextformat
Marketing Cloud Engagement sendet eine Anforderung mit dem Inhaltstyp application/json, wobei der Text ein obligatorisches Array von Tokenwerten namens tokenValues enthält. Jedes "tokenValue"-Objekt im Datenbereich enthält die folgenden Eigenschaften.
| Parametername (Schlüssel) | Typ | Erforderlich | Beschreibung | |
|---|---|---|---|---|
| tokenValues | Keine | Datenbereich (erforderlich) | Ja | Datenbereich der "tokenValue"-Objekte, für die der Server Token zurückgibt. |
| Jedes "tokenValue"-Objekt enthält die folgenden Eigenschaften: | ||||
| tokenRequestId | Zeichenfolge (erforderlich) | Ja | Die UUID (generiert pro Token). | |
| tokenValue | Zeichenfolge (erforderlich) | Ja | Die im Klartext normalisierte Mobiltelefonnummer oder E-Mail-Adresse. | |
| tokenType | Zeichenfolge (erforderlich) | Ja | Gibt das Token als "MobileNumber" oder "Email" an. | |
| privateCode | Zeichenfolge | Nein | Der private kurze oder lange Code für Mobiltelefonversendungen. | |
JSON-tokenValues-Beispielanforderung
{
"tokenValues": [
{
"tokenRequestId": "abc123thn567",
"tokenValue": "13172237777",
"tokenType": "MobileNumber",
"privateCode": "46356",
},
{
"tokenRequestId": "abc098thn654",
"tokenValue": "13175559911",
"tokenType": "MobileNumber",
"privateCode": "45356",
}
]
}JSON-Antworttextformat
Die im Inhaltstypblock "application/json" zurückgegebene Antwort enthält einen HTTP-Statuscode.
| Code | Nachricht | Anmerkungen |
|---|---|---|
| 200 | OK | Anforderung erfolgreich verarbeitet |
| 400 | Ungültige Anforderung | Falsch formatierte Anforderung |
| 500 | Interner Serverfehler | Unerwarteter Fehler beim Verarbeiten der Anforderung |
| 503 | Service nicht verfügbar | Service derzeit nicht verfügbar |
Text- und Tokenobjekt
| Parametername (Schlüssel) | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| token | Datenbereich (erforderlich) | Ja | Datenbereich der zurückgegebenen Token |
| Eigenschaft | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tokenRequestId | Zeichenfolge (erforderlich) | Ja | Die als Teil der Anforderung bereitgestellte UUID. Dieser Wert muss mit einem der Werte aus der Anforderung übereinstimmen. |
| token | Zeichenfolge (erforderlich) | Ja | Das Token, das verwendet wird, um einen Marketingkontakt darzustellen. |
| subscriberKey | Zeichenfolge | Nein | Dieser Wert enthält den Abonnentenschlüssel für den Kontakt. Geben Sie einen Wert oder einen zufälligen Schlüssel an. |
Überlegungen zu MobileConnect
Token unterhalten eine 1:1-Beziehung mit Telefonnummern. Token für Telefonnummern verwenden denselben Wert, selbst wenn diese Mobiltelefonnummer für mehrere Kontakte angezeigt wird. Stellen Sie das echte Land vor dem mobilen Token bereit, wenn Sie vorhaben, getriggerte Versendungen (messageContact-API) zu verwenden. Der Gesamtwert darf 15 Zeichen nicht überschreiten.
Beispielantwort
{
"tokens": [
{
"tokenRequestId": "abc123thn567",
"token": "999911112222",
"subscriberKey": "abc123456xyz”
},
{
"tokenRequestId": "abc098thn654",
"token": "999911112233",
"subscriberKey": "123abcxyz456”
}
]
}