Hammy API
Hammy APIQuery

Query API V4

HammyQuery4API WSDL letöltése

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évTípusLeírásKötelező
uuidStringA levél UUID-ja.
clientHashKeyStringA hívó kliens azonosítója.*
messageTypesString [ ]Az üzenet típusok.
recipientNameStringA címzett neve.
recipientAddressStringA címzett email címe.
partnerRefStringPartner azonosító.
objectRefStringA kapcsolódó objektum azonosítója (pl. szerződésszám).
objectTypeStringA kapcsolódó objektum típusa (pl. számla).
batchIdStringKöteg azonosító.
createdAtFromDateTimeA keresési időintervallum kezdete.
createdAtToDateTimeA keresési időintervallum vége.
bouncedAtFromDateTimeA visszapattanási időpont keresési időintervallum kezdete.
bouncedAtToDateTimeA visszapattanási időpont keresési időintervallum vége.
fileNameStringA csatolmány neve.
internalFileNameStringA csatolmány belső rendszerben használt neve.
resultSizeIntegerA keresési találat maximális mérete Alapértelmezett értéke 20.
offsetIntegerA találati lista kezdete.
deliveryStatusesString [ ]Az üzenet kézbesítési státusza.
archiveStatusesArchiveStatus [ ]Az archiválási státusza.
extendedStatuesesString [ ]Kiterjesztett státusz, csatorna specifikus állapotokról hordoz információt.
messageChannelsMessageChannel [ ]Az üzenet küldési csatornája.
propertiesProperty1 [ ]Az üzenethez tartozó egyéb adatok, metaadatok.
paramsParam_V1 [ ]Egyéb metaadatok listája.
userNameStringFelhasználó név.
requestIdStringKülső üzenet küldési kérés azonosító.
itemIdStringÜzenethez kapcsolódó item id.
hashStringÜzenethez kapcsolódó hash.
openedBooleanMegnyitotta-e a címzett az üzenetet.
lockedBooleanZárolt-e az üzenet.
showDeletedMessagesBooleanTörölt üzenetek mutatása.
mailLinkTitleStringÜzenetben található link címe.
directionsMessageDirection [ ]Üzenet iránya (bejövő/kimenő).
subjectStringÜzenet tárgya.
ordersOrder_V1 [ ]Rendezések.

Válasz

NévTípusLeírás
messagesTMessage_V3 [ ]A Hammy-ben lévő levelek.
countIntegerA találatok száma.
responseStatusResponseStatus_V1A válasz státusza.
paramsParam_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:findMessages>
                <request>
            <clientHashKey>?</clientHashKey>
            <messageTypes>
               <messageType>TESZT_GEN</messageType>
            </messageTypes>
            <resultSize>1</resultSize>
            <offset>0</offset>
         </request>
      </ws:findMessages>
   </soapenv:Body>
</soapenv:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/query/v4/messages

POST hammy/json/query/v4/messages

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

Paraméter/NévTípusLeírás
idStringA kérés azonosítója. (vnd.api ID)
uuidStringAz üzenet UUID-ja.
recipientNameStringA címzett neve.
recipientAddressStringA címzett email címe.
recipientPhoneNumberStringA címzett telefonszáma.
partnerRefStringPartner azonosító.
objectRefStringA kapcsolódó objektum azonosítója (pl. szerződésszám).
objectTypeStringA kapcsolódó objektum típusa (pl. számla).
createdAtFromDateTimeA készítési dátum intervallum alja.
createdAtToDateTimeA készítési dátum intervallum teteje.
bouncedAtFromDateTimeA visszapattanási dátum intervallum alja.
bouncedAtToDateTimeA visszapattanási dátum intervallum teteje.
statusLastChangedAtFromDateTimeAz utolsó státuszváltozás dátum intervallum alja.
statusLastChangedAtToDateTimeAz utolsó státuszváltozás dátum intervallum teteje.
fileNameStringA csatolmány neve.
internalFileNameStringA csatolmány belső rendszerben használt neve.
requestIdStringA kérés azonosítója.
hashStringAz üzenet hash-e.
itemIdIntegerA lekérdezendő üzenethez kapcsolódó Chaingun Item ID-ja.
openedBooleanMegnyitották-e az üzenetet.
lockedBooleanZárolt-e az üzenet.
showDeletedMessagesBooleanA törölt üzenetek megjelenjenek-e a találatokban.
mailLinkTitleStringAz üzenetben lévő link címe.
subjectStringAz üzenet tárgya.
messageTypesString [ ]Az üzenet típusok.
deliveryStatusesString [ ]Az üzenet kézbesítési státuszai.
archiveStatusesArchiveStatus [ ]Az üzenet archiválási státuszai.
extendedStatusesString [ ]Kiterjesztett státuszok, csatorna specifikus állapotokról hordoznak információt.
channelsString [ ]Az keresett üzenetek csatornái.
directionsMessageDirection [ ]Küldés irányai.
propertiesJProperty1 [ ]Az üzenethez tartozó egyéb adatok, metaadatok.
limitIntegerA keresési találatok maximális száma.
offsetIntegerA 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).
sortStringRendezés.
clientHashKeyStringA hívó kliens azonosítója.
userNameStringA felhasználó neve.
scenarioDefIdsStringAz üzenethez tartozó szcenárió azonosítója.
campaignIdsStringAz üzenethez tartozó kampány azonosítója(uuid).
campaignPartIdsStringAz üzenethez tartozó kampányelem azonosítója(uuid).
paramsParam_V1 [ ]Egyéb meta adatok.

Válasz

NévTípusLeírás
metaJListMeta1A válaszhoz tartozó metaadatok.
listJMessage4 [ ]Megtalált üzenetek listája.

Minta

POST/GET /hammy/json/query/v4/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"
    }
  }
}

Show message

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

Web service API

Kérés

NévTípusLeírásKötelező
clientHashKeyStringA webszolgáltatást hívó kliens azonosítója.*
usernameStringA felhasználó neve.
messageIdIntegerA keresett levél adatbázisbeli azonosítója.
messageUuidIntegerA keresett levél adatbázisbeli azonosítója.
messageHashIntegerAz keresett levél hashe.
paramsParam_V1 [ ]Egyéb paraméterek

Válasz

NévTípusLeírás
actualStatusStringAz aktuális státusz.
msgArchiveStatusStringAz archiválás státusza.
aggregatedArchiveStatusStringAz aggregált archiválás státusza.
statusLastChangedAtDateTimeA státusz módosulásának ideje.
messageTypeStringA kérés típusa. Értéke egy Hammy-ben létező levélsablon azonosítója.
recipientNameStringA címzett neve.
recipientAddressStringA címzett email címe.
bccAddressStringTitkos másolat email cím.
replyToAddressStringCímzett címe.
replyToNameStringCímzett neve.
fromAddressStringFeladó címe.
fromNameStringFeladó neve.
ccRecipientAddressStringMásolatot kapó címzett címe.
ccRecipientNameStringMásolatot kapó címzett neve.
partnerRefStringPartner azonosító.
archivingExpectedBooleantrue esetén a levél tárgya és szövege archiválódik.
archivedAtDateTimeAz archiválás időpontja.
subjectStringA levél tárgya.
bodyStringA levél szövege.
htmlBodyStringHTML email szövege.
noticeSubjectStringAz értesítő email tárgya.
noticeBodyStringAz értesítő email szövege.
noticeHtmlBodyStringAz értesítő email HTML szövege.
createdAtDateTimeA létrehozás ideje.
sentAtDateTimeAz elküldés ideje.
bouncedAtDateTimeAz üzenet visszapattanásának ideje.
lockedAtDateTimeAz üzenet zárolásának ideje.
movedToArchivedAtDateTimeArchiválás időpontja.
boundReasonCodeStringAz üzenet visszapattanásának oka.
boundReasonDescriptionStringA visszapattanás okának leírása.
boundMailTextStringA visszapattanó levél szövege/
boundListJBounce2 [ ]Visszapattanások.
propertiesProperty1 [ ]Az üzenethez tartozó egyéb adatok, metaadatok.
messageEventsMessageEvent_V1 [ ]Az üzenethez tartozó események.
attachmentsAttachmentWithoutContent3 [ ]Az üzenethez tartozó csatolmányok.
responseStatusResponseStatus_V1A válasz státusza.
mailServerLogStringSzerver log.
channelStringÜzenetküldési csatorna.
uuidStringAz üzenet UUID-ja.
recipientPhoneNumberStringA címzett telefonszáma.
fromPhoneNumberStringFeladó telefonszáma.
recipientPSIDStringA címzett facebook azonosítója.
fromPageAccessTokenStringFeladó token.
openedAtDateTimeA megnyitás időpontja.
noticeOpenedAtDateTimeAz értesítő e-mail megnyitásának időpontja.
paramsParam_V1 [ ]Egyéb paraméterek.
directionMessageDirectionKüldés iránya.
dmsMessageIdentifierStringAz üzenet adatbázisbeli azonosítója.

Minta

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://hammy.dbx.hu/api/query/v4">
    <soapenv:Header/>
    <soapenv:Body>
        <v4:showMessage>
            <request>
                <clientHashKey>{{clientHashKey}}</clientHashKey>
                <messageUuid>{{Uuid}}</messageUuid>
            </request>
        </v4:showMessage>
    </soapenv:Body>
</soapenv:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/query/v4/messages/{{id/uuid}}

ID és UUID is megadható.

NévTípusLeírás
clientHashKeyStringA webszolgáltatást hívó kliens azonosítója.
userNameStringA felhasználó neve.

Válasz

TípusLeírás
JMessage4Megtalált üzenet.

Minta

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

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

Ebben a verzióban nem változott.

List error queues V3

List error queue items

Ebben a verzióban nem változott.

List error queue items V3

Show attachment

Ebben a verzióban nem változott.

Show attachment V3

Check email address

Ebben a verzióban nem változott.

Check email address V1

Show message by ID

Üzenet lekérése ID 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/v4/messages/id/{{ID}}

NévTípusLeírás
uuidStringA keresett üzenet uuid-ja.

Válasz

NévTípusLeírás
metaJMeta1A válaszhoz tartozó metaadatok.
messageJMessage4Megtalált üzenet.

Minta

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

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/v4/messages/uuid/{{UUID}}

NévTípusLeírás
uuidStringA keresett üzenet uuid-ja.

Válasz

TípusLeírás
JMessage4Megtalált üzenet.

Minta

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

List error types

Ebben a verzióban nem változott.

List error types V2

Get domain perfs

Statisztika jelleggel a domain performancia aggregált lekérdezése. Alapesetben domainre történik az aggregáció, viszont lehetőség van üzenettípusra, szcenárió névre és kampány címre is aggregálni.

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/v4/domainPerfs

NévTípusLeírás
idStringKérés azonosító. (vnd.api ID)
domainStringDomain (prefix-es egyezés).
messageTypesString [ ]Üzenettípusok.
scenarioDefNamesString [ ]Szcenárió nevek.
campaignPartTitlesString [ ]Kampány címek.
campaignPartCreatedAtFromStringLegkorábbi kampány keletkezési dátum.
campaignPartCreatedAtToStringLegkésőbbi kampány keletkezési dátum.
scenarioDefVersionCreatedAtFromStringLegkorábbi kampány keletkezési dátum
scenarioDefVersionCreatedAtToStringLegkésőbbi kampány keletkezési dátum
templateVersionCreatedAtFromStringLegkorábbi kampány keletkezési dátum
templateVersionCreatedAtToStringLegkésőbbi kampány keletkezési dátum
limitIntegerA keresési találatok maximális száma.
offsetIntegerA 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).
sortStringRendezés.
clientHashKeyStringA hívó kliens azonosítója.
userNameStringA felhasználó neve.
paramsParam_V1 [ ]Egyéb meta adatok.

Válasz

NévTípusLeírás
metaJListMeta1A válaszhoz tartozó metaadatok.
listJDomainPerf1 [ ]Az eredmény.

Minta

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

{
    "data": {
        "type": "getDomainPerfsRequests",
        "id": "123456",
        "attributes": {
            "campaignPartTitles": ["test-campaign"],
            "campaignPartCreatedAtTo": "2020-04-01T00:00:00+02:00",
            "sort": "opens"
        }
    }
}

Utoljára frissítve

Query API V5

Előző oldal

Query API V3

Következő oldal

Ezen az oldalon

Query API V4
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
List error queue items
Show attachment
Check email address
Show message by ID
REST API
Kérés
Válasz
Minta
Show message by UUID
REST API
Kérés
Válasz
Minta
List error types
Get domain perfs
REST API
Kérés
Válasz
Minta
Ági

Szia, Ági vagyok, miben segíthetek?

Ági

Szia, Ági vagyok, miben segíthetek?