Hammy API

Send API V3

HammySend3API 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 a messageType egyidejűleg nem adható meg.
mailBodyString (CLOB)Email szövege. A mező, illetve a messageType egyidejűleg nem adható meg.
mailHtmlBodyString (CLOB)HTML email szövege. A mező, illetve a messageType 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 típusa.
userNameString (100)A felhasználó neve.
relatedMessageIdIntegerKapcsolódó üzenet azonosító.
campaignPartIdIntegerKapcsolódó kampány azonosító.
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


<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>aa87cd4bcd3445bbc4</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>

REST API

REST API Info

Kérés

POST hammy/json/send/v3/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. (vnd.api id)
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 feldolgozás iránya.
relatedMessageIdIntegerKapcsolodó üzenet Id.
campaignPartIdIntegerKapcsolodó kampány Id.
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.
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.
attachmentsJAttachment2A 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

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/vnd.api+json

{
  "data" : {
    "type" : "sendRequests",
    "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}}

Queue API minta

Resend

Web service API

Kérés

NévTípusLeírásKötelező
clientHashKeyStringA webszolgáltatást hívó kliens azonosítója.*
recipientAddressStringA címzett email címe.
recipientPhoneNumberStringA címzett telefonszáma.
messageIdIntegerAz aktuális levél adatbázisbeli azonosítója.
messageUuidStringAz aktuális levél uuid-ja.
userNameStringA felhasználó neve.
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/v3/resend

NévTípusLeírás
requestMetaJRequestMeta_V1Metainformációk.
requestIdString (150)A kérés azonosítója. (vnd.api ID)
messageIdIntegerAz aktuális levél adatbázisbeli azonosítója.
messageUuidStringAz aktuális levél uuid-ja.
recipientAddressString (100)A címzett email címe.
recipientPhoneNumberString (100)A címzett telefonszáma.
propertiesJProperty1 [ ]Az üzenethez tartozó egyéb adatok, 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

Queue

Queue-n keresztül is fogadjuk a kérést. Ez esetben a kötelező headerök a kérésnél:

Content-Type: application/xml
X-Client-Hash-Key: {{clientHashKey}}
X-Method-Name: Send_V2_Resend

Set message properties

Az üzenetekproperty-jeinek módosítását (létrehozás, változtatás, törlés) biztosító szolgáltatás.

Web service

Ez a szolgáltatás jelenleg csak Web service-n keresztül elérhető.

Property

Jelenleg csak bizonyos property-k módosítása engedélyezett.

Web service API

Kérés

Az üzenetet egyértelműen azonosító adatokból (messageId, messageUuid, messageHash) pontosan egy megadására van szükség!

NévTípusLeírásKötelező
clientHashKeyStringA webszolgáltatást hívó kliens azonosítója.*
userNameStringA felhasználó neve.
messageIdIntegerAz aktuális üzenet adatbázisbeli azonosítója.
messageUuidStringAz aktuális üzenet UUID azonosítója.
messsageHashStringAz aktuális üzenet hash azonosítója.
modificationPropertyModification_V1 [ ]A kívánt property módosítások.
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
propertiesProperty_V1 [ ]A módosított property-k.
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.

CREATE és UPDATE esetén a válaszban visszakapjuk a kérdéses property-ket az új értékeikkel, míg DELETE esetén nem kapunk vissza property-t.

Minta

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:send="http://send.api.hammy.dbx.hu/">
    <soapenv:Header />
    <soapenv:Body>
        <send:setMessageProperties>
            <request>
                <clientHashKey>{{kliens hash kulcs}}</clientHashKey>
                <messageId>{{üzenet ID}}</messageId>
                <modifications>
                    <modification>
                        <action>UPDATE</action>
                        <property>
                            <key>EMAIL_OPENED</key>
                            <value>NO</value>
                            <valueType>BOOLEAN</valueType>
                            <isMetaData>false</isMetaData>
                        </property>
                    </modification>
                </modifications>
            </request>
        </send:setMessageProperties>
    </soapenv:Body>
</soapenv:Envelope>

Set attachment properties

A csatolmányok property-jeinek módosítását (létrehozás, változtatás, törlés) biztosító szolgáltatás.

Web service

Ez a szolgáltatás jelenleg csak Web service-n keresztül elérhető.

Property

Jelenleg csak bizonyos property-k módosítása engedélyezett.

Web service API

Kérés

Az csatolmányt egyértelműen azonosító adatokból (attachmentId, attachmentUuid) pontosan egy megadására van szükség!

NévTípusLeírásKötelező
clientHashKeyStringA webszolgáltatást hívó kliens azonosítója.*
userNameStringA felhasználó neve.
attachmentIdIntegerAz aktuális csatolmány adatbázisbeli azonosítója.
attachmentUuidStringAz aktuális csatolmány UUID azonosítója.
modificationsPropertyModification_V1 [ ]A kívánt property módosítások.
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
propertiesProperty_V1 [ ]A módosított property-k.
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.

CREATE és UPDATE esetén a válaszban visszakapjuk a kérdéses property-ket az új értékeikkel, míg DELETE esetén nem kapunk vissza property-t.

Minta

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:send="http://send.api.hammy.dbx.hu/">
    <soapenv:Header />
    <soapenv:Body>
        <send:setAttachmentProperties>
            <request>
                <clientHashKey>{{kliens hash kulcs}}</clientHashKey>
                <attachmentId>{{csatolmány ID}}</attachmentId>
                <modifications>
                    <modification>
                        <action>UPDATE</action>
                        <property>
                            <key>ATTACHMENT_OPENED</key>
                            <value>NO</value>
                            <isMetaData>false</isMetaData>
                        </property>
                    </modification>
                </modifications>
            </request>
        </send:setAttachmentProperties>
    </soapenv:Body>
</soapenv:Envelope>

Utoljára frissítve

Ezen az oldalon

Ági

Szia, Ági vagyok, miben segíthetek?

Ági

Szia, Ági vagyok, miben segíthetek?