Kihagyás

Send API V8

HammySend8API WSDL letöltése

Swagger leíró letöltése

Send

REST API

REST API Info

Kérés

POST hammy/json/send/v8/send

multipart/form-data, multipart/mixed vagy application/json kérés.

A kötelező oszlop jelentése:

  • * - minden esetben kötelező
  • E - EMAIL, PORTAL channel esetén kötelező
  • P - POST channel esetén kötelező
  • A - ARCHIVE channel esetén kötelező

multipart név: message

Név Típus Leírás Kötelező
requestMeta JRequestMeta_V1 Metainformációk.
requestId String (150) A kérés azonosítója a hívó oldalon. (vnd.api ID)
batchId String (100) A levélköteg azonosítója.
partnerRef String (100) Partner azonosító.
messageType String (100) A kérés típusa. Értéke egy hammy-ben létező levélsablon azonosítója.
scenarioName String (100) Az emailhez tartozó szcenárió azonosítója.
messageTypeVersion Integer A levélhez tartozó template verziószáma.
mailSubject String (600) Email tárgya. A mező, illetve kérés típusa egyidejűleg nem adható meg.
mailBody String (CLOB) Email szövege. A mező, illetve kérés típusa egyidejűleg nem adható meg.
mailHtmlBody String (CLOB) HTML email szövege. A mező, illetve kérés típusa egyidejűleg nem adható meg.
recipientPostalAddress String (255) A címzett teljes postai címe. P
recipientPostalAddressCountryCode String (25) A címzett postai címének ország kódja.
recipientPostalAddressPostalCode String (10) A címzett postai címének irányítószáma.
recipientPostalAddressCity String (50) A címzett postai címének városa.
recipientPostalAddressStreet String (100) A címzett postai címének utca neve.
recipientPostalAddressStreetType String (20) A címzett postai címének utca típusa.
recipientPostalAddressStreetNumber String (20) A címzett postai címének házszáma.
recipientPostalAddressBuilding String (10) A címzett postai címének épület száma.
recipientPostalAddressFloor String (10) A címzett postai címének emelete.
recipientPostalAddressDoor String (10) A címzett postai címének ajtója.
recipientEmailAddress String (100) A címzett email címe. E
recipientName String (100) A címzett teljes neve. *
recipientEmailAddressCC String (100) A másolatot kapó személy email címe. Pontosvesszővel felsorolva több is megadható.
recipientNameCC String (100) A másolatot kapó személy neve.
recipientPhoneNumber String (50) A címzett telefonszáma. P
recipientPSID String (100) A címzett facebook azonosítója.
replyToAddress String (100) A válasz-email címe.
replyToName String (100) A válasz-email neve.
mobilePushAddress String (100) Azonosító telefonos push notificationhöz.
fromAddress String (100) A küldő email címe.
fromName String (100) A küldő teljes neve.
fromPhoneNumber String (100) A küldő telefonszáma.
fromPageAccessToken String (100) A küldő Page Access Token-je.
bccAddress String (150) Titkos másolat email cím.
xmlData String (CLOB) Az üzenethez tartozó adatok XML formátumban.
archivingExpected Boolean true esetén a levél tárgya és szövege archiválódik.
certificationExpected Boolean true érték esetén a levél aláírásra kerül.
replyEnvelopeAttached Boolean true jelzi , hogy az üzenethez válaszboríték van csatolva.
paymentSlipAttached Boolean true jelzi , hogy az üzenethez csekk van csatolva.
channel MessageChannel A csatorna neve.
relatedMessageId Integer Kapcsolodó üzenet Id.
campaignPartContentUuid Integer Kapcsolodó kampányrész Uuid.
letterType String (LetterType) A postai levél típusa. P
repliedMessageUuid String (100) Annak az üzenetnek az azonosítója, amire a hívó oldal válaszol.
calendar JCalendar1 Naptár objektum, ennek segítségével lehet naptár bejegyzést is csatolni az üzenethez.
properties JProperty2 [ ] Az üzenethez tartozó egyéb adatok, metaadatok.
attachments JAttachment5 [ ] A csatolmányokat tartalmazó lista. A
paymentRequestData JPaymentRequestData1 Az azonnali fizetési kéréshez tartozó adatok.

A csatolmányokat további partokban lehet megadni, a part neve a csatolmány referenciája.

Válasz

Név Típus Leírás
messageId Integer Az aktuális levél adatbázisbeli azonosítója. (vnd.api ID)
messageUuid String Az aktuális levél uuid-ja.
meta JMeta1 A válaszhoz tartozó metainformációk.

Minta

POST /hammy/json/send/v8/send
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
content-type: application/json

{
  "requestId": "req001",
  "partnerRef": "pRef001",
  "scenarioName": "FIZETESI_KERELEM_SCENARIO_01",
  "recipientEmailAddress": "csaba@dbx.hu",
  "recipientName": "Csaba",
  "recipientPhoneNumber": "+36304285097",
  "paymentRequestData": {
    "debtorIban": "pDebtorIban",
    "debtorName": "pDebtorName",
    "instructedAmount": 100,
    "creditorPartnerId": 324,
    "taxId": "tax001",
    "dateOfExpiry": null
  }
}

{
  "data": {
    "type": "sendResponse",
    "attributes": {
      "messageUuid": "076c8c08-efc6-4c9c-87fd-f1a69c914432"
    }
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Quick send

Ebben a verzióban nem változott.

Quick send V1

Resend

REST API

REST API Info

Kérés

Név Típus Leírás
requestMeta JRequestMeta_V1 Metainformációk.
requestId String (150) A kérés azonosítója. (vnd.api ID)
messageId Integer Az aktuális levél adatbázisbeli azonosítója.
messageUuid String Az aktuális levél uuid-ja.
recipientAddress String (100) A címzett email címe.
recipientPhoneNumber String (100) A címzett telefonszáma.
properties JProperty1 [ ] Az üzenethez tartozó egyéb adatok, metaadatok.

Válasz

Név Típus Leírás
messageId Integer Az aktuális levél adatbázisbeli azonosítója. (vnd.api ID)
messageUuid String Az aktuális levél uuid-ja.
meta JMeta1 A válaszhoz tartozó metainformációk.

Minta

POST: hammy/json/send/v5/resend
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
Content-Type: application/json
X-User-Name: {{userName}}
Accept: application/json

{
    "messageUuid": "b83c3f81-3005-489c-9393-3d8594c4223e",
    "recipientAddress": "teszt@dbx.hu",
    "properties": []
}

HTTP/1.1 200 OK
Content-Type: application/json

{
    "meta": {
        "responseStatus": {
            "code": 0,
            "messages": []
        },
        "params": []
    },
    "messageUuid": "a03795c8-f133-4eca-bc1e-9c5aea8ca2f8"
}

Set message properties

Ebben a verzióban nem változott.

Set message properties V3

Set attachment properties

Ebben a verzióban nem változott.

Set attachment properties V3

Send campaign part

Ebben a verzióban nem változott.

Send campaign part V4