Query API V1

Find messages

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

Web service API

Kérés

Név	Típus	Leírás
clientHashKey	String	A hívó kliens azonosítója.
messageTypes	String [ ]	Az üzenet típusok.
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).
fromDate	DateTime	A keresési időintervallum kezdete.
toDate	DateTime	A keresési időintervallum vége.
fromBouncedDate	DateTime	Visszapattanás kezdeti dátum.
toBouncedDate	DateTime	Visszapattanás vég dátum.
fileName	String	A csatolmány neve.
internalFileName	String	A csatolmány belső rendszerben használt neve.
resultSize	Integer	A keresési találatok maximális száma. Alapértelmezett értéke 20.
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).
deliveryStatuses	String [ ]	Az üzenet kézbesítési státusza.
properties	Property1 [ ]	Az üzenethez tartozó egyéb adatok, metaadatok.
params	Param_V1 [ ]	Egyéb meta adatok.
userName	String	A felhasználó neve.

Válasz

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

Minta

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

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:findMessagesResponse xmlns:ns2="http://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>
                  <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>
                           <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 13</value>
                                 <isMetaData>false</isMetaData>
                              </property>
                              <property>
                                 <key>postZip</key>
                                 <value>2873</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>0696360172</value>
                                 <isMetaData>false</isMetaData>
                              </property>
                              <property>
                                 <key>mobilePhoneNumber</key>
                                 <value>+36305973502</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:findMessagesResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/query/v1/messages

POST hammy/json/query/v1/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	JMessage1 [ ]	Megtalált üzenetek listája.

Minta

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

{
  "data" : {
    "id" : "21760",
    "type" : "findMessagesRequests",
    "attributes" : {
      "id" : "21760"
    }
  }
}

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

{
  "data" : {
    "id" : "21760",
    "type" : "findMessagesRequests",
    "attributes" : {
      "id" : "21760"
    }
  }
}

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

{
    "data": [
        {
            "type": "messages",
            "id": "21813",
            "attributes": {
                "actualStatus": "SENT",
                "messageType": "TESZT_GEN",
                "recipientName": "Teszt Elek",
                "recipientAddress": "teszt@elek.hu",
                "archivingExpected": false,
                "createdAt": "2019-02-01T07:47:04.601+0000",
                "sentAt": "2019-02-01T07:47:06.332+0000",
                "subject": "Targy mezo 2",
                "fromAddress": "penztar@hammy.hu",
                "fromName": "Pénztár",
                "permissionShow": [],
                "permissionList": []
            },
            "relationships": {
                "attachments": {
                    "data": [
                        {
                            "type": "attachments",
                            "id": "22082"
                        }
                    ]
                },
                "properties": {
                    "data": [
                        {
                            "type": "properties",
                            "id": "361767"
                        },
                        {
                            "type": "properties",
                            "id": "361768"
                        },
                        {
                            "type": "properties",
                            "id": "361769"
                        }
                    ]
                },
                "bounces": {
                    "data": []
                }
            }
        },
        {
            "type": "messages",
            "id": "21803",
            "attributes": {
                "actualStatus": "SENT",
                "messageType": "PENZTAR_KISERO",
                "recipientName": "Teszt Elek",
                "recipientAddress": "teszt@elek.hu",
                "archivingExpected": false,
                "createdAt": "2019-01-31T12:44:13.478+0000",
                "sentAt": "2019-01-31T12:44:14.939+0000",
                "subject": "Pénztár - Értesítés dokumentum érkezéséről",
                "fromAddress": "noreply@dbx.hu",
                "fromName": "Feladó",
                "permissionShow": [],
                "permissionList": []
            },
            "relationships": {
                "attachments": {
                    "data": [
                        {
                            "type": "attachments",
                            "id": "22072"
                        }
                    ]
                },
                "properties": {
                    "data": [
                        {
                            "type": "properties",
                            "id": "361446"
                        },
                        {
                            "type": "properties",
                            "id": "361447"
                        },
                        {
                            "type": "properties",
                            "id": "361448"
                        }
                    ]
                },
                "bounces": {
                    "data": []
                }
            }
        },
        {
            "type": "messages",
            "id": "21802",
            "attributes": {
                "actualStatus": "SENT",
                "messageType": "PENZTAR_KISERO",
                "recipientName": "Teszt Elek",
                "recipientAddress": "teszt@elek.hu",
                "archivingExpected": false,
                "createdAt": "2019-01-31T12:43:09.122+0000",
                "sentAt": "2019-01-31T12:43:11.423+0000",
                "subject": "Prémium pénztár - Értesítés dokumentum érkezéséről",
                "fromAddress": "noreply@dbx.hu",
                "fromName": "Feladó",
                "permissionShow": [],
                "permissionList": []
            },
            "relationships": {
                "attachments": {
                    "data": [
                        {
                            "type": "attachments",
                            "id": "22071"
                        }
                    ]
                },
                "properties": {
                    "data": [
                        {
                            "type": "properties",
                            "id": "361420"
                        },
                        {
                            "type": "properties",
                            "id": "361421"
                        },
                        {
                            "type": "properties",
                            "id": "361422"
                        }
                    ]
                },
                "bounces": {
                    "data": []
                }
            }
        },
        {
            "type": "messages",
            "id": "21801",
            "attributes": {
                "actualStatus": "SENT",
                "messageType": "PENZTAR_KISERO",
                "recipientName": "Teszt Elek",
                "recipientAddress": "teszt@elek.hu",
                "archivingExpected": false,
                "createdAt": "2019-01-31T12:39:45.874+0000",
                "sentAt": "2019-01-31T12:39:53.179+0000",
                "subject": "Pénztár - Értesítés dokumentum érkezéséről",
                "fromAddress": "noreply@dbx.hu",
                "fromName": "Feladó",
                "permissionShow": [],
                "permissionList": []
            },
            "relationships": {
                "attachments": {
                    "data": [
                        {
                            "type": "attachments",
                            "id": "22070"
                        }
                    ]
                },
                "properties": {
                    "data": [
                        {
                            "type": "properties",
                            "id": "361395"
                        },
                        {
                            "type": "properties",
                            "id": "361396"
                        },
                        {
                            "type": "properties",
                            "id": "361394"
                        }
                    ]
                },
                "bounces": {
                    "data": []
                }
            }
        },
        {
            "type": "messages",
            "id": "21800",
            "attributes": {
                "actualStatus": "SENT",
                "messageType": "PENZTAR_KISERO",
                "recipientName": "Teszt Elek",
                "recipientAddress": "teszt@elek.hu",
                "archivingExpected": false,
                "createdAt": "2019-01-31T12:07:04.497+0000",
                "sentAt": "2019-01-31T12:07:10.882+0000",
                "subject": "Pénztár - Értesítés dokumentum érkezéséről",
                "fromAddress": "noreply@dbx.hu",
                "fromName": "Feladó",
                "permissionShow": [],
                "permissionList": []
            },
            "relationships": {
                "attachments": {
                    "data": [
                        {
                            "type": "attachments",
                            "id": "22069"
                        }
                    ]
                },
                "properties": {
                    "data": [
                        {
                            "type": "properties",
                            "id": "361369"
                        },
                        {
                            "type": "properties",
                            "id": "361370"
                        },
                        {
                            "type": "properties",
                            "id": "361368"
                        }
                    ]
                },
                "bounces": {
                    "data": []
                }
            }
        },
        {
            "type": "messages",
            "id": "21799",
            "attributes": {
                "actualStatus": "SENT",
                "messageType": "PREMIUM_PENZTAR_KISERO",
                "recipientName": "Teszt Elek",
                "recipientAddress": "teszt@elek.hu",
                "archivingExpected": false,
                "createdAt": "2019-01-31T12:06:09.359+0000",
                "sentAt": "2019-01-31T12:06:43.659+0000",
                "subject": "Pénztár - Értesítés dokumentum érkezéséről",
                "fromAddress": "noreply@dbx.hu",
                "fromName": "Feladó",
                "permissionShow": [],
                "permissionList": []
            },
            "relationships": {
                "attachments": {
                    "data": [
                        {
                            "type": "attachments",
                            "id": "22068"
                        }
                    ]
                },
                "properties": {
                    "data": [
                        {
                            "type": "properties",
                            "id": "361342"
                        },
                        {
                            "type": "properties",
                            "id": "361343"
                        },
                        {
                            "type": "properties",
                            "id": "361344"
                        }
                    ]
                },
                "bounces": {
                    "data": []
                }
            }
        },
        {
            "type": "messages",
            "id": "21798",
            "attributes": {
                "actualStatus": "SENT",
                "messageType": "PENZTAR_KISERO",
                "recipientName": "Teszt Elek",
                "recipientAddress": "teszt@elek.hu",
                "archivingExpected": false,
                "createdAt": "2019-01-31T11:42:10.148+0000",
                "sentAt": "2019-01-31T12:03:48.535+0000",
                "subject": "Pénztár - Értesítés dokumentum érkezéséről",
                "fromAddress": "noreply@dbx.hu",
                "fromName": "Feladó",
                "permissionShow": [],
                "permissionList": []
            },
            "relationships": {
                "attachments": {
                    "data": [
                        {
                            "type": "attachments",
                            "id": "22067"
                        }
                    ]
                },
                "properties": {
                    "data": [
                        {
                            "type": "properties",
                            "id": "361316"
                        },
                        {
                            "type": "properties",
                            "id": "361317"
                        },
                        {
                            "type": "properties",
                            "id": "361318"
                        }
                    ]
                },
                "bounces": {
                    "data": []
                }
            }
        },
        {
            "type": "messages",
            "id": "21797",
            "attributes": {
                "actualStatus": "SENT",
                "messageType": "PREMIUM_PENZTAR_KISERO",
                "recipientName": "Teszt Elek",
                "recipientAddress": "teszt@elek.hu",
                "archivingExpected": false,
                "createdAt": "2019-01-31T11:39:50.178+0000",
                "sentAt": "2019-01-31T11:41:32.316+0000",
                "subject": "Pénztár - Értesítés dokumentum érkezéséről",
                "fromAddress": "noreply@dbx.hu",
                "fromName": "Feladó",
                "permissionShow": [],
                "permissionList": []
            },
            "relationships": {
                "attachments": {
                    "data": [
                        {
                            "type": "attachments",
                            "id": "22066"
                        }
                    ]
                },
                "properties": {
                    "data": [
                        {
                            "type": "properties",
                            "id": "361290"
                        },
                        {
                            "type": "properties",
                            "id": "361291"
                        },
                        {
                            "type": "properties",
                            "id": "361292"
                        }
                    ]
                },
                "bounces": {
                    "data": []
                }
            }
        },
        {
            "type": "messages",
            "id": "21796",
            "attributes": {
                "actualStatus": "SENT",
                "messageType": "PENZTAR_KISERO",
                "recipientName": "Teszt Elek",
                "recipientAddress": "elek@teszt.hu",
                "archivingExpected": false,
                "createdAt": "2019-01-31T11:36:21.821+0000",
                "sentAt": "2019-01-31T11:37:43.179+0000",
                "subject": "Pénztár - Értesítés dokumentum érkezéséről",
                "fromAddress": "noreply@dbx.hu",
                "fromName": "Feladó",
                "permissionShow": [],
                "permissionList": []
            },
            "relationships": {
                "attachments": {
                    "data": [
                        {
                            "type": "attachments",
                            "id": "22065"
                        }
                    ]
                },
                "properties": {
                    "data": [
                        {
                            "type": "properties",
                            "id": "361264"
                        },
                        {
                            "type": "properties",
                            "id": "361265"
                        },
                        {
                            "type": "properties",
                            "id": "361266"
                        }
                    ]
                },
                "bounces": {
                    "data": []
                }
            }
        },
        {
            "type": "messages",
            "id": "21795",
            "attributes": {
                "actualStatus": "SENT",
                "messageType": "PREMIUM_PENZTAR_KISERO",
                "recipientName": "teszt elek
                "recipientAddress": "elek@txt.hu",
                "archivingExpected": false,
                "createdAt": "2019-01-31T11:30:58.798+0000",
                "sentAt": "2019-01-31T11:35:32.954+0000",
                "subject": "Prémium pénztár - Értesítés dokumentum érkezéséről",
                "fromAddress": "noreply@dbx.hu",
                "fromName": "Feladó",
                "permissionShow": [],
                "permissionList": []
            },
            "relationships": {
                "attachments": {
                    "data": [
                        {
                            "type": "attachments",
                            "id": "22064"
                        }
                    ]
                },
                "properties": {
                    "data": [
                        {
                            "type": "properties",
                            "id": "361238"
                        },
                        {
                            "type": "properties",
                            "id": "361239"
                        },
                        {
                            "type": "properties",
                            "id": "361240"
                        }
                    ]
                },
                "bounces": {
                    "data": []
                }
            }
        },
        {
            "type": "messages",
            "id": "21794",
            "attributes": {
                "actualStatus": "ERROR",
                "messageType": "PREMIUM_PENZTAR_KISERO",
                "recipientName": "TEszt Elek",
                "recipientAddress": "Teszt@elek.hu",
                "archivingExpected": false,
                "createdAt": "2019-01-31T11:29:53.808+0000",
                "permissionShow": [],
                "permissionList": []
            },
            "relationships": {
                "attachments": {
                    "data": [
                        {
                            "type": "attachments",
                            "id": "22063"
                        }
                    ]
                },
                "properties": {
                    "data": [
                        {
                            "type": "properties",
                            "id": "361214"
                        }
                    ]
                },
                "bounces": {
                    "data": []
                }
            }
        }
    ],
    "included": [
        {
            "type": "properties",
            "id": "361547",
            "attributes": {
                "key": "documentID",
                "value": "AH12345678",
                "isMetaData": false
            }
        },
        {
            "type": "properties",
            "id": "361336",
            "attributes": {
                "key": "error.error",
                "value": "A dokumentum aláírás hiányos",
                "index": 1,
                "isMetaData": false
            }
        },
        {
            "type": "properties",
            "id": "361523",
            "attributes": {
                "key": "beneficiaries.beneficiarySelectionDate",
                "value": "2019.01.31.",
                "index": 1,
                "isMetaData": false
            }
        }
    ],
    "meta": {
        "total": 19,
        "responseStatus": {
            "code": 0,
            "messages": []
        },
        "params": []
    }
}

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 üzenet aktuális státusza.
statusLastChangedAt	DateTime	A státusz utolsó módosulásának ideje.
messageType	String	Az üzenet típusa.
recipientName	String	Az ügyfél neve.
recipientAddress	String	Az ügyfél e-mail címe.
partnerRef	String	Partner azonosító.
archivingExpected	Boolean	'true' érték 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	A levél HTML szövege.
createdAt	DateTime	A létrehozás dátuma.
sentAt	DateTime	A küldés ideje.
bouncedAt	DateTime	A levél visszapattanásának ideje.
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.
bccAddress	String	Titkos másolat címe.
replyToAddress	String	Címzett címe.
replyToName	String	Címzett neve.
fromAddress	String	Feladó címe.
fromName	String	Feladó neve.
ccRecipientAddress	String	Másolatot kapó címzett címe.
ccRecipientName	String	Másolatot kapó címzett neve.
mailServerLog	String	Szerver log.
properties	Property1	Az üzenethez tartozó egyéb adatok, metaadatok.
attachments	AttachmentWithoutContent1 [ ]	Az üzenethez tartozó csatolmányok adatai.
responseStatus	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek.

Minta

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

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:showMessageResponse xmlns:ns2="http://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>
         </response>
      </ns2:showMessageResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/query/v1/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
JMessage1	Megtalált üzenet.

Minta

GET /hammy/json/query/v1/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

Események listázása azonosító alapján.

Web service API

List events

Web service alatt a szolgáltatás neve listEvents.

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	A lekérdezendő üzenet belső azonosítója.
messageUuid	String	A lekérdezendő üzenet UUID azonosítója.
userName	String	A felhasználó neve.

Válasz

Név	Típus	Leírás
events	Event1 [ ]	Események listája.
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:quer="http://query.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <quer:listEvents>
         <request>
            <clientHashKey>?</clientHashKey>
            <messageId>21565</messageId>
            <userName>?</userName>
         </request>
      </quer:listEvents>
   </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:listEventsResponse xmlns:ns2="http://query.api.hammy.dbx.hu/">
         <response>
            <events>
               <event>
                  <eventSource>HammyBaseExceptionHandlerTask</eventSource>
                  <eventName>CHAIN_FINISHED</eventName>
                  <eventNameDesc>A folyamat láncolat befejeződött</eventNameDesc>
                  <eventType>I</eventType>
                  <taskChain>sendAPISendMailTaskChain</taskChain>
                  <taskChainDesc>Bejövő, küldési kérés interfész webservice API (validálás)</taskChainDesc>
                  <createdAt>2018-09-12T21:18:35.472+02:00</createdAt>
               </event>
               <event>
                  <eventSource>HammyBaseExceptionHandlerTask</eventSource>
                  <eventName>CHAIN_STARTED</eventName>
                  <eventNameDesc>A folyamat láncolat elkezdődött</eventNameDesc>
                  <eventType>I</eventType>
                  <taskChain>savedRequestQueueTaskChain</taskChain>
                  <taskChainDesc>Kérés előkészítési és mentési folyamata</taskChainDesc>
                  <createdAt>2018-09-12T21:18:35.473+02:00</createdAt>
               </event>
               <event>
                  <eventSource>HammyBaseExceptionHandlerTask</eventSource>
                  <eventName>CHAIN_FINISHED</eventName>
                  <eventNameDesc>A folyamat láncolat befejeződött</eventNameDesc>
                  <eventType>I</eventType>
                  <taskChain>savedRequestQueueTaskChain</taskChain>
                  <taskChainDesc>Kérés előkészítési és mentési folyamata</taskChainDesc>
                  <createdAt>2018-09-12T21:18:35.524+02:00</createdAt>
               </event>
               <event>
                  <eventSource>HammyBaseExceptionHandlerTask</eventSource>
                  <eventName>CHAIN_STARTED</eventName>
                  <eventNameDesc>A folyamat láncolat elkezdődött</eventNameDesc>
                  <eventType>I</eventType>
                  <taskChain>attachmentGetterQueueTaskChain</taskChain>
                  <taskChainDesc>Csatolmány letöltési folyamat</taskChainDesc>
                  <createdAt>2018-09-12T21:18:35.516+02:00</createdAt>
               </event>
               <event>
                  <eventSource>HammyBaseExceptionHandlerTask</eventSource>
                  <eventName>CHAIN_STARTED</eventName>
                  <eventNameDesc>A folyamat láncolat elkezdődött</eventNameDesc>
                  <eventType>I</eventType>
                  <taskChain>mailRequestQueueTaskChain</taskChain>
                  <taskChainDesc>A levélszöveg összeállítása, digitális aláírás, vízjelezés és egyéb lépések</taskChainDesc>
                  <createdAt>2018-09-12T21:18:35.576+02:00</createdAt>
               </event>
               <event>
                  <eventSource>HammyBaseExceptionHandlerTask</eventSource>
                  <eventName>CHAIN_FINISHED</eventName>
                  <eventNameDesc>A folyamat láncolat befejeződött</eventNameDesc>
                  <eventType>I</eventType>
                  <taskChain>attachmentGetterQueueTaskChain</taskChain>
                  <taskChainDesc>Csatolmány letöltési folyamat</taskChainDesc>
                  <createdAt>2018-09-12T21:18:35.583+02:00</createdAt>
               </event>
               <event>
                  <eventSource>HammyBaseExceptionHandlerTask</eventSource>
                  <eventName>CHAIN_FINISHED</eventName>
                  <eventNameDesc>A folyamat láncolat befejeződött</eventNameDesc>
                  <eventType>I</eventType>
                  <taskChain>mailRequestQueueTaskChain</taskChain>
                  <taskChainDesc>A levélszöveg összeállítása, digitális aláírás, vízjelezés és egyéb lépések</taskChainDesc>
                  <createdAt>2018-09-12T21:18:35.758+02:00</createdAt>
               </event>
               <event>
                  <eventSource>HammyBaseExceptionHandlerTask</eventSource>
                  <eventName>CHAIN_STARTED</eventName>
                  <eventNameDesc>A folyamat láncolat elkezdődött</eventNameDesc>
                  <eventType>I</eventType>
                  <taskChain>outgoingMailQueueTaskChain</taskChain>
                  <taskChainDesc>Email végleges összeállítási és kiküldési folyamata</taskChainDesc>
                  <createdAt>2018-09-12T21:18:35.755+02:00</createdAt>
               </event>
               <event>
                  <eventSource>HammyBaseExceptionHandlerTask</eventSource>
                  <eventName>CHAIN_FINISHED</eventName>
                  <eventNameDesc>A folyamat láncolat befejeződött</eventNameDesc>
                  <eventType>I</eventType>
                  <taskChain>outgoingMailQueueTaskChain</taskChain>
                  <taskChainDesc>Email végleges összeállítási és kiküldési folyamata</taskChainDesc>
                  <createdAt>2018-09-12T21:18:35.959+02:00</createdAt>
               </event>
            </events>
            <responseStatus>
               <code>0</code>
               <messages/>
            </responseStatus>
         </response>
      </ns2:listEventsResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/query/v1/events

Paraméter	Típus	Leírás
messageId	Integer	A lekérdezendő üzenet belső azonosítója.
messageUuid	String	A lekérdezendő üzenet UUID azonosítója.
limit	Integer	A keresési találatok maximális 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.

Válasz

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

Minta

GET /hammy/json/query/v1/events?messageId={{messageId}}
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": "events",
            "id": "337659",
            "attributes": {
                "eventSource": "HammyBaseExceptionHandlerTask",
                "eventName": "CHAIN_FINISHED",
                "eventNameDesc": "A folyamat láncolat befejeződött",
                "eventType": "I",
                "taskChain": "sendAPISendMailTaskChain",
                "taskChainDesc": "Bejövő, küldési kérés interfész webservice API (validálás)",
                "createdAt": "2019-01-30T11:21:53.197+0000"
            }
        },
        {
            "type": "events",
            "id": "337660",
            "attributes": {
                "eventSource": "HammyBaseExceptionHandlerTask",
                "eventName": "CHAIN_STARTED",
                "eventNameDesc": "A folyamat láncolat elkezdődött",
                "eventType": "I",
                "taskChain": "savedRequestQueueTaskChain",
                "taskChainDesc": "Kérés előkészítési és mentési folyamata",
                "createdAt": "2019-01-30T11:21:53.200+0000"
            }
        },
        {
            "type": "events",
            "id": "337661",
            "attributes": {
                "eventSource": "HammyBaseExceptionHandlerTask",
                "eventName": "CHAIN_FINISHED",
                "eventNameDesc": "A folyamat láncolat befejeződött",
                "eventType": "I",
                "taskChain": "savedRequestQueueTaskChain",
                "taskChainDesc": "Kérés előkészítési és mentési folyamata",
                "createdAt": "2019-01-30T11:21:53.261+0000"
            }
        },
        {
            "type": "events",
            "id": "337662",
            "attributes": {
                "eventSource": "HammyBaseExceptionHandlerTask",
                "eventName": "CHAIN_STARTED",
                "eventNameDesc": "A folyamat láncolat elkezdődött",
                "eventType": "I",
                "taskChain": "attachmentGetterQueueTaskChain",
                "taskChainDesc": "Csatolmány letöltési folyamat",
                "createdAt": "2019-01-30T11:21:53.255+0000"
            }
        },
        {
            "type": "events",
            "id": "337663",
            "attributes": {
                "eventSource": "HammyBaseExceptionHandlerTask",
                "eventName": "CHAIN_FINISHED",
                "eventNameDesc": "A folyamat láncolat befejeződött",
                "eventType": "I",
                "taskChain": "attachmentGetterQueueTaskChain",
                "taskChainDesc": "Csatolmány letöltési folyamat",
                "createdAt": "2019-01-30T11:21:59.394+0000"
            }
        },
        {
            "type": "events",
            "id": "337664",
            "attributes": {
                "eventSource": "HammyBaseExceptionHandlerTask",
                "eventName": "CHAIN_STARTED",
                "eventNameDesc": "A folyamat láncolat elkezdődött",
                "eventType": "I",
                "taskChain": "mailRequestQueueTaskChain",
                "taskChainDesc": "A levélszöveg összeállítása, digitális aláírás, vízjelezés és egyéb lépések",
                "createdAt": "2019-01-30T11:21:59.386+0000"
            }
        },
        {
            "type": "events",
            "id": "337665",
            "attributes": {
                "eventSource": "HammyBaseExceptionHandlerTask",
                "eventName": "CHAIN_STARTED",
                "eventNameDesc": "A folyamat láncolat elkezdődött",
                "eventType": "I",
                "taskChain": "notificationQueueTaskChain",
                "taskChainDesc": "Értesítési folyamat",
                "createdAt": "2019-01-30T11:22:19.468+0000"
            }
        },
        {
            "type": "events",
            "id": "337666",
            "attributes": {
                "eventSource": "HammyBaseExceptionHandlerTask",
                "eventName": "TECHNICAL_ERROR",
                "eventNameDesc": "Technikia hiba a folyamat láncolat során",
                "eventType": "E",
                "taskChain": "mailRequestQueueTaskChain",
                "taskChainDesc": "A levélszöveg összeállítása, digitális aláírás, vízjelezés és egyéb lépések",
                "trace": "hu.dbx.chaingun.util.taskchain.TaskException: Failed to create HTML from generator template!...",
                "createdAt": "2019-01-30T11:22:21.702+0000"
            }
        },
        {
            "type": "events",
            "id": "337667",
            "attributes": {
                "eventSource": "NotifierTask",
                "eventName": "TECHNICAL_ERROR",
                "eventNameDesc": "Technikia hiba a folyamat láncolat során",
                "eventType": "E",
                "taskChain": "notificationQueueTaskChain",
                "taskChainDesc": "Értesítési folyamat",
                "trace": "com.sun.xml.ws.client.ClientTransportException: HTTP transport error: java.net.ConnectException: Connection refused (Connection refused)...",
                "createdAt": "2019-01-30T11:22:21.686+0000"
            }
        },
        {
            "type": "events",
            "id": "337668",
            "attributes": {
                "eventSource": "HammyBaseExceptionHandlerTask",
                "eventName": "TECHNICAL_ERROR",
                "eventNameDesc": "Technikia hiba a folyamat láncolat során",
                "eventType": "E",
                "taskChain": "notificationQueueTaskChain",
                "taskChainDesc": "Értesítési folyamat",
                "trace": "hu.dbx.chaingun.util.taskchain.TaskException: Caught exception during notifying client!...",
                "createdAt": "2019-01-30T11:22:21.788+0000"
            }
        }
    ],
    "meta": {
        "total": null,
        "responseStatus": {
            "code": 0,
            "messages": []
        },
        "params": []
    }
}

Find properties

Üzenet metaadataira szűrés.

Web service

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

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	Üzenet azonosító.
recipientName	String	Címzett neve.
recipientAddress	String	Címzett címe.
properties	Property1 [ ]	Az üzenethez tartozó egyéb adatok, metaadatok.
params	Param_V1 [ ]	Paraméterek listája.
userName	String	A felhasználó neve.

Válasz

Név	Típus	Leírás
properties	Property1 [ ]	Az üzenethez tartozó egyéb adatok, metaadatok.
subject	String	A megtalált property-khez kapcsolódó üzenet tárgya.
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:quer="http://query.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <quer:findProperties>
         <request>
            <clientHashKey>?</clientHashKey>
            <messageId>21566</messageId>
         </request>
      </quer:findProperties>
   </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:findPropertiesResponse xmlns:ns2="http://query.api.hammy.dbx.hu/">
         <response>
            <properties>
               <property>
                  <key>SKIP_DELIVERY</key>
                  <value>NO</value>
                  <isMetaData>false</isMetaData>
               </property>
            </properties>
            <subject>ures subject</subject>
            <responseStatus>
               <code>0</code>
               <messages/>
            </responseStatus>
         </response>
      </ns2:findPropertiesResponse>
   </S:Body>
</S:Envelope>

List error queues

Hibasorok listázása.

Web service

Ebben a verzióban ez a funkció csak Web service-n érhető el.

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	ErrorQueue1 [ ]	Hibaüzenet sorok.
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.

Minta

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:quer="http://query.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <quer:listErrorQueues>
         <!--Optional:-->
         <request>
            <clientHashKey>?</clientHashKey>
            <limit>1</limit>
            <offset>1</offset>
         </request>
      </quer:listErrorQueues>
   </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:listErrorQueuesResponse xmlns:ns2="http://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:listErrorQueuesResponse>
   </S:Body>
</S:Envelope>

List error queue items

Hibasor elemeinek listázása.

Web service

Ebben a verzióban ez a funkció csak Web service-n érhető el.

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>

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	AttachmentWithContent1	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:quer="http://query.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <quer:showAttachment>
         <request>
            <clientHashKey>?</clientHashKey>
            <attachmentId>21818</attachmentId>
            <userName>?</userName>
         </request>
      </quer:showAttachment>
   </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:showAttachmentResponse xmlns:ns2="http://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>
                  <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:showAttachmentResponse>
   </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/v1/attachmentContents/{{attachmentId}}

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

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

Check email address

Email cím ellenőrzése.

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.
recipientAddress	String	Címezett címe.
fromDate	DateTime	Keresés kezdeti dátuma.
daysBack	Integer	Napok száma.
params	Param_V1 [ ]	Egyéb meta adatok.

Válasz

Név	Típus	Leírás
status	String	Email cím státusz. CheckEmailAddressStatus
messageId	Integer	Üzenet azonosító ID.
createdAt	Datetime	Létrehozás dátuma.
sentAt	DateTime	Küldés dátuma.
bouncedAt	DateTime	Visszapattanás dátuma.
replyStatus	String	Válasz állapota. ReplyStatus
replyDescription	String	Válasz leírása.
errorMsg	String	Hibaüzenet.
actualStatus	String	Jelenlegi állapot. MessageStatus
clickedAt	DateTime	Kattintás dátuma.
openedAt	DateTime	Megnyitás dátuma.
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.

Minta

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:quer="http://query.api.hammy.dbx.hu/">
   <soapenv:Header/>
   <soapenv:Body>
      <quer:checkEmailAddress>
         <request>
            <clientHashKey>?</clientHashKey>
            <recipientAddress>teszt@elek.hu</recipientAddress>
            <daysBack>300</daysBack>
         </request>
      </quer:checkEmailAddress>
   </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:checkEmailAddressResponse xmlns:ns2="http://query.api.hammy.dbx.hu/">
         <response>
            <status>EMAIL_SENT</status>
            <messageId>21813</messageId>
            <sentAt>2019-02-01T08:47:06.332+01:00</sentAt>
            <actualStatus>SENT</actualStatus>
            <responseStatus>
               <code>0</code>
               <messages/>
            </responseStatus>
         </response>
      </ns2:checkEmailAddressResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/query/v1/checkEmailAddress

Paraméter	Típus	Leírás
id	Integer	A kérés azonsítója. (vnd.api id)
recipientAddress	String	Címezett címe.
fromDate	DateTime	Keresés kezdeti dátuma.
daysBack	Integer	Napok száma.
limit	Integer	A keresési találatok maximális 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 [ ]	Egyéb meta adatok.

Válasz

Név	Típus	Leírás
meta	JMeta1	A válaszhoz tartozó metaadatok.
id	Integer	A válasz azonosítója. (vnd.api id)
status	String	Email cím státusz. CheckEmailAddressStatus
messageId	Integer	Üzenet azonosító ID.
createdAt	Datetime	Létrehozás dátuma.
sentAt	DateTime	Küldés dátuma.
bouncedAt	DateTime	Visszapattanás dátuma.
replyStatus	String	Válasz állapota. ReplyStatus
replyDescription	String	Válasz leírása.
errorMsg	String	Hibaüzenet.
actualStatus	String	Jelenlegi állapot. MessageStatus
clickedAt	DateTime	Kattintás dátuma.
openedAt	DateTime	Megnyitás dátuma.

Minta

GET /hammy/json/query/v1/checkEmailAddress?recipientAddress={{recipientAddress}}&daysBack={{daysBack}}
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": "checkEmailAddressResult",
        "attributes": {
            "status": "EMAIL_SENT",
            "messageId": 21813,
            "sentAt": "2019-02-01T07:47:06.332+0000",
            "actualStatus": "SENT"
        }
    },
    "meta": {
        "total": null,
        "responseStatus": {
            "code": 0,
            "messages": []
        },
        "params": []
    }
}

Show message by uuid

Üzenet megtekinté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
JMessage1	Megtalált üzenet.

Minta

GET /hammy/json/query/v1/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": []
    }
}

Query API V1

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

Web service API

Kérés

Válasz

Minta

REST API

Kérés

Válasz

Minta

Find properties

Web service API

Kérés

Válasz

Minta

List error queues

Web service API

Kérés

Válasz

Minta

List error queue items

Web service 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

Web service API

Kérés

Válasz

Minta

REST API

Kérés

Válasz

Minta

Show message by uuid

REST API

Kérés

Válasz

Minta

Ezen az oldalon

Szia, Ági vagyok, miben segíthetek?

Szia, Ági vagyok, miben segíthetek?