Query API V8
REST API
Ez a verzió csak REST API-n érhető el.
Find messages
A findMessages hívás során különböző keresési feltételeknek megfelelő üzenetek adatait lehet lekérdezni.
REST API
Kérés
GET hammy/json/query/v8/messages
POST hammy/json/query/v8/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. |
| recipientAddresses | String [ ] | A címzett email címek listája. |
| 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 [ ] | A 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). |
| debtorIban | String | Debtor IBAN |
| debtorName | String | Debtor neve |
| taxId | String | Adóazonosító |
| dateOfExpiryFrom | DateTime | A lejárati dátum intervallum alja. |
| dateOfExpiryTo | DateTime | A lejárati dátum intervallum teteje. |
| requestedExecutionDateFrom | DateTime | A Kérés teljesítésének ideje dátum intervallum alja. |
| requestedExecutionDateTo | DateTime | A Kérés teljesítésének ideje dátum intervallum teteje. |
| params | Param_V1 [ ] | Egyéb meta adatok. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| meta | JListMeta1 | A válaszhoz tartozó metaadatok. |
| list | JMessage8 [ ] | Megtalált üzenetek listája. |
Minta
GET /hammy/json/query/v8/messages
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+jsonHTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": [
{
"type": "messages",
"id": "4ddcae09-2829-4ade-a44c-dd58ba200b4f",
"attributes": {
"actualStatus": "DELIVERY_SKIPPED",
"extendedStatus": "Accepted",
"statusLastChangedAt": "2024-07-29T16:15:30.102+00:00",
"messageType": "PAYMENT_REQUEST_MAIL",
"recipientName": "Peter",
"archivingExpected": false,
"createdAt": "2024-07-29T15:57:55.317+00:00",
"sentAt": "2024-07-29T00:00:00.000+00:00",
"canShow": true,
"permissionShow": [],
"permissionList": [],
"messageEvents": [],
"clickedLinks": [],
"channel": "PAYMENTREQUEST",
"direction": "OUTGOING",
"replyEnvelopAttached": false,
"paymentSlipAttached": false,
"createdInScenario": false,
"aggregatedArchiveStatus": "UNNECESSARY",
"dmsMessageIdentifier": "39675",
"userName": "admin",
"clientName": "default"
},
"relationships": {
"paymentRequestData": {
"data": {
"type": "paymentRequestData",
"id": "254e6506-ca13-4ebd-b899-3a8d8991101b"
}
},
"properties": {
"data": [
{
"type": "properties",
"id": "235940"
},
{
"type": "properties",
"id": "235941"
},
{
"type": "properties",
"id": "235942"
},
{
"type": "properties",
"id": "235943"
},
{
"type": "properties",
"id": "235944"
}
]
},
"bounces": {
"data": []
},
"attachments": {
"data": []
}
}
}
],
"meta": {
"total": 1,
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
},
"included": [
{
"type": "paymentRequestData",
"id": "254e6506-ca13-4ebd-b899-3a8d8991101b",
"attributes": {
"reqMode": "PAYMENT_REQUEST",
"purposeCode": "INVOICE_PAYMENT",
"debtorIban": "1111-2222-3333",
"debtorName": "Test",
"instructedAmountHuf": 25000.0,
"beneficiaryIban": "HU42117730161111101800000000",
"beneficiaryName": "Példa Biztosító Zrt.",
"dateOfExpiry": "2024-06-28T17:33:52.572+00:00",
"remittanceInformation": "Számla azonosító: 120042"
}
},
{
"type": "properties",
"id": "235940",
"attributes": {
"key": "CUSTOM_LINK_PATH",
"value": "N",
"isMetaData": false
}
},
{
"type": "properties",
"id": "235941",
"attributes": {
"key": "LINK_PATH",
"value": "3",
"isMetaData": false
}
},
{
"type": "properties",
"id": "235942",
"attributes": {
"key": "TANACSADO",
"value": "a",
"isMetaData": false
}
},
{
"type": "properties",
"id": "235943",
"attributes": {
"key": "ARCHIVE_TARGET",
"value": "FS",
"isMetaData": false
}
},
{
"type": "properties",
"id": "235944",
"attributes": {
"key": "ARCHIVE_RELATIVE_PATH",
"value": "archivetest",
"isMetaData": false
}
}
]
}Show message
Üzenet megtekintése az üzenet azonosítója alapján.
REST API
Kérés
GET hammy/json/query/v8/messages/{{id/uuid}}
ID és UUID is megadható.
| Név | Típus | Leírás |
|---|---|---|
| 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 |
|---|---|
| JMessage8 | Megtalált üzenet. |
Minta
GET /hammy/json/query/v8/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": "4ddcae09-2829-4ade-a44c-dd58ba200b4f",
"attributes": {
"actualStatus": "DELIVERY_SKIPPED",
"extendedStatus": "Accepted",
"statusLastChangedAt": "2024-07-29T16:15:30.102+00:00",
"messageType": "PAYMENT_REQUEST_MAIL",
"templateVersionUuid": "97da7b1b-7bd5-4300-83ab-661351b492cc",
"recipientName": "Peter",
"archivingExpected": false,
"createdAt": "2024-07-29T15:57:55.317+00:00",
"sentAt": "2024-07-29T00:00:00.000+00:00",
"canShow": true,
"subject": "Teszt",
"htmlBody": "dsadasd",
"permissionShow": [],
"permissionList": [],
"messageEvents": [],
"clickedLinks": [],
"channel": "PAYMENTREQUEST",
"replyEnvelopAttached": false,
"paymentSlipAttached": false,
"createdInScenario": false,
"aggregatedArchiveStatus": "UNNECESSARY",
"dmsMessageIdentifier": "39675",
"userName": "admin",
"clientName": "default"
},
"relationships": {
"paymentRequestData": {
"data": {
"type": "paymentRequestData",
"id": "254e6506-ca13-4ebd-b899-3a8d8991101b"
}
},
"properties": {
"data": [
{
"type": "properties",
"id": "235940"
},
{
"type": "properties",
"id": "235941"
},
{
"type": "properties",
"id": "235942"
},
{
"type": "properties",
"id": "235943"
},
{
"type": "properties",
"id": "235944"
}
]
},
"bounces": {
"data": []
},
"attachments": {
"data": []
}
}
},
"included": [
{
"type": "properties",
"id": "235941",
"attributes": {
"key": "LINK_PATH",
"value": "3",
"isMetaData": false
}
},
{
"type": "properties",
"id": "235943",
"attributes": {
"key": "ARCHIVE_TARGET",
"value": "FS",
"isMetaData": false
}
},
{
"type": "properties",
"id": "235944",
"attributes": {
"key": "ARCHIVE_RELATIVE_PATH",
"value": "archivetest",
"isMetaData": false
}
},
{
"type": "properties",
"id": "235940",
"attributes": {
"key": "CUSTOM_LINK_PATH",
"value": "N",
"isMetaData": false
}
},
{
"type": "paymentRequestData",
"id": "254e6506-ca13-4ebd-b899-3a8d8991101b",
"attributes": {
"reqMode": "PAYMENT_REQUEST",
"purposeCode": "INVOICE_PAYMENT",
"debtorIban": "1111-2222-3333",
"debtorName": "Test",
"instructedAmountHuf": 25000.0,
"beneficiaryIban": "HU42117730161111101800000000",
"beneficiaryName": "Példa Biztosító Zrt.",
"dateOfExpiry": "2024-06-28T17:33:52.572+00:00",
"remittanceInformation": "Számla azonosító: 120042"
}
},
{
"type": "properties",
"id": "235942",
"attributes": {
"key": "TANACSADO",
"value": "a",
"isMetaData": false
}
}
],
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}Find events
Ebben a verzióban nem változott.
Find properties
Ebben a verzióban nem változott.
List error queues
Ebben a verzióban nem változott.
List error queue items
Ebben a verzióban nem változott.
Show attachment
Ebben a verzióban nem változott.
Check email address
Ebben a verzióban nem változott.
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
Kérés
GET hammy/json/query/v8/messages/id/{{ID}}
| Név | Típus | Leírás |
|---|---|---|
| id | String | A keresett üzenet id-ja. |
Válasz
| Típus | Leírás |
|---|---|
| JMessage8 | Megtalált üzenet. |
Minta
GET /hammy/json/query/v8/messages/id/{{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": "4ddcae09-2829-4ade-a44c-dd58ba200b4f",
"attributes": {
"actualStatus": "DELIVERY_SKIPPED",
"extendedStatus": "Accepted",
"statusLastChangedAt": "2024-07-29T16:15:30.102+00:00",
"messageType": "PAYMENT_REQUEST_MAIL",
"templateVersionUuid": "97da7b1b-7bd5-4300-83ab-661351b492cc",
"recipientName": "Peter",
"archivingExpected": false,
"createdAt": "2024-07-29T15:57:55.317+00:00",
"sentAt": "2024-07-29T00:00:00.000+00:00",
"canShow": true,
"subject": "Teszt",
"htmlBody": "dsadasd",
"permissionShow": [],
"permissionList": [],
"messageEvents": [],
"clickedLinks": [],
"channel": "PAYMENTREQUEST",
"replyEnvelopAttached": false,
"paymentSlipAttached": false,
"createdInScenario": false,
"aggregatedArchiveStatus": "UNNECESSARY",
"dmsMessageIdentifier": "39675",
"userName": "admin",
"clientName": "default"
},
"relationships": {
"paymentRequestData": {
"data": {
"type": "paymentRequestData",
"id": "254e6506-ca13-4ebd-b899-3a8d8991101b"
}
},
"properties": {
"data": [
{
"type": "properties",
"id": "235940"
},
{
"type": "properties",
"id": "235941"
},
{
"type": "properties",
"id": "235942"
},
{
"type": "properties",
"id": "235943"
},
{
"type": "properties",
"id": "235944"
}
]
},
"bounces": {
"data": []
},
"attachments": {
"data": []
}
}
},
"included": [
{
"type": "properties",
"id": "235941",
"attributes": {
"key": "LINK_PATH",
"value": "3",
"isMetaData": false
}
},
{
"type": "properties",
"id": "235943",
"attributes": {
"key": "ARCHIVE_TARGET",
"value": "FS",
"isMetaData": false
}
},
{
"type": "properties",
"id": "235944",
"attributes": {
"key": "ARCHIVE_RELATIVE_PATH",
"value": "archivetest",
"isMetaData": false
}
},
{
"type": "properties",
"id": "235940",
"attributes": {
"key": "CUSTOM_LINK_PATH",
"value": "N",
"isMetaData": false
}
},
{
"type": "paymentRequestData",
"id": "254e6506-ca13-4ebd-b899-3a8d8991101b",
"attributes": {
"reqMode": "PAYMENT_REQUEST",
"purposeCode": "INVOICE_PAYMENT",
"debtorIban": "1111-2222-3333",
"debtorName": "Test",
"instructedAmountHuf": 25000.0,
"beneficiaryIban": "HU42117730161111101800000000",
"beneficiaryName": "Példa Biztosító Zrt.",
"dateOfExpiry": "2024-06-28T17:33:52.572+00:00",
"remittanceInformation": "Számla azonosító: 120042"
}
},
{
"type": "properties",
"id": "235942",
"attributes": {
"key": "TANACSADO",
"value": "a",
"isMetaData": false
}
}
],
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}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
Kérés
GET hammy/json/query/v8/messages/uuid/{{UUID}}
| Név | Típus | Leírás |
|---|---|---|
| uuid | String | A keresett üzenet uuid-ja. |
Válasz
| Típus | Leírás |
|---|---|
| JMessage8 | Megtalált üzenet. |
Minta
GET /hammy/json/query/v8/messages/uuid/{{uuid}}
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": "4ddcae09-2829-4ade-a44c-dd58ba200b4f",
"attributes": {
"actualStatus": "DELIVERY_SKIPPED",
"extendedStatus": "Accepted",
"statusLastChangedAt": "2024-07-29T16:15:30.102+00:00",
"messageType": "PAYMENT_REQUEST_MAIL",
"templateVersionUuid": "97da7b1b-7bd5-4300-83ab-661351b492cc",
"recipientName": "Peter",
"archivingExpected": false,
"createdAt": "2024-07-29T15:57:55.317+00:00",
"sentAt": "2024-07-29T00:00:00.000+00:00",
"canShow": true,
"subject": "Teszt",
"htmlBody": "dsadasd",
"permissionShow": [],
"permissionList": [],
"messageEvents": [],
"clickedLinks": [],
"channel": "PAYMENTREQUEST",
"replyEnvelopAttached": false,
"paymentSlipAttached": false,
"createdInScenario": false,
"aggregatedArchiveStatus": "UNNECESSARY",
"dmsMessageIdentifier": "39675",
"userName": "admin",
"clientName": "default"
},
"relationships": {
"paymentRequestData": {
"data": {
"type": "paymentRequestData",
"id": "254e6506-ca13-4ebd-b899-3a8d8991101b"
}
},
"properties": {
"data": [
{
"type": "properties",
"id": "235940"
},
{
"type": "properties",
"id": "235941"
},
{
"type": "properties",
"id": "235942"
},
{
"type": "properties",
"id": "235943"
},
{
"type": "properties",
"id": "235944"
}
]
},
"bounces": {
"data": []
},
"attachments": {
"data": []
}
}
},
"included": [
{
"type": "properties",
"id": "235941",
"attributes": {
"key": "LINK_PATH",
"value": "3",
"isMetaData": false
}
},
{
"type": "properties",
"id": "235943",
"attributes": {
"key": "ARCHIVE_TARGET",
"value": "FS",
"isMetaData": false
}
},
{
"type": "properties",
"id": "235944",
"attributes": {
"key": "ARCHIVE_RELATIVE_PATH",
"value": "archivetest",
"isMetaData": false
}
},
{
"type": "properties",
"id": "235940",
"attributes": {
"key": "CUSTOM_LINK_PATH",
"value": "N",
"isMetaData": false
}
},
{
"type": "paymentRequestData",
"id": "254e6506-ca13-4ebd-b899-3a8d8991101b",
"attributes": {
"reqMode": "PAYMENT_REQUEST",
"purposeCode": "INVOICE_PAYMENT",
"debtorIban": "1111-2222-3333",
"debtorName": "Test",
"instructedAmountHuf": 25000.0,
"beneficiaryIban": "HU42117730161111101800000000",
"beneficiaryName": "Példa Biztosító Zrt.",
"dateOfExpiry": "2024-06-28T17:33:52.572+00:00",
"remittanceInformation": "Számla azonosító: 120042"
}
},
{
"type": "properties",
"id": "235942",
"attributes": {
"key": "TANACSADO",
"value": "a",
"isMetaData": false
}
}
],
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}List error types
Ebben a verzióban nem változott.
Get domain perfs
Ebben a verzióban nem változott.
Utoljára frissítve
