Query API V9
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.
Ebben a verzióban a kérés kibővült a fromName, fromAddress, fromPhoneNumber és boundReasonCodes mezőkkel.
A válasz JMessage9 típusú; az ezzel megjelenő signatureRequestDataDetailsList reláció csak a Show message válaszban töltődik ki.
REST API
Kérés
GET hammy/json/query/v9/messages
POST hammy/json/query/v9/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. |
| fromName | String | A feladó neve. |
| fromAddress | String | A feladó email címe. |
| fromPhoneNumber | String | A feladó telefonszáma. |
| boundReasonCodes | String [ ] | A kötési ok kódok. |
| params | Param_V1 [ ] | Egyéb meta adatok. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| meta | JListMeta1 | A válaszhoz tartozó metaadatok. |
| list | JMessage9 [ ] | Megtalált üzenetek listája. |
Show message
Üzenet megtekintése az üzenet azonosítója alapján.
REST API
Kérés
GET hammy/json/query/v9/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 |
|---|---|
| JMessage9 | Megtalált üzenet. |
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/v9/messages/id/{{ID}}
| Név | Típus | Leírás |
|---|---|---|
| id | Long | A keresett üzenet id-ja. |
Válasz
| Típus | Leírás |
|---|---|
| JMessage9 | Megtalált üzenet. |
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/v9/messages/uuid/{{UUID}}
| Név | Típus | Leírás |
|---|---|---|
| uuid | String | A keresett üzenet uuid-ja. |
Válasz
| Típus | Leírás |
|---|---|
| JMessage9 | Megtalált üzenet. |
List error types
Ebben a verzióban nem változott.
Get domain perfs
Ebben a verzióban nem változott.
Utoljára frissítve
