[BEGRÄNSAD TILLGÄNGLIGHET]{class="badge informative" title="Begränsat till migrerade Campaign Standard-användare"}

Hantera transaktionsmeddelanden managing-transactional-messages

AVAILABILITY
För närvarande finns transaktionsmeddelanden med REST API:er tillgängliga för e-post- och SMS-kanalerna. Det är endast tillgängligt för transaktionshändelser (anrikningsdata är endast tillgängliga via nyttolast, som liknar hur Adobe Campaign V8 fungerar).

När du har skapat och publicerat en transaktionshändelse måste du integrera den som utlöser den här händelsen på webbplatsen.

Du vill t.ex. att en händelse om att kunden överger en varukorg ska utlösas så fort någon av dina kunder lämnar webbplatsen innan de köper produkterna i kundvagnen. För att kunna göra detta måste du som webbutvecklare använda API:t REST Transactional Messages.

  1. Skicka en begäran enligt POST-metoden, som utlöser sändning av transaktionshändelsen.
  2. Svaret på POST-begäran innehåller en primärnyckel som gör att du kan skicka en eller flera begäranden via en GET-begäran. Du kan sedan hämta händelsestatusen.

Skicka en transaktionshändelse sending-a-transactional-event

Transactional-händelsen skickas via en POST-begäran med följande URL-struktur:

POST https://mc.adobe.io/<ORGANIZATION>/campaign/<transactionalAPI>/<eventID>
  • <ORGANISATION>: ditt personliga organisations-ID. Se det här avsnittet.

  • <transactionalAPI>: API:t endPoints för transaktionsmeddelanden.

    Namnet på API-slutpunkten för transaktionsmeddelanden beror på instanskonfigurationen. Det motsvarar värdet "mc" följt av ditt personliga organisations-ID. Låt oss ta Geometrixx-företagets exempel med"geometrixx" som företags-ID. I så fall skulle POST-begäran vara följande:

    POST https://mc.adobe.io/geometrixx/campaign/mcgeometrixx/<eventID>

  • <eventID>: den typ av händelse som du vill skicka. Detta ID genereras när händelsekonfigurationen skapas

POST-begärandehuvud

Begäran måste innehålla rubriken"Content-Type: application/json".

Du måste lägga till en teckenuppsättning, till exempel utf-8. Observera att det här värdet beror på vilket REST-program du använder.

-X POST \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>' \
-H 'Content-Type: application/json;charset=utf-8' \
-H 'Content-Length:79' \

POST-begärandeinnehåll

Händelsedata finns inuti JSON POST-brödtexten. Händelsestrukturen beror på dess definition.

Följande valfria parametrar kan läggas till i händelseinnehållet för att hantera sändning av transaktionsmeddelanden som är länkade till händelsen:

  • förfallodatum (valfritt): efter det här datumet avbryts sändningen av transaktionshändelsen.
  • schemalagd (valfritt): från detta datum bearbetas transaktionshändelsen och transaktionsmeddelandet skickas.
NOTE
Värdena för parametrarna "expiration" och "schedule" följer ISO 8601-formatet. ISO 8601 specificerar användningen av versalen "T" för att separera datum och tid. Den kan dock tas bort från indata eller utdata för bättre läsbarhet.

Kommunikationskanalparametrar

Beroende på vilken kanal som ska användas ska nyttolasten innehålla parametrarna nedan:

  • E-postkanal: "mobilePhone"
  • SMS-kanal: "email"

Om nyttolasten bara innehåller "mobilePhone" aktiveras SMS-kommunikationskanalen. Om nyttolasten bara innehåller e-post aktiveras e-postkommunikationskanalen.

I exemplet nedan visas en nyttolast där en SMS-kommunikation kommer att utlösas:

curl --location 'https://mc.adobe.io/<ORGANIZATION>/campaign/mcAdobe/EVTcartAbandonment' \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--header 'Cache-Control: no-cache' \
--header 'X-Api-Key: <API_KEY>' \
--header 'Content-Type: application/json;charset=utf-8' \
--header 'Content-Length: 79' \
--data '
{
  "mobilePhone":"+9999999999",
  "scheduled":"2017-12-01 08:00:00.768Z",
  "expiration":"2017-12-31 08:00:00.768Z",
  "ctx":
  {
    "cartAmount": "$ 125",
    "lastProduct": "Leather motorbike jacket",
    "firstName": "Jack"
  }
}'

Om nyttolasten innehåller både"email" och"mobilePhone" används e-post som standardkommunikationsmetod. Om du vill skicka ett SMS när båda fälten finns tillgängliga måste du uttryckligen ange det i nyttolasten med hjälp av parametern önskad kanal.

Svar på POST-begäran

POST-svaret returnerar transaktionshändelsens status när det skapades. Om du vill hämta den aktuella statusen (händelsedata, händelsestatus…) använder du den primärnyckel som returneras av POST-svaret i en GET-begäran:

GET https://mc.adobe.io/<ORGANIZATION>/campaign/<transactionalAPI>/<eventID>/

Exempelbegäran

POST-begäran om att skicka händelsen.

-X POST https://mc.adobe.io/<ORGANIZATION>/campaign/mcAdobe/EVTcartAbandonment \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>' \
-H 'Content-Type: application/json;charset=utf-8' \
-H 'Content-Length:79'

{
  "


  ":"test@example.com",
  "scheduled":"2017-12-01 08:00:00.768Z",
  "expiration":"2017-12-31 08:00:00.768Z",
  "ctx":
  {
    "cartAmount": "$ 125",
    "lastProduct": "Leather motorbike jacket",
    "firstName": "Jack"
  }
}

Svar på POST-begäran.

{
  "PKey":"<PKEY>",
  "ctx":
  {
    "cartAmount": "",
    "lastProduct": "",
    "firstName": ""
  }
  "email":"",
  "scheduled":"2017-12-01 08:00:00.768Z",
  "expiration":"2017-12-31 08:00:00.768Z",
  "href": "mcAdobe/EVTcartAbandonment/<PKEY>",
  "serverUrl":" https://myserver.com ",
  "status":"pending",
  "type":""
}

Status för transaktionshändelse transactional-event-status

I svaret kan du i statusfältet se om händelsen har bearbetats eller inte:

  • väntande: händelsen väntar - händelsen får den här statusen när den precis har utlösts.
  • bearbetar: händelsen väntar på att levereras - den håller på att omvandlas till ett meddelande och meddelandet skickas.
  • pausad: Händelseprocessen pausas. Den bearbetas inte längre, utan ligger i en kö i Adobe Campaign-databasen.
  • bearbetad: händelsen bearbetades och meddelandet skickades.
  • ignorerades: händelsen ignorerades av leveransen, vanligtvis när en adress är i karantän.
  • deliveryFailed: Ett leveransfel uppstod när händelsen bearbetades.
  • routingFailed: routningsfasen misslyckades - detta kan till exempel inträffa när den angivna händelsetypen inte kan hittas.
  • tooOld: Händelsen gick ut innan den kunde bearbetas. Detta kan inträffa av olika orsaker, till exempel om en sändning misslyckas flera gånger (detta leder till att händelsen inte längre är uppdaterad) eller när servern inte längre kan bearbeta händelser efter att den har överlagrats.
recommendation-more-help
7167b251-0f24-48cd-a4e0-234fe2acbdea