Query API V2

Find messages

Web service API

A findMessages hívás során különböző keresési feltételeknek megfelelő üzenetek adatait lehet lekérdezni.

Kérés

Név	Típus	Leírás	Kötelező
clientHashKey	String	A hívó kliens azonosítója.	*
messageTypes	String [ ]	Az üzenet típusok listája.
recipientName	String	A címzett neve.
recipientAddress	String	A címzett email címe.
partnerRef	String	Partner azonosító.
objectRef	String	A kapcsolódó objektum azonosítója (pl. szerződésszám).
objectType	String	A kapcsolódó objektum típusa (pl. számla).
batchId	String	Köteg azonosító.
createdAtFrom	DateTime	A keresési időintervallum kezdete.
createdAtTo	DateTime	A keresési időintervallum vége.
bouncedAtFrom	DateTime	A visszapattanási intervallum kezdete.
bouncedAtTo	DateTime	A visszapattanási intervallum vége.
fileName	String	A csatolmány neve.
internalFileName	String	A csatolmány belső rendszerben használt neve.
resultSize	Integer	A keresési találat maximális mérete Alapértelmezett értéke 20.
offset	Integer	A találati lista kezdete.
deliveryStatuses	String [ ]	Az üzenetek kézbesítési státuszai.
messageChannels	MessageChannel [ ]	Az üzenetek küldési csatornái.
properties	Property1 [ ]	Az üzenethez tartozó egyéb adatok, metaadatok.
params	Param_V1 [ ]	Egyéb metaadatok listája.
userName	String	Felhasználó név.
requestId	String	Külső üzenet küldési kérés azonosító.
itemId	String	Üzenethez kapcsolódó elem id.

Válasz

Név	Típus	Leírás
messages	TMessage2 [ ]	A Hammy-ben lévő levelek.
count	Integer	A találatok száma.
responseStatus	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Paraméterek listája.

Minta

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.service.query.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:findMessages>
                <request>
            <clientHashKey>?</clientHashKey>
            <messageTypes>
               <messageType>TESZT_GEN</messageType>
            </messageTypes>
            <resultSize>1</resultSize>
            <offset>0</offset>
         </request>
      </ws:findMessages>
   </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:findMessages2Response xmlns:ns2="http://ws.service.query.api.hammy.dbx.hu/">
         <response>
            <messages>
               <message>
                  <actualStatus>SENT</actualStatus>
                  <messageType>TESZT_GEN</messageType>
                  <recipientName>Teszt Elek</recipientName>
                  <recipientAddress>teszt@elek.hu</recipientAddress>
                  <messageId>21813</messageId>
                  <archivingExpected>false</archivingExpected>
                  <createdAt>2019-02-01T08:47:04.601+01:00</createdAt>
                  <sentAt>2019-02-01T08:47:06.332+01:00</sentAt>
                  <channel>EMAIL</channel>
                  <uuid>8436c99b-200f-4843-a246-f3afc78b33f6</uuid>
                  <properties>
                     <property>
                        <key>nyomtatvany_neve</key>
                        <value>Adatbekérő</value>
                        <isMetaData>true</isMetaData>
                     </property>
                     <property>
                        <key>SMTP_MESSAGE_ID</key>
                        <value>&lt;1549007226278.d38423fad76ed8f4d0370979aaddf7346c73a4ca.JavaMail.developer@dev></value>
                        <isMetaData>false</isMetaData>
                     </property>
                     <property>
                        <key>EML_FILE_URL</key>
                        <value>27/e6/27e6c2049428584118df490d4077c972d07a6fd4</value>
                        <isMetaData>false</isMetaData>
                     </property>
                  </properties>
                  <attachments>
                     <attachment>
                        <details>
                           <fileName>adatbekerő.pdf</fileName>
                           <archivingExpected>false</archivingExpected>
                           <certificationExpected>false</certificationExpected>
                           <contentAvailable>false</contentAvailable>
                           <id>22082</id>
                           <documentType>adatbekero</documentType>
                           <objectRef>123456789</objectRef>
                           <uuid>ab11ac81-dbce-4399-84d7-9cffbc96f55b</uuid>
                           <properties>
                              <property>
                                 <key>ATTACHMENT_SOURCE</key>
                                 <value>GENERATED</value>
                                 <isMetaData>false</isMetaData>
                              </property>
                              <property>
                                 <key>GENERATOR_TEMPLATE</key>
                                 <value>ADATBEKERO</value>
                                 <isMetaData>false</isMetaData>
                              </property>
                              <property>
                                 <key>fundMemberName</key>
                                 <value>Teszt Elek</value>
                                 <isMetaData>false</isMetaData>
                              </property>
                              <property>
                                 <key>postCity</key>
                                 <value>Budapest</value>
                                 <isMetaData>false</isMetaData>
                              </property>
                              <property>
                                 <key>postStreetAddress</key>
                                 <value>Rákosmezei vonatok útja 23</value>
                                 <isMetaData>false</isMetaData>
                              </property>
                              <property>
                                 <key>postZip</key>
                                 <value>1233</value>
                                 <isMetaData>false</isMetaData>
                              </property>
                              <property>
                                 <key>printCode</key>
                                 <value>EP-0101-BE-554</value>
                                 <isMetaData>false</isMetaData>
                              </property>
                              <property>
                                 <key>userName</key>
                                 <value>Kiss János</value>
                                 <isMetaData>false</isMetaData>
                              </property>
                              <property>
                                 <key>registrationNumber</key>
                                 <value>123456789</value>
                                 <isMetaData>false</isMetaData>
                              </property>
                              <property>
                                 <key>registrationDate</key>
                                 <value>2019.01.30.</value>
                                 <isMetaData>false</isMetaData>
                              </property>
                              <property>
                                 <key>memberID</key>
                                 <value>987654321</value>
                                 <isMetaData>false</isMetaData>
                              </property>
                              <property>
                                 <key>mainCity</key>
                                 <value>Lébény</value>
                                 <isMetaData>false</isMetaData>
                              </property>
                              <property>
                                 <key>mainStreetAddress</key>
                                 <value>Hunyadi utca 26.</value>
                                 <isMetaData>false</isMetaData>
                              </property>
                              <property>
                                 <key>mainZip</key>
                                 <value>9155</value>
                                 <isMetaData>false</isMetaData>
                              </property>
                              <property>
                                 <key>phoneNumber</key>
                                 <value>0696160162</value>
                                 <isMetaData>false</isMetaData>
                              </property>
                              <property>
                                 <key>mobilePhoneNumber</key>
                                 <value>+36308578502</value>
                                 <isMetaData>false</isMetaData>
                              </property>
                              <property>
                                 <key>emailAddress</key>
                                 <value>teszt.elek@gmail.com</value>
                                 <isMetaData>false</isMetaData>
                              </property>
                              <property>
                                 <key>errors.error</key>
                                 <value>A születési hely nincs megadva</value>
                                 <index>3</index>
                                 <isMetaData>false</isMetaData>
                              </property>
                              <property>
                                 <key>errors.error</key>
                                 <value>A dokumentum aláírás hiányos</value>
                                 <index>1</index>
                                 <isMetaData>false</isMetaData>
                              </property>
                              <property>
                                 <key>errors.thingsToDo</key>
                                 <value>Kérjük, szíveskedjen belépési nyilatkozatát aláírni és postai úton ismételten megküldeni részünkre.</value>
                                 <index>1</index>
                                 <isMetaData>false</isMetaData>
                              </property>
                              <property>
                                 <key>errors.error</key>
                                 <value>A dokumentum nem eredeti</value>
                                 <index>2</index>
                                 <isMetaData>false</isMetaData>
                              </property>
                              <property>
                                 <key>errors.thingsToDo</key>
                                 <value>Kérjük, küldje meg postai úton a belépési nyilatkozat eredeti, aláírt példányát.</value>
                                 <index>2</index>
                                 <isMetaData>false</isMetaData>
                              </property>
                           </properties>
                        </details>
                     </attachment>
                  </attachments>
                  <permissionShowList/>
                  <permissionListList/>
               </message>
            </messages>
            <count>22</count>
            <responseStatus>
               <code>0</code>
               <messages/>
            </responseStatus>
            <params/>
         </response>
      </ns2:findMessages2Response>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/query/v2/messages

POST hammy/json/query/v2/messages

GET esetén query paraméterként lehet megadni a mezőket, POST esetén a body-ban.

Paraméter/Név	Típus	Leírás
id	String	A kérés azonosítója. (vnd.api ID)
uuid	String	Az üzenet UUID-ja.
recipientName	String	A címzett neve.
recipientAddress	String	A címzett email címe.
recipientPhoneNumber	String	A címzett telefonszáma.
partnerRef	String	Partner azonosító.
objectRef	String	A kapcsolódó objektum azonosítója (pl. szerződésszám).
objectType	String	A kapcsolódó objektum típusa (pl. számla).
createdAtFrom	DateTime	A készítési dátum intervallum alja.
createdAtTo	DateTime	A készítési dátum intervallum teteje.
bouncedAtFrom	DateTime	A visszapattanási dátum intervallum alja.
bouncedAtTo	DateTime	A visszapattanási dátum intervallum teteje.
statusLastChangedAtFrom	DateTime	Az utolsó státuszváltozás dátum intervallum alja.
statusLastChangedAtTo	DateTime	Az utolsó státuszváltozás dátum intervallum teteje.
fileName	String	A csatolmány neve.
internalFileName	String	A csatolmány belső rendszerben használt neve.
requestId	String	A kérés azonosítója.
hash	String	Az üzenet hash-e.
itemId	Integer	A lekérdezendő üzenethez kapcsolódó Chaingun Item ID-ja.
opened	Boolean	Megnyitották-e az üzenetet.
locked	Boolean	Zárolt-e az üzenet.
showDeletedMessages	Boolean	A törölt üzenetek megjelenjenek-e a találatokban.
mailLinkTitle	String	Az üzenetben lévő link címe.
subject	String	Az üzenet tárgya.
messageTypes	String [ ]	Az üzenet típusok.
deliveryStatuses	String [ ]	Az üzenet kézbesítési státuszai.
archiveStatuses	ArchiveStatus [ ]	Az üzenet archiválási státuszai.
extendedStatuses	String [ ]	Kiterjesztett státuszok, csatorna specifikus állapotokról hordoznak információt.
channels	String [ ]	Az keresett üzenetek csatornái.
directions	MessageDirection [ ]	Küldés irányai.
properties	JProperty1 [ ]	Az üzenethez tartozó egyéb adatok, metaadatok.
limit	Integer	A keresési találatok maximális száma.
offset	Integer	A találati lista kezdete (pl. resultSize = 10 és offset = 1, akkor a teljes találati lista 11. elemétől a 20. eleméig tartó listát adja vissza).
sort	String	Rendezés.
clientHashKey	String	A hívó kliens azonosítója.
userName	String	A felhasználó neve.
scenarioDefIds	String	Az üzenethez tartozó szcenárió azonosítója.
campaignIds	String	Az üzenethez tartozó kampány azonosítója(uuid).
campaignPartIds	String	Az üzenethez tartozó kampányelem azonosítója(uuid).
params	Param_V1 [ ]	Egyéb meta adatok.

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
list	JMessage2 [ ]	Megtalált üzenetek listája.

Minta

GET /hammy/json/query/v2/messages?limit=2
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": [
    {
      "type": "messages",
      "id": "45438678",
      "attributes": {
        "actualStatus": "SENT",
        "statusLastChangedAt": "2024-06-04T15:12:44.173+02:00",
        "messageType": "TESZT_SABLON",
        "recipientAddress": "teszt5@teszt.hu",
        "archivingExpected": false,
        "createdAt": "2024-06-04T15:12:42.651+02:00",
        "sentAt": "2024-06-04T15:12:44.173+02:00",
        "subject": "Teszt szöveg",
        "fromAddress": "noreply@dbx.hu",
        "fromName": "Feladó",
        "permissionShow": [],
        "permissionList": [],
        "channel": "EMAIL",
        "uuid": "25f90a98-1408-407d-af12-32ca226dad42",
        "replyEnvelopAttached": false,
        "paymentSlipAttached": false,
        "errorEventId": "571786039",
        "errorEventCode": "TECHNICAL_ERROR",
        "errorEventName": "TECHNICAL_ERROR",
        "errorEventDescription": "hu.dbx.chaingun.util.taskchain.TaskException: hu.dbx.chaingun.util.taskchain.TaskException: The server sent HTTP status code 502: Bad Gateway"
      },
      "relationships": {
        "attachments": {
          "data": [
            {
              "type": "attachments",
              "id": "37905908"
            }
          ]
        },
        "properties": {
          "data": [
            {
              "type": "properties",
              "id": "529042251"
            },
            {
              "type": "properties",
              "id": "529042252"
            }
          ]
        },
        "bounces": {
          "data": []
        }
      }
    },
    {
      "type": "messages",
      "id": "45438677",
      "attributes": {
        "actualStatus": "ERROR",
        "statusLastChangedAt": "2024-06-04T13:04:35.013+02:00",
        "messageType": "TESZT_SABLON",
        "recipientAddress": "teszt4@teszt.hu",
        "archivingExpected": false,
        "createdAt": "2024-06-04T13:04:33.899+02:00",
        "subject": "Teszt szöveg",
        "permissionShow": [],
        "permissionList": [],
        "channel": "EMAIL",
        "uuid": "b54c0690-b864-4fa3-9ce0-e0bcb1c3a407",
        "replyEnvelopAttached": false,
        "paymentSlipAttached": false,
        "errorEventId": "571785940",
        "errorEventCode": "TECHNICAL_ERROR",
        "errorEventName": "TECHNICAL_ERROR",
        "errorEventDescription": "hu.dbx.chaingun.util.taskchain.TaskException: hu.dbx.hammy.model.exception.SMTPException: Unable to send message to SMTP server!"
      },
      "relationships": {
        "attachments": {
          "data": []
        },
        "properties": {
          "data": [
            {
              "type": "properties",
              "id": "529042246"
            }
          ]
        },
        "bounces": {
          "data": []
        }
      }
    }
  ],
  "meta": {
    "total": 8505,
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  },
  "included": [
    {
      "type": "properties",
      "id": "529042248",
      "attributes": {
        "key": "ATTACHMENT_SOURCE",
        "value": "INLINE",
        "isMetaData": false
      }
    },
    {
      "type": "properties",
      "id": "529042249",
      "attributes": {
        "key": "ARCHIVE_TARGET",
        "value": "DMS",
        "isMetaData": false
      }
    },
    {
      "type": "properties",
      "id": "529042250",
      "attributes": {
        "key": "ATTACHMENT_CONTENT_CHECKSUM",
        "value": "d93d330fc76dda672f202ed042c0ec6eb5548c74d7bffe7fe3a818d815b71104a91509dc6640682bd48f9207e7731a5a7172046b85f1ef3bb541d69ca1385e87",
        "isMetaData": false
      }
    },
    {
      "type": "attachments",
      "id": "37905908",
      "attributes": {
        "fileName": "TesztPDF_duplicate.docx",
        "archivingExpected": true,
        "certificationExpected": false,
        "contentAvailable": true,
        "documentType": "ATTACHMENT",
        "uuid": "c56c9b0f-4d0a-45d9-9e1e-de58d436a9ff"
      },
      "relationships": {
        "properties": {
          "data": [
            {
              "type": "properties",
              "id": "529042248"
            },
            {
              "type": "properties",
              "id": "529042249"
            },
            {
              "type": "properties",
              "id": "529042250"
            }
          ]
        }
      }
    },
    {
      "type": "properties",
      "id": "529042251",
      "attributes": {
        "key": "TRACKING_MODE",
        "value": "ALL",
        "isMetaData": false
      }
    },
    {
      "type": "properties",
      "id": "529042252",
      "attributes": {
        "key": "SMTP_MESSAGE_ID",
        "value": "<1555158973.12.1717506763980@localhost>",
        "isMetaData": false
      }
    },
    {
      "type": "properties",
      "id": "529042246",
      "attributes": {
        "key": "TEST_MAIL",
        "value": "YES",
        "isMetaData": false
      }
    }
  ]
}

Show message

Üzenet megtekintése az üzenet azonosítója alapján.

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.	*
messageId	Integer	Az keresett levél adatbázisbeli azonosítója.	*
userName	String	A felhasználó neve.	*

Válasz

Név	Típus	Leírás
actualStatus	String	Az aktuális státusz.
statusLastChangedAt	DateTime	A státusz módosulásának ideje.
messageType	String	A kérés típusa. Értéke egy Hammy-ben létező levélsablon azonosítója.
recipientName	String	A címzett neve.
recipientAddress	String	A címzett e-mail címe.
partnerRef	String	Partner azonosító.
archivingExpected	Boolean	`true` esetén a levél tárgya és szövege archiválódik.
subject	String	A levél tárgya.
body	String	A levél szövege.
htmlBody	String	Email HTML szövege.
createdAt	DateTime	A létrehozás ideje.
sentAt	DateTime	Az elküldés ideje.
bouncedAt	DateTime	Az üzenet visszapattanásának ideje.
movedToArchivedAt	Date	Archiválás időpontja.
boundReasonCode	String	Az üzenet visszapattanásának oka.
boundReasonDescription	String	A visszapattanás okának leírása.
boundMailText	String	A visszapattanó levél szövege.
boundList	JBounce1 [ ]	Visszapattanások (`<bound>` tagek között).
bccAddress	String	Titkos másolat címe.
properties	Property1 [ ]	Az üzenethez tartozó egyéb adatok, metaadatok.
attachments	AttachmentWithoutContent2 [ ]	Az üzenethez tartozó csatolmányok.
responseStatus	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek.
replyToAddress	String	Címzett címe.
replyToName	String	Címzett neve.
fromAddress	String	Feladó neve.
fromName	String	Feladó címe.
ccRecipientAddress	String	Másolatot kapó címzett címe.
ccRecipientName	String	Másolatot kapó címzett neve.
mailServerLog	String	Szerver log.
channel	MessageChannel	Üzenetküldési csatorna.
uuid	String	Az üzenet uuid-ja.

Minta

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.service.query.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:showMessage>
         <request>
            <clientHashKey>?</clientHashKey>
            <messageId>21566</messageId>
            <userName>?</userName>
         </request>
      </ws:showMessage>
   </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:showMessage2Response xmlns:ns2="http://ws.service.query.api.hammy.dbx.hu/">
         <response>
            <actualStatus>SENT</actualStatus>
            <statusLastChangedAt>2018-09-12T22:48:48.860+02:00</statusLastChangedAt>
            <messageType>351.E</messageType>
            <recipientName>Teszt Elek</recipientName>
            <recipientAddress>teszt@elek.hu</recipientAddress>
            <archivingExpected>false</archivingExpected>
            <subject>ures subject</subject>
            <body>ures body</body>
            <htmlBody>ures html body</htmlBody>
            <createdAt>2018-09-12T21:20:25.106+02:00</createdAt>
            <properties>
               <property>
                  <key>SKIP_DELIVERY</key>
                  <value>NO</value>
                  <isMetaData>false</isMetaData>
               </property>
            </properties>
            <attachments/>
            <responseStatus>
               <code>0</code>
               <messages/>
            </responseStatus>
            <channel>EMAIL</channel>
            <uuid>0bb920c1-7ca8-44cf-a3ea-f5d1d5907abe</uuid>
         </response>
      </ns2:showMessage2Response>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/query/v2/messages/{{id}}

Név	Típus	Leírás
id	Integer	Az keresett levél adatbázisbeli azonosítója. (vnd.api id)
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.
userName	String	A felhasználó neve.

Válasz

Típus	Leírás
JMessage2	Megtalált üzenet.

Minta

GET /hammy/json/query/v2/messages/{{ID}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "messages",
        "id": {{ID}},
        "attributes": {
            "actualStatus": "SENT",
            "statusLastChangedAt": "2019-01-29T14:08:41.927+0000",
            "messageType": "351.DI",
            "recipientName": "Teszt Előd",
            "recipientAddress": "teszt@elek.hu",
            "archivingExpected": false,
            "createdAt": "2019-01-29T14:03:57.302+0000",
            "sentAt": "2019-01-29T14:08:41.379+0000",
            "subject": "Értesítés dokumentum érkezéséről",
            "htmlBody": "<html><head><meta http-equiv=\"Content-type\" content=\"text/html; charset=utf-8\"/></head><body><p>Tisztelt TEszt Elek!</p><p>Ezúton küldjük Önnek a <strong>123456789 szerződésszámú biztosításához</strong> kapcsolódó teszt kötvény című dokumentumot.<br/>A dokumentumot levelünkhöz mellékelten küldjük. (Megnyitásához Adobe Acrobat Reader program szükséges, amely az alábbi linkről letölthető: <a href=\"javascript:alert('http://get.adobe.com/reader/');\" target=\"_blank\">http://get.adobe.com/reader/</a> )<br/>Kérjük, hogy a dokumentumot őrizze meg!</p<p>Üdvözlettel:<br/>DBX Kft.</p><p><a href=\"javascript:alert('http://www.dbx.hu/');\" target=\"_blank\">http://www.dbx.hu/</a></p></body></html>",
            "replyToAddress": "noreply@dbx.hu",
            "replyToName": "${mail.reply.personal}",
            "fromAddress": "noreply@dbx.hu",
            "fromName": "Feladó",
            "permissionShow": [],
            "permissionList": []
        },
        "relationships": {
            "attachments": {
                "data": [
                    {
                        "type": "attachments",
                        "id": "22029"
                    }
                ]
            },
            "properties": {
                "data": [
                    {
                        "type": "properties",
                        "id": "360794"
                    },
                    {
                        "type": "properties",
                        "id": "360795"
                    },
                    {
                        "type": "properties",
                        "id": "360770"
                    },
                    {
                        "type": "properties",
                        "id": "360771"
                    },
                    {
                        "type": "properties",
                        "id": "360772"
                    },
                    {
                        "type": "properties",
                        "id": "360773"
                    },
                    {
                        "type": "properties",
                        "id": "360774"
                    }
                ]
            },
            "bounces": {
                "data": []
            }
        }
    },
    "included": [
        {
            "type": "properties",
            "id": "360774",
            "attributes": {
                "key": "address.zip",
                "value": "1174",
                "isMetaData": true
            }
        },
        {
            "type": "properties",
            "id": "360767",
            "attributes": {
                "key": "ATTACHMENT_SOURCE",
                "value": "GENERATED",
                "isMetaData": false
            }
        },
        {
            "type": "properties",
            "id": "360770",
            "attributes": {
                "key": "NYOMT_NEV",
                "value": "teszt kötvény",
                "isMetaData": true
            }
        },
        {
            "type": "properties",
            "id": "360769",
            "attributes": {
                "key": "NEV",
                "value": "Teszt Előd",
                "isMetaData": false
            }
        },
        {
            "type": "attachments",
            "id": "22029",
            "attributes": {
                "fileName": "kotveny.pdf",
                "archivingExpected": false,
                "certificationExpected": false,
                "contentAvailable": false,
                "documentType": "kotveny",
                "objectRef": "123456789"
            },
            "relationships": {
                "properties": {
                    "data": [
                        {
                            "type": "properties",
                            "id": "360767"
                        },
                        {
                            "type": "properties",
                            "id": "360768"
                        },
                        {
                            "type": "properties",
                            "id": "360769"
                        }
                    ]
                }
            }
        },
        {
            "type": "properties",
            "id": "360795",
            "attributes": {
                "key": "EML_FILE_URL",
                "value": "28/43/2843c6846dbea059c6688a47a613a71b971e1ed7",
                "isMetaData": false
            }
        },
        {
            "type": "properties",
            "id": "360768",
            "attributes": {
                "key": "GENERATOR_TEMPLATE",
                "value": "TESZT_GEN",
                "isMetaData": false
            }
        },
        {
            "type": "properties",
            "id": "360772",
            "attributes": {
                "key": "address.streetAddress",
                "value": "Rákosmezei Vonatok útja 13",
                "isMetaData": true
            }
        },
        {
            "type": "properties",
            "id": "360794",
            "attributes": {
                "key": "SMTP_MESSAGE_ID",
                "value": "<1548770921316.05d811ade9257c4a35633ef81e2f342d8394da95.JavaMail.developer@dev>",
                "isMetaData": false
            }
        },
        {
            "type": "properties",
            "id": "360771",
            "attributes": {
                "key": "address.name",
                "value": "Teszt Elek",
                "isMetaData": true
            }
        },
        {
            "type": "properties",
            "id": "360773",
            "attributes": {
                "key": "address.city",
                "value": "Budapest",
                "isMetaData": true
            }
        }
    ],
    "meta": {
        "total": null,
        "responseStatus": {
            "code": 0,
            "messages": []
        },
        "params": []
    }
}

Find events

Ebben a verzióban nem változott.

Find events V1

Find properties

Ebben a verzióban nem változott.

Find properties V1

List error queues

Hibasorok listázása.

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.	*
userName	String	A felhasználó neve.
queueName	String	A sor neve.
messageType	String	Üzenet típusa.
errorMessage	String	Hibaüzenet.
limit	Integer	Megjelenítendő üzenetek száma.
offset	Integer	A találati lista kezdete.

Válasz

Név	Típus	Leírás
count	Integer	Sorok száma.
errorQueueList	ErrorQueue2 [ ]	Hibaüzenet sorok.
params	Param_V1 [ ]	A szolgáltatás működését befolyásoló egyéb paraméterek listája.
responseStatus	ResponseStatus_V1	A válasz státusza.

Minta

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.service.query.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:listErrorQueues>
         <request>
            <clientHashKey>?</clientHashKey>
            <limit>2</limit>
            <offset>0</offset>
            <userName>?</userName>
         </request>
      </ws:listErrorQueues>
   </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:listErrorQueues2Response xmlns:ns2="http://ws.service.query.api.hammy.dbx.hu/">
         <response>
            <count>35</count>
            <errorQueueList>
               <errorQueue>
                  <queueName>archiveQueueError</queueName>
                  <messageType>351.DI</messageType>
                  <errorMessage>java.lang.RuntimeException: hu.dbx.chaingun.util.taskchain.TaskException: com.sun.xml.ws.client.ClientTransportException: HTTP transport error: java.net.ConnectException: Connection refused</errorMessage>
                  <errorMinDate>2018-01-25T20:16:47.580+01:00</errorMinDate>
                  <errorMaxDate>2019-01-04T11:02:44.227+01:00</errorMaxDate>
                  <count>21</count>
                  <skippedError>false</skippedError>
               </errorQueue>
               <errorQueue>
                  <errorMessage>hu.dbx.chaingun.util.taskchain.TaskException: Destination Queue not found</errorMessage>
                  <skippedError>false</skippedError>
                  <skippedErrorType>
                     <id>81</id>
                  </skippedErrorType>
                  <skippedParamList/>
               </errorQueue>
               <errorQueue>
                  <errorMessage>hu.dbx.hammy.model.exception.SMTPException: Unable to send message to SMTP server!</errorMessage>
                  <skippedError>false</skippedError>
                  <skippedErrorType>
                     <id>63</id>
                  </skippedErrorType>
                  <skippedParamList/>
               </errorQueue>
            </errorQueueList>
            <responseStatus>
               <code>0</code>
               <messages/>
            </responseStatus>
         </response>
      </ns2:listErrorQueues2Response>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/query/v2/errorQueues

Név	Típus	Leírás
id	String	A kérés azonosítója. (vnd.api ID)
queueName	String	A sor neve.
messageType	String	Üzenet típusa.
errorMessage	String	Hibaüzenet.
limit	Integer	Megjelenítendő üzenetek száma.
offset	Integer	A találati lista kezdete.
sort	String	Rendezés.
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.
userName	String	A felhasználó neve.
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
meta	JListMeta1	A válaszhoz tartozó metaadatok.
list	JErrorQueue2 [ ]	Megtalált hibasorok listája.

Minta

POST /hammy/json/query/v2/errorQueues
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
  "data" : {
    "id" : "00000",
    "type" : "listErrorQueuesRequests",
    "attributes" : {
    	"limit" : 2,
    	"offset" : 0
    }
  }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": [
        {
            "type": "errorQueue",
            "attributes": {
                "queueName": "archiveQueueError",
                "messageType": "351.DI",
                "errorMessage": "java.lang.RuntimeException: hu.dbx.chaingun.util.taskchain.TaskException: com.sun.xml.ws.client.ClientTransportException: HTTP transport error: java.net.ConnectException: Connection refused",
                "errorMinDate": "2018-01-25T19:16:47.580+0000",
                "errorMaxDate": "2019-01-04T10:02:44.227+0000",
                "count": 21,
                "ignoreError": false
            }
        },
        {
            "type": "errorQueue",
            "attributes": {
                "errorMessage": "hu.dbx.chaingun.util.taskchain.TaskException: Destination Queue not found",
                "ignoreError": false,
                "errorType": {
                    "id": 81
                },
                "configParams": {
                    "cgParam": []
                }
            }
        },
        {
            "type": "errorQueue",
            "attributes": {
                "errorMessage": "hu.dbx.hammy.model.exception.SMTPException: Unable to send message to SMTP server!",
                "ignoreError": false,
                "errorType": {
                    "id": 63
                },
                "configParams": {
                    "cgParam": []
                }
            }
        }
    ],
    "meta": {
        "total": 35,
        "responseStatus": {
            "code": 0,
            "messages": []
        },
        "params": []
    }
}

List error queue items

Hiba sor elemeinek listázása.

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.	*
queueName	String	Sor neve.
userName	String	A felhasználó neve.	*
messageType	String	Üzenet típusa.
errorMessage	String	Hibaüzenet.
limit	Integer	Megjelenítendő üzenetek száma.
offset	Integer	A találati lista kezdete.
mailRecipientAddress	String	Az címzet címe.

Válasz

Név	Típus	Leírás
errorQueueItemList	ErrorQueueItem_V1 [ ]	Hibasor elemei.
responseStatus	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.
count	Integer	Mennyiség.

Minta

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:quer="http://query.api.hammy.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <quer:listErrorQueueItems>
            <request>
                <clientHashKey>?</clientHashKey>
                <errorMessage>Caught exception during notifying client!</errorMessage>
                <limit>2</limit>
                <offset>4</offset>
                <queueName>notificationQueueError</queueName>
                <userName>?</userName>
            </request>
        </quer:listErrorQueueItems>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:listErrorQueueItemsResponse xmlns:ns2="http://query.api.hammy.dbx.hu/">
         <response>
            <count>169</count>
            <errorQueueItemList>
               <errorQueueItem>
                  <queueName>notificationQueueError</queueName>
                  <messageType>351.DI</messageType>
                  <recipientAddress>teszt@elek.hu</recipientAddress>
                  <errorDate>2018-01-29T21:47:55.221+01:00</errorDate>
                  <errorMessage>Caught exception during notifying client!</errorMessage>
                  <jmsMessageId>ID:dev-13039-1517258683899-1:1972:1:1:1</jmsMessageId>
                  <itemId>31039</itemId>
               </errorQueueItem>
               <errorQueueItem>
                  <queueName>notificationQueueError</queueName>
                  <messageType>351.DI</messageType>
                  <recipientAddress>teszt@elek.hu</recipientAddress>
                  <errorDate>2018-01-29T21:50:02.786+01:00</errorDate>
                  <errorMessage>Caught exception during notifying client!</errorMessage>
                  <jmsMessageId>ID:dev-13039-1517258683899-1:3246:1:1:1</jmsMessageId>
                  <itemId>31040</itemId>
               </errorQueueItem>
            </errorQueueItemList>
            <responseStatus>
               <code>0</code>
               <messages/>
            </responseStatus>
         </response>
      </ns2:listErrorQueueItemsResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/query/v2/errorQueueItems

Paraméter/Név	Típus	Leírás
id	String	A kérés azonosítója. (vnd.api ID)
queueName	String	A sor neve.
messageType	String	Üzenet típusa.
errorMessage	String	Hibaüzenet.
mailRecipientAddress	String	A címzett címe.
limit	Integer	Megjelenítendő üzenetek száma.
offset	Integer	A találati lista kezdete.
sort	String	Rendezés.
clientHashKey	String	A webszolgáltatást hívó kliens azonosítója.
userName	String	A felhasználó neve.
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
meta	JListMeta1	A válaszhoz tartozó metaadatok.
list	JErrorQueueItem1 [ ]	Megtalált hibasorok listája.

Minta

POST /hammy/json/query/v2/errorQueueItems
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
  "data" : {
    "id" : "00000",
    "type" : "listErrorQueueItemsRequests",
    "attributes" : {
    	"limit" : 2,
    	"offset" : 4,
    	"queueName" : "notificationQueueError",
    	"errorMessage" : "Caught exception during notifying client!"
    }
  }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": [
        {
            "type": "errorQueueItem",
            "attributes": {
                "queueName": "notificationQueueError",
                "messageType": "351.DI",
                "recipientAddress": "teszt@elek.hu",
                "errorDate": "2018-01-29T20:47:55.221+0000",
                "errorMessage": "Caught exception during notifying client!",
                "jmsMessageId": "ID:dev-13039-1517258683899-1:1972:1:1:1",
                "itemId": 31039
            }
        },
        {
            "type": "errorQueueItem",
            "attributes": {
                "queueName": "notificationQueueError",
                "messageType": "351.DI",
                "recipientAddress": "teszt@elek.hu",
                "errorDate": "2018-01-29T20:50:02.786+0000",
                "errorMessage": "Caught exception during notifying client!",
                "jmsMessageId": "ID:dev-13039-1517258683899-1:3246:1:1:1",
                "itemId": 31040
            }
        }
    ],
    "meta": {
        "total": 169,
        "responseStatus": {
            "code": 0,
            "messages": []
        },
        "params": []
    }
}

Show attachment

Csatolmány lekérése csatolmány azonosító alapján.

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.	*
attachmentId	Integer	A csatolmány azonosítója.
userName	String	A felhasználó neve.	*

Válasz

Név	Típus	Leírás
attachment	AttachmentWithContent2	Csatolmány.
responseStatus	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.

Minta

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.service.query.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:showAttachment>
         <request>
            <clientHashKey>?</clientHashKey>
            <attachmentId>?</attachmentId>
         </request>
      </ws:showAttachment>
   </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:showAttachment2Response xmlns:ns2="http://ws.service.query.api.hammy.dbx.hu/">
         <response>
            <attachment>
               <details>
                  <fileName>teszt.pdf</fileName>
                  <archivingExpected>true</archivingExpected>
                  <certificationExpected>false</certificationExpected>
                  <contentAvailable>false</contentAvailable>
                  <id>21818</id>
                  <documentType>kotveny</documentType>
                  <uuid>558e5826-3d22-44d6-b86f-2fcc27d5a149</uuid>
                  <properties>
                     <property>
                        <key>ATTACHMENT_SOURCE</key>
                        <value>INLINE</value>
                        <isMetaData>false</isMetaData>
                     </property>
                     <property>
                        <key>ARCHIVE_TARGET</key>
                        <value>FS</value>
                        <isMetaData>false</isMetaData>
                     </property>
                     <property>
                        <key>ARCHIVE_RELATIVE_PATH</key>
                        <value>mittom</value>
                        <isMetaData>false</isMetaData>
                     </property>
                     <property>
                        <key>UGYFELAZONOSITO</key>
                        <value>822577102</value>
                        <isMetaData>false</isMetaData>
                     </property>
                     <property>
                        <key>NEV</key>
                        <value>Teszt Elek</value>
                        <isMetaData>false</isMetaData>
                     </property>
                  </properties>
               </details>
            </attachment>
            <responseStatus>
               <code>0</code>
               <messages>
                  <message>
                     <severity>WARNING</severity>
                     <code>HAMMY_VE0055</code>
                     <description>A csatolmány tartalma nem elérhető!</description>
                  </message>
               </messages>
            </responseStatus>
         </response>
      </ns2:showAttachment2Response>
   </S:Body>
</S:Envelope>

REST API

REST API Info

REST API-n a csatolmányokat application/octet-stream-ként lehet letölteni.

Letöltés csatolmány ID alapján

GET hammy/json/query/v2/attachmentContents/{{attachmentId}}

Letöltés csatolmány UUID alapján.

GET hammy/json/query/v2/attachmentContents/uuid/{{uuid}}

Check email address

Ebben a verzióban nem változott.

Check email address V1

Show message by UUID

Üzenet lekérése UUID alapján.

REST API

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

REST API

REST API Info

Kérés

GET hammy/json/query/v1/messages/uuid/{{UUID}}

Név	Típus	Leírás
uuid	String	A keresett üzenet uuid-ja.

Válasz

Típus	Leírás
JMessage2	Megtalált üzenet.

GET /hammy/json/query/v2/messages/uuid/{{UUID}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "messages",
        "id": "21773",
        "attributes": {
            "actualStatus": "SENT",
            "statusLastChangedAt": "2019-01-30T11:14:11.322+0000",
            "messageType": "TESZT_GEN",
            "recipientName": "Teszt Elek",
            "recipientAddress": "teszt@elek.hu",
            "archivingExpected": false,
            "createdAt": "2019-01-30T11:14:06.007+0000",
            "sentAt": "2019-01-30T11:14:11.168+0000",
            "subject": "Targy mezo",
            "body": "Torzsi mezo",
            "htmlBody": "<html><head><meta http-equiv=\"Content-type\" content=\"text/html; charset=utf-8\"/></head><body><p>Torzsi mezo</p>\n</body></html>",
            "replyToAddress": "noreply@dbx.hu",
            "replyToName": "${mail.reply.personal}",
            "fromAddress": "noreply@dbx.hu",
            "fromName": "Feladó",
            "permissionShow": [],
            "permissionList": []
        },
        "relationships": {
            "attachments": {
                "data": [
                    {
                        "type": "attachments",
                        "id": "22042"
                    }
                ]
            },
            "properties": {
                "data": [
                    {
                        "type": "properties",
                        "id": "360919"
                    },
                    {
                        "type": "properties",
                        "id": "360920"
                    },
                    {
                        "type": "properties",
                        "id": "360913"
                    },
                    {
                        "type": "properties",
                        "id": "360914"
                    },
                    {
                        "type": "properties",
                        "id": "360915"
                    },
                    {
                        "type": "properties",
                        "id": "360916"
                    },
                    {
                        "type": "properties",
                        "id": "360917"
                    },
                    {
                        "type": "properties",
                        "id": "360918"
                    }
                ]
            },
            "bounces": {
                "data": []
            }
        }
    },
    "included": [
        {
            "type": "properties",
            "id": "360910",
            "attributes": {
                "key": "ATTACHMENT_SOURCE",
                "value": "GENERATED",
                "isMetaData": false
            }
        },
        {
            "type": "properties",
            "id": "360914",
            "attributes": {
                "key": "address.name",
                "value": "Teszt Elek",
                "isMetaData": true
            }
        },
        {
            "type": "properties",
            "id": "360915",
            "attributes": {
                "key": "address.streetAddress",
                "value": "Bem rakpart 56",
                "isMetaData": true
            }
        },
        {
            "type": "properties",
            "id": "360912",
            "attributes": {
                "key": "NEV",
                "value": "Teszt Előd",
                "isMetaData": false
            }
        },
        {
            "type": "properties",
            "id": "360917",
            "attributes": {
                "key": "address.zip",
                "value": "1021",
                "isMetaData": true
            }
        },
        {
            "type": "properties",
            "id": "360916",
            "attributes": {
                "key": "address.city",
                "value": "Budapest",
                "isMetaData": true
            }
        },
        {
            "type": "properties",
            "id": "360919",
            "attributes": {
                "key": "SMTP_MESSAGE_ID",
                "value": "<1548846851133.1204f7a774355cb93665f7bee1088414cf825233.JavaMail.developer@dev>",
                "isMetaData": false
            }
        },
        {
            "type": "properties",
            "id": "360913",
            "attributes": {
                "key": "NYOMT_NEV",
                "value": "Kötvény",
                "isMetaData": true
            }
        },
        {
            "type": "attachments",
            "id": "22042",
            "attributes": {
                "fileName": "kotveny.pdf",
                "archivingExpected": false,
                "certificationExpected": false,
                "contentAvailable": false,
                "documentType": "kotveny",
                "objectRef": "123456789"
            },
            "relationships": {
                "properties": {
                    "data": [
                        {
                            "type": "properties",
                            "id": "360910"
                        },
                        {
                            "type": "properties",
                            "id": "360911"
                        },
                        {
                            "type": "properties",
                            "id": "360912"
                        }
                    ]
                }
            }
        },
        {
            "type": "properties",
            "id": "360918",
            "attributes": {
                "key": "actualDate",
                "value": "2019.01.29",
                "isMetaData": true
            }
        },
        {
            "type": "properties",
            "id": "360911",
            "attributes": {
                "key": "GENERATOR_TEMPLATE",
                "value": "TESZT_GEN_FULI",
                "isMetaData": false
            }
        },
        {
            "type": "properties",
            "id": "360920",
            "attributes": {
                "key": "EML_FILE_URL",
                "value": "ee/6c/ee6c22b90bf37ba55d7a153e4f11ad2125cf5861",
                "isMetaData": false
            }
        }
    ],
    "meta": {
        "total": null,
        "responseStatus": {
            "code": 0,
            "messages": []
        },
        "params": []
    }
}

List error types

Hibatípusok kilistázása.

REST API

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

REST API

REST API Info

Kérés

POST hammy/json/query/v2/errorTypes

Név	Típus	Leírás
id	String	A kérés azonosítója. (vnd.api ID)
clientHashKey	String	A felhasználó azonosítója.

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
list	JErrorType2 [ ]	Hibatípusok listája.

Query API V2

Find messages

Web service API

Kérés

Válasz

Minta

REST API

Kérés

Válasz

Minta

Show message

Web service API

Kérés

Válasz

Minta

REST API

Kérés

Válasz

Minta

Find events

Find properties

List error queues

Web service API

Kérés

Válasz

Minta

REST API

Kérés

Válasz

Minta

List error queue items

Web service API

Kérés

Válasz

Minta

REST API

Kérés

Válasz

Minta

Show attachment

Web service API

Kérés

Válasz

Minta

REST API

Letöltés csatolmány ID alapján

Letöltés csatolmány UUID alapján.

Check email address

Show message by UUID

REST API

Kérés

Válasz

List error types

REST API

Kérés

Válasz

Minta

Ezen az oldalon

Szia, Ági vagyok, miben segíthetek?

Szia, Ági vagyok, miben segíthetek?