Hammy API

Query API V7

HammyQuery7API 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
messagesWMessage7 [ ]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:v7="http://hammy.dbx.hu/api/query/v7">
    <soapenv:Header/>
    <soapenv:Body>
        <v7:findMessages>
            <request>
                <clientHashKey>{{clientHashKey}}</clientHashKey>
                <messageTypes>
                    <messageType>TESZT</messageType>
                </messageTypes>
                <resultSize>2</resultSize>
                <offset>2</offset>
            </request>
        </v7:findMessages>
    </soapenv:Body>
</soapenv:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/query/v7/messages

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

Minta

POST /hammy/json/query/v7/messages
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/json
Accept: application/json

{
"uuid": "86d0f6a8-7e98-440b-aef6-d07abb2f02ac"
}

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.
extendedStatusStringKiterjesztett státusz, csatorna specifikus állapotokról hordoz információt.
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.
propertiesProperty2 [ ]Az üzenethez tartozó egyéb adatok, metaadatok.
messageEventsMessageEvent_V1 [ ]Az üzenethez tartozó események.
attachmentsAttachmentsDetails5 [ ]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.
recipientPostalAddressString (255)A címzett teljes postai címe.
recipientPostalAddressCountryCodeString (25)A címzett postai címének ország kódja.
recipientPostalAddressPostalCodeString (10)A címzett postai címének irányítószáma.
recipientPostalAddressCityString (50)A címzett postai címének városa.
recipientPostalAddressStreetString (100)A címzett postai címének utca neve.
recipientPostalAddressStreetTypeString (20)A címzett postai címének utca típusa.
recipientPostalAddressStreetNumberString (20)A címzett postai címének házszáma.
recipientPostalAddressBuildingString (10)A címzett postai címének épület száma.
recipientPostalAddressFloorString (10)A címzett postai címének emelete.
recipientPostalAddressDoorString (10)A címzett postai címének ajtója.
openedAtDateTimeA megnyitás időpontja.
noticeOpenedAtDateTimeAz értesítő e-mail megnyitásának idpontja.
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:v7="http://hammy.dbx.hu/api/query/v7">
    <soapenv:Header/>
    <soapenv:Body>
        <v7:showMessage>
            <request>
                <clientHashKey>{{clientHashKey}}</clientHashKey>
                <messageUuid>25f90a98-1408-407d-af12-32ca226dad42</messageUuid>
            </request>
        </v7:showMessage>
    </soapenv:Body>
</soapenv:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/query/v7/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
JMessage7Megtalált üzenet.

Minta

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

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/v7/messages/id/{{ID}}

NévTípusLeírás
idStringA keresett üzenet id-ja.

Válasz

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

Minta

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

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

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

Válasz

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

Minta

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

List error types

Ebben a verzióban nem változott.

List error types V2

Get domain perfs

Ebben a verzióban nem változott.

Get domain perfs V4

Utoljára frissítve

Ezen az oldalon

Ági

Szia, Ági vagyok, miben segíthetek?

Ági

Szia, Ági vagyok, miben segíthetek?