Send API V1

Send

Web service API

Kérés

Név	Típus	Leírás	Kötelező
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.	*
requestId	String	A kérés azonosítója a hívó oldalon.
batchId	String	A levélköteg azonosítója.
partnerRef	String	Partner azonosító.
messageType	String	A kérés típusa, értéke egy Hammy-ben létező levélsablon azonosítója.
messageTypeVersion	Integer	A levélhez tartozó template verziószáma.
mailSubject	String	Email tárgya. A mező, illetve a `messageType` egyidejűleg nem adható meg.
mailBody	String	Email szövege. A mező, illetve a `messageType` egyidejűleg nem adható meg.
mailHtmlBody	String	HTML email szövege. A mező, illetve a `messageType` típusa egyidejűleg nem adható meg.
recipientAddress	String	A címzett email címe.	*
recipientName	String	A címzett neve.	*
recipientAddressCC	String	A másolatot kapó személy email címe.
recipientNameCC	String	A másolatot kapó személy neve.
replyToAddress	String	A válasz-email címe.
replyToName	String	A válasz-email neve.
fromAddress	String	A küldő email címe.
fromName	String	A küldő neve.
bccAddress	String	Az email titkos másolatként kézbesítésre kerül.
xmlData	String	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.
channel	MessageChannel	Küldés csatornája.
userName	String	Felhasználó neve.
relatedMessageId	Integer	Kapcsolódó üzenet Id-ja.
campaignPartId	Integer	Kampány rész azonosító Id.
attachments	Attachment_V1 [ ]	A csatolmányokat tartalmazó lista.
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.
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

<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>?</clientHashKey>
            <recipientAddress>emailaddress@dbx.hu</recipientAddress>
            <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>?</clientHashKey>
                <requestId>123</requestId>
                <partnerRef>partner1234</partnerRef>
                <messageType>TEST.MAIL</messageType>
                <messageTypeVersion>1</messageTypeVersion>
                <recipientAddress>emailaddress@dbx.hu</recipientAddress>
                <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>?</clientHashKey>
                    <requestId>123</requestId>
                    <partnerRef>partner1234</partnerRef>
                    <messageType>TEST.MAIL</messageType>
                    <messageTypeVersion>1</messageTypeVersion>
                    <recipientAddress>emailaddress@dbx.hu</recipientAddress>
                    <recipientName>NAME</recipientName>
                    <ccRecipientAddress>cc_email_address@dbx.hu</ccRecipientAddress>
                    <ccRecipientName>CC NAME</ccRecipientName>
                    <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>
                    <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/">
    <S:Body>
        <ns2:sendMailResponse xmlns:ns2="http://send.api.hammy.dbx.hu/">
            <response>
                <messageId>18</messageId>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
            </response>
        </ns2:sendMailResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/send/v1/send

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

multipart név: message

Név	Típus	Leírás	Kötelező
requestMeta	JRequestMeta_V1	Metainformációk.
requestId	String	A kérés azonosítója a hívó oldalon. (vnd.api ID)
batchId	String	A levélköteg azonosítója.
partnerRef	String	Partner azonosító.
messageType	String	A kérés típusa, értéke egy Hammy-ben létező levélsablon azonosítója.
messageTypeVersion	Integer	A levélhez tartozó template verziószáma.
mailSubject	String	Email tárgya. A mező, illetve a `messageType` egyidejűleg nem adható meg.
mailBody	String	Email szövege. A mező, illetve a `messageType` egyidejűleg nem adható meg.
mailHtmlBody	String	HTML email szövege. A mező, illetve a `messageType` típusa egyidejűleg nem adható meg.
recipientAddress	String	A címzett email címe.
recipientName	String	A címzett neve.	*
ccRecipientAddress	String	A másolatot kapó személy email címe.
ccRecipientName	String	A másolatot kapó személy neve.
replyToAddress	String	A válasz-email címe.
replyToName	String	A válasz-email neve.
fromAddress	String	A küldő email címe.
fromName	String	A küldő neve.
bccAddress	String	Az email titkos másolatként kézbesítésre kerül.
xmlData	String	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.
channel	MessageChannel	Küldés csatornája.
relatedMessageId	Integer	Kapcsolódó üzenet Id-ja.
properties	JProperty1 [ ]	Az üzenethez tartozó egyéb adatok, metaadatok.
attachments	JAttachment2 [ ]	A csatolmányokat tartalmazó lista.

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)
meta	JMeta1	A válaszhoz tartozó metainformációk.

Minta

A lenti példa olyan emailre vonatkozik, amihez beküldött csatolmány tartozik. Ha csatolmány nélküli az email, akkor nem szükséges multipart üzenetet küldeni. Ebben az esetben a Content-Type header az application/vnd.api+json vagy az application/json valamelyike kell legyen, az üzenet body-ja pedig:

POST /hammy/json/send/v1/send?clientHashKey={{clientHashKey}}&userName={{userName}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
content-type: multipart/form-data; boundary={{boundary}}

{{boundary}}
Content-Disposition: form-data; name="message"
Content-Type: application/json

{
"data" : {
    "type" : "sendRequest",
    "id" : "dfjhdsfk",
    "attributes" : {
    "mailSubject" : "Teszt",
    "mailBody" : "TesztTesztTeszt",
    "recipientAddress" : "cimzett.neve@valahol.hu",
    "recipientName" : "Dr. Címzett Neve",
    "fromAddress" : "felado@valahonnan.com",
    "fromName" : "Fel Adó"
    },
    "relationships" : {
    "properties" : {
        "data" : [ ]
    },
    "attachments" : {
        "data" : [ {
        "type" : "attachments",
        "id" : "1"
        } ]
    }
    }
},
"included" : [ {
    "type" : "attachments",
    "id" : "1",
    "attributes" : {
    "fileName" : "image.png",
    "internalFileName" : "internal-image.png",
    "archivingExpected" : true,
    "certificationExpected" : false,
    "contentAvailable" : false,
    "attachmentRef" : "{{attachmentPartNev}}",
    "deleteSourceExpected" : false,
    "postableWithoutCertificate" : false
    },
    "relationships" : {
    "properties" : {
        "data" : [ {
        "type" : "properties",
        "id" : "1"
        }, {
        "type" : "properties",
        "id" : "2"
        }, {
        "type" : "properties",
        "id" : "3"
        } ]
    }
    }
}, {
    "type" : "properties",
    "id" : "3",
    "attributes" : {
    "key" : "ARCHIVE_RELATIVE_PATH",
    "value" : "/alma/",
    "isMetaData" : false
    }
}, {
    "type" : "properties",
    "id" : "2",
    "attributes" : {
    "key" : "ARCHIVE_TARGET",
    "value" : "FS",
    "isMetaData" : false
    }
}, {
    "type" : "properties",
    "id" : "1",
    "attributes" : {
    "key" : "ATTACHMENT_SOURCE",
    "value" : "INLINE",
    "isMetaData" : false
    }
} ]
}
{{boundary}}
Content-Disposition: form-data; name="{{attachmentPartNev}}"
Content-Type: application/octet-stream

[BINÁRIS TARTALOM]
{{boundary}}

HTTP/1.1 200 OK
Authorization: JWT {{jwtToken}}
Content-Type: application/vnd.api+json

{
"data" : {
    "type" : "sendResponse",
    "id" : "122",
    "attributes" : { }
},
"meta" : {
    "total" : null,
    "params" : [ ],
    "responseStatus" : {
    "code" : 0,
    "messages" : [ ]
    }
}
}

Resend

Web service API

Kérés

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.	*
messageId	Integer	Az aktuális levél adatbázisbeli azonosító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.
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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:send="http://send.api.hammy.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <send:resendMail>
            <request>
                <clientHashKey>aa87cd4bcd3445bbc4</clientHashKey>
                <recipientAddress>address@dbx.hu</recipientAddress>
                <messageId>1111</messageId>
                <properties>
                    <property>
                        <key>AKARMI_PROPERTY</key>
                        <value>egy valami</value>
                        <isMetaData>false</isMetaData>
                    </property>
                </properties>
            </request>
        </send:resendMail>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:resendMailResponse xmlns:ns2="http://send.api.hammy.dbx.hu/">
            <response>
                <messageId>2222</messageId>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
            </response>
        </ns2:resendMailResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/send/v1/resend

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. (vnd.api ID)
messageId	Integer	Az aktuális levél adatbázisbeli azonosítója.	*
recipientAddress	String (100)	A címzett email címe.
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)
meta	JMeta1	A válaszhoz tartozó metainformációk.

Minta

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

{
  "data": {
    "type": "resendRequest",
    "id": "akrami",
    "attributes": {
      "recipientAddress": "valaki.cime@valahol.com",
      "messageId": "{{messageId}}"
    },
    "relationships" : {
         "properties" : {
           "data" : [ {
             "type" : "properties",
             "id" : "1"
           }, {
             "type" : "properties",
             "id" : "2"
           }, {
             "type" : "properties",
             "id" : "3"
           } ]
         }
    }
  },
  "included" : [
     {
         "type" : "properties",
         "id" : "3",
         "attributes" : {
           "key" : "ALMA",
           "value" : "starking",
           "isMetaData" : false
         }
     }, {
         "type" : "properties",
         "id" : "2",
         "attributes" : {
           "key" : "KORTE",
           "value" : "villany",
           "isMetaData" : false
         }
     }, {
         "type" : "properties",
         "id" : "1",
         "attributes" : {
           "key" : "BARACK",
           "value" : "őszi",
           "isMetaData" : false
         }
     }
  ]
}

HTTP/1.1 200 OK
Authorization: JWT {{jwtToken}}
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "resendResponse",
        "attributes": {}
    },
    "meta": {
        "total": null,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Send API V1

Send

Web service API

Kérés

Válasz

Minta

REST API

Kérés

Válasz

Minta

Resend

Web service API

Kérés

Válasz

Minta

REST API

Kérés

Válasz

Minta

Ezen az oldalon

Szia, Ági vagyok, miben segíthetek?

Szia, Ági vagyok, miben segíthetek?