Send API V5

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év	Típus	Leírás	Kötelező
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója. Kérje az üzemeltetéstől.	*
requestId	String (150)	A kérés azonosítója a hívó oldalon.
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.
recipientPhoneNumber	String (50)	A címzett telefonszáma.	P
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.
recipientEmailAddress	String (100)	A címzett email címe.	E
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.
userName	String (100)	A felhasználó 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.
attachments	Attachment_V1 [ ]	A csatolmányokat tartalmazó lista.	A
properties	Property_V1 [ ]	Az üzenethez tartozó egyéb adatok, metaadatok.
params	Param_V1 [ ]	A szolgáltatás működését befolyásoló egyéb paraméterek listája.

Válasz

Név	Típus	Leírás
messageId	Integer	Az aktuális levél adatbázisbeli azonosítója.
messageUuid	String	Az aktuális levél uuid-ja.
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	A szolgáltatás működését befolyásoló egyéb paraméterek listája.

Minta

KérésKérés (sablon)Kérés (csatolmánnyal)Válasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:send="http://send.api.hammy.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <send:sendMail>
            <request>
                <clientHashKey>{{hashKey}}</clientHashKey>
                <recipientEmailAddress>emailaddress@dbx.hu</recipientEmailAddress>
                <recipientName>NAME</recipientName>
                <mailSubject>Teszt levél tárgy</mailSubject>
                <mailBody>Teszt levél szöveg</mailBody>
                <fromAddress>norepy@dbx.hu</fromAddress>
                <fromName>NAME</fromName>
                <xmlData>
                    &lt;DATA&gt;
                    &lt;contractNumber&gt;10000001&lt;/contractNumber&gt;
                    &lt;clientID&gt;9000001&lt;/clientID&gt;
                    &lt;/DATA&gt;
                </xmlData>
                <archivingExpected>false</archivingExpected>
                <certificationExpected>false</certificationExpected>
            </request>
        </send:sendMail>
    </soapenv:Body>
</soapenv:Envelope>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:send="http://send.api.hammy.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <send:sendMail>
            <request>
                <clientHashKey>{{hashKey}}</clientHashKey>
                <requestId>123</requestId>
                <partnerRef>partner1234</partnerRef>
                <messageType>AAA_Teszt_V1</messageType>
                <messageTypeVersion>1</messageTypeVersion>
                <recipientEmailAddress>teszt@dbx.hu</recipientEmailAddress>
                <recipientName>NAME</recipientName>
                <fromAddress>norepy@dbx.hu</fromAddress>
                <fromName>NAME</fromName>
                <xmlData>
                    &lt;DATA&gt;
                    &lt;contractNumber&gt;10000001&lt;/contractNumber&gt;
                    &lt;clientID&gt;9000001&lt;/clientID&gt;
                    &lt;/DATA&gt;
                </xmlData>
                <archivingExpected>false</archivingExpected>
                <certificationExpected>false</certificationExpected>
            </request>
        </send:sendMail>
    </soapenv:Body>
</soapenv:Envelope>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:send="http://send.api.hammy.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <send:sendMail>
            <request>
                <clientHashKey>{{hashKey}}</clientHashKey>
                <requestId>123</requestId>
                <partnerRef>partner1234</partnerRef>
                <messageType>AAA_Teszt_V1</messageType>
                <messageTypeVersion>1</messageTypeVersion>
                <recipientEmailAddress>bela.bacsi@dbx.hu</recipientEmailAddress>
                <recipientName>NAME</recipientName>
                <recipientEmailAddressCC>sajtos.macaroni@dbx.hu</recipientEmailAddressCC>
                <recipientNameCC>CC NAME</recipientNameCC>
                <fromAddress>noreply@dbx.hu</fromAddress>
                <fromName>NAME</fromName>
                <xmlData>
                    &lt;DATA&gt;
                    &lt;contractNumber&gt;10000001&lt;/contractNumber&gt;
                    &lt;clientID&gt;9000001&lt;/clientID&gt;
                    &lt;/DATA&gt;
                </xmlData>
                <archivingExpected>false</archivingExpected>
                <certificationExpected>false</certificationExpected>
                <attachments>
                    <attachment>
                        <fileName>minta.pdf</fileName>
                        <content>[base_64_content]</content>
                        <documentType>SAMPLE1</documentType>
                        <objectType>POLICY</objectType>
                        <objectRef>123456789</objectRef>
                        <archivingExpected>true</archivingExpected>
                        <certificationExpected>false</certificationExpected>
                        <deleteSourceExpected>false</deleteSourceExpected>
                        <postableWithoutCertificate>true</postableWithoutCertificate>
                        <properties>
                            <property>
                                <key>ATTACHMENT_SOURCE</key>
                                <value>INLINE</value>
                                <isMetaData>false</isMetaData>
                            </property>
                            <property>
                                <key>INTERNAL_FILE_NAME</key>
                                <value>test.pdf</value>
                                <isMetaData>false</isMetaData>
                            </property>
                            <property>
                                <key>SZERZODO_NEVE</key>
                                <value>Béla</value>
                                <isMetaData>true</isMetaData>
                            </property>
                            <property>
                                <key>ARCHIVE_TARGET</key>
                                <value>DMS</value>
                                <isMetaData>false</isMetaData>
                            </property>
                        </properties>
                    </attachment>
                </attachments>
                <properties>
                    <property>
                        <key>AKARMI_PROPERTY</key>
                        <value>egy valami</value>
                        <isMetaData>false</isMetaData>
                    </property>
                </properties>
            </request>
        </send:sendMail>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header/>
    <S:Body>
        <ns3:sendMailResponse xmlns:ns2="http://hammy.dbx.hu/api/send/v5" xmlns:ns3="http://send.api.hammy.dbx.hu/">
            <response>
                <messageId>13</messageId>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
            </response>
        </ns3:sendMailResponse>
    </S:Body>
</S:Envelope>

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é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	JAttachment4 [ ]	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é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

KérésVálasz

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

{ "batchId":null, "relatedMessageId":null, "campaignPartContentUuid":null, "messageType":"TESTSABLON", "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 } ] }

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

{ "meta": { "responseStatus": { "code": 0, "messages": [] }, "params": [] }, "messageUuid": "c6837292-3d71-4ad5-8de8-774554a5eaa3" }

Quick send

Ebben a verzióban nem változott.

Quick send V1

Resend

Web service

Kérés

POST hammy/json/send/v5/resend

Név	Típus	Leírás	Kötelező
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.	*
recipientAddress	String	A címzett email címe.
recipientPhoneNumber	String	A címzett telefonszáma.
messageId	Integer	Az aktuális levél adatbázisbeli azonosítója.
messageUuid	String	Az aktuális levél uuid-ja.
userName	String	A felhasználó neve.
properties	Property_V1 [ ]	Az üzenethez tartozó egyéb adatok, metaadatok.
params	Param_V1 [ ]	A szolgáltatás működését befolyásoló egyéb paraméterek listája.

Válasz

Név	Típus	Leírás
messageId	Integer	Az aktuális levél adatbázisbeli azonosítója.
messageUuid	String	Az aktuális levél uuid-ja.
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	A szolgáltatás működését befolyásoló egyéb paraméterek listája.

Minta

KérésVálasz

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" }

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

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