Hammy API

Send API V4

HammySend4API WSDL letöltése

Send

Web service API

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ő
NévTípusLeírásKötelező
clientHashKeyStringA webszolgáltatást hívó kliens azonosítója. Kérje az üzemeltetéstől.*
requestIdString (150)A kérés azonosítója a hívó oldalon.
batchIdString (100)A levélköteg azonosítója.
partnerRefString (100)Partner azonosító.
messageTypeString (100)A kérés típusa. Értéke egy hammy-ben létező levélsablon azonosítója.
scenarioNameString (100)Az emailhez tartozó szcenárió azonosítója.
messageTypeVersionIntegerA levélhez tartozó template verziószáma.
mailSubjectString (600)Email tárgya. A mező, illetve kérés típusa egyidejűleg nem adható meg.
mailBodyString (CLOB)Email szövege. A mező, illetve kérés típusa egyidejűleg nem adható meg.
mailHtmlBodyString (CLOB)HTML email szövege. A mező, illetve kérés típusa egyidejűleg nem adható meg.
recipientPostalAddressString (255)A címzett teljes postai címe.P
recipientPhoneNumberString (50)A címzett telefonszáma.P
recipientNameString (100)A címzett teljes neve.*
recipientEmailAddressCCString (100)A másolatot kapó személy email címe. Pontosvesszővel felsorolva több is megadható.
recipientNameCCString (100)A másolatot kapó személy neve.
recipientEmailAddressString (100)A címzett email címe.E
recipientPSIDString (100)A címzett facebook azonosítója.
replyToAddressString (100)A válasz-email címe.
replyToNameString (100)A válasz-email neve.
fromAddressString (100)A küldő email címe.
fromNameString (100)A küldő teljes neve.
fromPhoneNumberString (100)A küldő telefonszáma.
fromPageAccessTokenString (100)A küldő Page Access Token-je.
bccAddressString (150)Titkos másolat email cím.
xmlDataString (CLOB)Az üzenethez tartozó adatok XML formátumban.
archivingExpectedBooleantrue esetén a levél tárgya és szövege archiválódik.
certificationExpectedBooleantrue érték esetén a levél aláírásra kerül.
replyEnvelopeAttachedBooleantrue jelzi , hogy az üzenethez válaszboríték van csatolva.
paymentSlipAttachedBooleantrue jelzi , hogy az üzenethez csekk van csatolva.
channelMessageChannelA csatorna neve.
userNameString (100)A felhasználó neve.
relatedMessageIdIntegerKapcsolódó üzenet Id.
campaignPartContentUuidIntegerKapcsolódó kampányrész UUID.
letterTypeString (LetterType)A postai levél típusa.P
repliedMessageUuidString (100)Annak az üzenetnek az azonosítója, amire a hívó oldal válaszol.
attachmentsAttachment_V1 [ ]A csatolmányokat tartalmazó lista.A
propertiesProperty_V1 [ ]Az üzenethez tartozó egyéb adatok, metaadatok.
paramsParam_V1 [ ]A szolgáltatás működését befolyásoló egyéb paraméterek listája.

Válasz

NévTípusLeírás
messageIdIntegerAz aktuális levél adatbázisbeli azonosítója.
statusResponseStatus_V1A válasz státusza.
paramsParam_V1 [ ]A szolgáltatás működését befolyásoló egyéb paraméterek listája.

Minta

REST API

REST API Info

Kérés

POST hammy/json/send/v4/send

multipart/form-data vagy multipart/mixed 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évTípusLeírásKötelező
requestMetaJRequestMeta_V1Metainformációk.
requestIdString (150)A kérés azonosítója a hívó oldalon
batchIdString (100)A levélköteg azonosítója
partnerRefString (100)Partner azonosító
messageTypeString (100)A kérés típusa. Értéke egy hammy-ben létező levélsablon azonosítója.
scenarioNameString (100)Az emailhez tartozó szcenárió azonosítója.
messageTypeVersionIntegerA levélhez tartozó template verziószáma.
mailSubjectString (600)Email tárgya. A mező, illetve kérés típusa egyidejűleg nem adható meg.
mailBodyString (CLOB)Email szövege. A mező, illetve kérés típusa egyidejűleg nem adható meg.
mailHtmlBodyString (CLOB)HTML email szövege. A mező, illetve kérés típusa egyidejűleg nem adható meg.
recipientPostalAddressString (255)A címzett teljes postai címe.P
recipientEmailAddressString (100)A címzett email címe.E
recipientNameString (100)A címzett teljes neve.*
recipientEmailAddressCCString (100)A másolatot kapó személy email címe. Pontosvesszővel felsorolva több is megadható.
recipientNameCCString (100)A másolatot kapó személy neve.
recipientPhoneNumberString (50)A címzett telefonszáma.P
recipientPSIDString (100)A címzett facebook azonosítója.
replyToAddressString (100)A válasz-email címe.
replyToNameString (100)A válasz-email neve.
fromAddressString (100)A küldő email címe.
fromNameString (100)A küldő teljes neve.
fromPhoneNumberString (100)A küldő telefonszáma.
fromPageAccessTokenString (100)A küldő Page Access Token-je.
bccAddressString (150)Titkos másolat email cím.
xmlDataString (CLOB)Az üzenethez tartozó adatok XML formátumban.
archivingExpectedBooleantrue esetén a levél tárgya és szövege archiválódik.
certificationExpectedBooleantrue érték esetén a levél aláírásra kerül.
replyEnvelopeAttachedBooleantrue jelzi , hogy az üzenethez válaszboríték van csatolva.
paymentSlipAttachedBooleantrue jelzi , hogy az üzenethez csekk van csatolva.
channelMessageChannelA küldés csatornája.
relatedMessageIdIntegerKapcsolódó üzenet Id.
campaignPartContentUuidIntegerKapcsolódó kampányrész UUID.
letterTypeString (100)A postai levél típusa: NORMAL (normál levél), REGISTERED_MAIL (ajánlott), CERTIFIED_MAIL(tértivevényes).P
repliedMessageUuidString (100)Annak az üzenetnek az azonosítója, amire a hívó oldal válaszol.
calendarJCalendar1Naptár objektum, ennek segítségével lehet naptár bejegyzést is csatolni az üzenethez.
propertiesJProperty1 [ ]Az üzenethez tartozó egyéb adatok, metaadatok.
attachmentsJAttachment2 [ ]A csatolmányokat tartalmazó lista.A

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

Válasz

NévTípusLeírás
messageIdIntegerAz aktuális levél adatbázisbeli azonosítója. (vnd.api ID)
metaJMeta1A válaszhoz tartozó metainformációk.

Minta

POST /hammy/json/send/v4/send?
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-type: application/json
Accept: application/json

{
   "batchId":null,
   "relatedMessageId":null,
   "campaignPartContentUuid":null,
   "messageType":"TESZTSABLON",
   "scenarioName":null,
   "messageTypeVersion":null,
   "recipientName":"Teszt Ügyfél",
   "recipientEmailAddress":"teszt@dbx.hu",
   "recipientPostalAddress":null,
   "recipientPostalAddressCountryCode":"HU",
   "recipientPostalAddressPostalCode":"1027",
   "recipientPostalAddressCity":"Budapest",
   "recipientPostalAddressStreet":"Bem rakpart 56",
   "recipientPostalAddressStreetType":"rakpart",
   "recipientPostalAddressStreetNumber":"56",
   "recipientPostalAddressBuilding":null,
   "recipientPostalAddressFloor":null,
   "recipientPostalAddressDoor":null,
   "recipientEmailAddressCC":null,
   "recipientNameCC":null,
   "recipientPhoneNumber":"+36301325567",
   "bccAddress":null,
   "replyToAddress":null,
   "replyToName":null,
   "fromAddress":null,
   "fromName":null,
   "fromPhoneNumber":null,
   "fromPageAccessToken":null,
   "mailSubject":null,
   "mailBody":null,
   "mailHtmlBody":null,
   "archivingExpected":false,
   "certificationExpected":false,
   "paymentSlipAttached":null,
   "letterType":null,
   "calendar":null,
   "repliedMessageUuid":null,
   "recipientPSID":null,
      "properties":[
                {
                    "id": null,
                    "key": "Teszt",
                    "value": "TesztErtek",
                    "index": null,
                    "isMetaData": false
                }
   ]
}

Queue API minta

Quick send

Előkészület nélküli gyors levélküldés csv forrásból beolvasott címzetteknek.

Web service

Kérés

NévTípusLeírásKötelező
filenameStringBemeneti csv file neve.
dataByte [ ]Input byte tömbbként.
requestMetaRequestMeta_V1A kéréshez tartozó metaadatok.*

Válasz

NévTípusLeírás
jobIdStringA küldésért felelős job azonosítója.
statusResponseStatus_V1A válasz státusza.
paramsParam_V1 [ ]A szolgáltatás működését befolyásoló egyéb paraméterek listája.

Minta

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:send="http://send.api.hammy.dbx.hu/">
    <soapenv:Header/>
        <soapenv:Body>
            <send:quickSend>
                <request>
		    <filename>pelda.csv</filename>
		    <data>cid:145826013353</data>
		    <requestMeta>
		        <clientHashKey>221d316146c591897238</clientHashKey>
	     	        <userName>def</userName>          
		    </requestMeta>
	        </request>
   	    </send:quickSend>
        </soapenv:Body>
</soapenv:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/send/v4/quickSend

NévTípusLeírás
filenameStringBemeneti csv file neve.
csvSeparatorStringElválasztó karaker a csv fileban.
csvFileEncodingStringA csv karakterkódolása.
requestMetaRequestMeta_V1A kéréshez tartozó metaadatok.

Válasz

NévTípusLeírás
idStringAz válasz azonosítója. (vnd.api ID)
jobIdStringA küldésért felelős job azonosítója.
metaJMeta1A válaszhoz tartozó metainformációk.

CSV bemenet

A csv fájlban adhatjuk meg, hogy mely email címekre, milyen konfigurációval akarunk küldeni levelet. Alább látható egy példa csv fájl, amely segítségével 2 címzettnek küldhetünk DMS csatornán keresztül üzenetet.

recipientAddress;recipientName;request.messageType;request.fromAddress;request.fromName;request.archivingExpected;TANACSADO;request.property.ARCHIVE_TARGET
peldaemail1@gmail.com;Címzett Áron;AAA_Teszt_V1;hammy@dbx.hu;From;true;tanácsadó;DMS
peldaemail2@gmail.com;Fogadó Bertalan;AAA_Teszt_V2;hammy@dbx.hu;From;true;tanácsadó;DMS

Minta

Resend

Ebben a verzióban nem változott.

Resend V3

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

Web service API

Kérés

NévTípusLeírásKötelező
memberUuidStringA címzett UUID azonosítója.*
campaignPartContentUuidStringA kampányelem UUID azonosítója.*
requestMetaRequestMeta_V1A kéréshez tartozó metaadatok.*

Válasz

NévTípusLeírás
messageIdIntegerAz aktuális levél adatbázisbeli azonosítója.
statusResponseStatus_V1A válasz státusza.
paramsParam_V1 [ ]A szolgáltatás működését befolyásoló egyéb paraméterek listája.

Minta

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://hammy.dbx.hu/api/send/v4">
   <soapenv:Header/>
   <soapenv:Body>
      <v4:sendCampaignPart>
         <!--Optional:-->
         <request>
            <memberUuid>c47cebd3-c601-4a80-a920-a97850523ca6</memberUuid>
            <campaignPartContentUuid>ca326575-50e8-4034-81a0-fb1df1a9d106</campaignPartContentUuid>
            <!--Optional:-->
            <requestMeta>
               <!--Optional:-->
               <clientHashKey>abc1236146c591897999</clientHashKey>
            </requestMeta>
         </request>
      </v4:sendCampaignPart>
   </soapenv:Body>
</soapenv:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/send/v4/sendCampaignPart

NévTípusLeírásKötelező
memberUuidStringA címzett UUID azonosítója.*
campaignPartContentUuidStringA kampányelem UUID azonosítója.*
requestMetaJRequestMeta_V1A kéréshez tartozó metaadatok.

Válasz

NévTípusLeírás
messageIdIntegerAz aktuális levél adatbázisbeli azonosítója. (vnd.api ID)
metaJMeta1A válaszhoz tartozó metainformációk.

Minta

POST /hammy/json/send/v1/send?clientHashKey={{clientHashKey}}&userName={{userName}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/json

{
    "memberUuid": "c47cebd3-c601-4a80-a920-a97850523ca6",
    "campaignPartContentUuid": "ca326575-50e8-4034-81a0-fb1df1a9d106"        
}

Utoljára frissítve

Ezen az oldalon

Ági

Szia, Ági vagyok, miben segíthetek?

Ági

Szia, Ági vagyok, miben segíthetek?