Kihagyás

Send API

A kiküldött email-ek szövege kétfajta módon jöhet létre. Vagy a paraméterként érkezik a sendMail hívás során, vagy a Hammy állítja össze egy korábban létrehozott template alapján. Első esetben a hívó feladata kitölteni a mailSubject, mailBody és opcionálisan a mailHtmlBody paramétereket. Template renderelés esetén a fenti három paraméter értéke üres kell legyen, a messageType-nak viszont tartalmaznia kell a kiküldendő levél típusát, ami alapján kiválasztásra kerül egy template.

Egy email-ben tetszőleges számú csatolmányt küldhetünk. Ezeket az attachment listában tudjuk átadni.

Az email szövegében az ügyfél megszemélyesíthető. Az ehhez szükséges adatokat kulcs-érték párral rendelkező property-kben kell átadni. Van üzenet szintű, és vannak csatolmány szintű property listák, a levél szöveg sablonjában mindegyikre hivatkozhatunk megfelelő jelölésmód használatával.

Az email szövegét is lehetséges dokumentumtárban letárolni, ezt a levélhez tartozó archivingExpected paraméterrel vezérli.

Csatolmány

Csatolmány esetén az ATTACHMENT_SOURCE kulcsú adat megadása kötelező. Lehetséges értékei:

Ebben az esetben a csatolmányt a content mezőben base64 kódolva kell beküldeni.

Külső filerendszerből olvassuk fel a csatolmányt. A következő paraméterek megadása szükséges:

  • RELATIVE_FILE_PATH: Az external root directory-hoz képest relatív elérési út. (Az external root directory egy előre konfigurált, fix könyvtár.)

Ebben az esetben dokumentum tárból szerezzük meg a csatolmányt. Ilyenkor további paraméterek megadása szükséges:

  • DMS_DOCUMENT_ID: A csatolmány azonosítója.
Archiválás
  • Archiválás esetén az ARCHIVE_TARGET kulcsú adat megadása kötelező: Lehetséges értékei:

Kötelező paraméterei:

  • ARCHIVE_RELATIVE_PATH: Az external root directory-hoz képest relatív elérési út.

Archiválás DMS-be.

Verziók

Újdonságok

V2
  • A kérés objektumban megjelent a channel mező, ami definiálja a feldolgozási irányt. A V1-es verzióban kizárólag email-eket küldünk, ebben a verzióban lehetőség van más küldési irányokra is.
    • EMAIL: Email küldési igény esetén. Alapértelmezett érték.
    • POST: Postai ág.
    • ARCHIVE: Csak archiválás ág. A kérésben beküldött csatolmányok archiválásra kerülnek.
    • SMS: SMS küldési igény esetén (jelenleg nem használható).
    • FACEBOOK: Facebook üzenet küldési igény esetén (jelenleg nem használható).
  • EMAIL ág esetén mező átnevezések:
    • recipientAddress -> recipientEmailAddress
    • ccRecipientAddress -> recipientEmailAddressCC
    • ccRecipientName -> recipientNameCC
  • POST ág esetén új mezők:
    • recipientPostalAddress
    • letterType
V3
  • EMAIL csatorna esetén megjelent a scenarioName mező, ami a kéréshez tartozó szcenárió nevét tartalmazza. a mező töltésének akkor van értelme, ha a beküldés template-tel történt. Ebben az esetben a szcenárió segítségével lehet definiálni egyéb eseményeket a kiküldés után.
  • Megjelent a recipientPhoneNumber mező, ami a címzett telefonszámát tartalmazza.
  • FACEBOOK csatorna esetén megjelent a recipientPSID mező, ami a címzett facebook azonosítóját tartalmazza, Facebook-üzenet küldés esetére.
  • A kérés objektumban a channel mező új értéke a PORTAL. Ebben az esetben az email ténylegesen nem kerül kiküldésre, csak egy értesítő email. Az eredeti üzenet az ügyfél portálon tekinthető meg.
  • Megjelent a repliedMessageUuid mező, ami annak az üzenetnek az azonosítója (uuid-ja), amire az adott küldés válaszol.
  • Megjelent a fromPhoneNumber mező, ami a feladó telefonszámát tartalmazza.
  • Megjelent a fromPageAccessToken mező, ami a feladó Page Access Token-jét tartalmazza.
V4
  • A campaignPart helyett innentől a lekérdezésben a campaignPartContent-et tudjuk megadni a campaignPartContentUuid mező segítségével.
V5
  • A címzett lakcíméhez a következő mezők jelenktek meg:
    • recipientPostalAddressCountryCode
    • recipientPostalAddressPostalCode
    • recipientPostalAddressCity
    • recipientPostalAddressStreet
    • recipientPostalAddressStreetType
    • recipientPostalAddressStreetNumber
    • recipientPostalAddressBuilding
    • recipientPostalAddressFloor
    • recipientPostalAddressDoor
  • Megjelent a mobilePushAddress mező.

Funkciók

Send

Verzió
V8 V7 V6 V5 V4 V3

Resend

Verzió
V7 V6 V5 V3-4 V2 V1

Quick send

Verzió
V4-5

Set message properties

Verzió
V3-5

Set attachment properties

Verzió
V3-5

Send campaign part

Verzió
V4-5