Kihagyás

Reply API V1

HammyReplyAPI WSDL letöltése

Find replies

Válasz üzenetek keresése.

Web service API

Kérés

Név Típus Leírás
requestMeta RequestMeta_V1 A kérés metaadatai.
limit Integer A keresési találatok maximális száma.
offset Integer A találati lista kezdete.
fromAddress String Válasz üzenet feladója.
replyStatus String Válasz üzenet státusza.
createdAtFrom String Létrehozás dátuma ettől.
createdAtTo String Létrehozás dátuma eddig.
replyType String Válasz üzenet típusa.
receiverName String Válasz üzenetet feldolgozó entitás neve.
origin String A válasz üzenet forrása.

Válasz

Név Típus Leírás
status ResponseStatus_V1 A válasz státusza.
params Param_V1 [ ] Egyéb paraméterek listája.
total Integer Találatok száma.
replies WReply1 [ ] A megtalált válaszok.

Minta

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://hammy.dbx.hu/api/reply/v1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:findReplies>
         <request>
            <limit>3</limit>
            <origin>PRIMARY</origin>
         </request>
      </v1:findReplies>
   </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <S:Body xmlns:ns2="http://hammy.dbx.hu/api/reply/v1">
      <ns2:findRepliesResponse>
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <total>261</total>
            <replies>
               <reply>
                  <uuid>21</uuid>
                  <fromAddress>norepy@dbx.hu</fromAddress>
                  <replyStatus>HUMAN</replyStatus>
                  <createdAt>2020-05-05T12:21:17.240+02:00</createdAt>
                  <statusDescription>Ember által küldött válasz</statusDescription>
                  <replyType>SEND_API_REPLY</replyType>
                  <origin>PRIMARY</origin>
                  <messageUuid>c12cc186-7d84-4a2f-b1e3-7a80f786676e</messageUuid>
               </reply>
               <reply>
                  <uuid>22</uuid>
                  <fromAddress>norepy@dbx.hu</fromAddress>
                  <replyStatus>HUMAN</replyStatus>
                  <createdAt>2020-05-07T10:48:40.664+02:00</createdAt>
                  <statusDescription>Ember által küldött válasz</statusDescription>
                  <replyType>SEND_API_REPLY</replyType>
                  <origin>PRIMARY</origin>
                  <messageUuid>c12cc186-7d84-4a2f-b1e3-7a80f786676e</messageUuid>
               </reply>
               <reply>
                  <uuid>23</uuid>
                  <fromAddress>norepy@dbx.hu</fromAddress>
                  <replyStatus>HUMAN</replyStatus>
                  <createdAt>2020-05-07T11:06:08.179+02:00</createdAt>
                  <statusDescription>Ember által küldött válasz</statusDescription>
                  <replyType>SEND_API_REPLY</replyType>
                  <replyHash>b6d7fd01edcbe2db2b6edc7ad04d4d5e47e0afbfb8b40ee78b54185bf13f9664</replyHash>
                  <origin>PRIMARY</origin>
                  <messageUuid>c12cc186-7d84-4a2f-b1e3-7a80f786676e</messageUuid>
               </reply>
            </replies>
         </response>
      </ns2:findRepliesResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/reply/v1/replies

Paraméter Típus Leírás
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 hívó kliens azonosítója.
userName String A felhasználó neve.
params Param_V1 [ ] Egyéb meta adatok.
fromAddress String Válasz üzenet feladója.
statuses String [ ] Válasz üzenetek státuszai.
createdAtFrom String Létrehozás dátuma ettől.
createdAtTo String Létrehozás dátuma eddig.
replyType String Válasz üzenet típusa.
receiverName String Válasz üzenetet feldolgozó entitás neve.
origin String A válasz üzenet forrása.

Válasz

Név Típus Leírás
meta JListMeta1 A válaszhoz tartozó metaadatok.
list JReply1 [ ] A megtalált válaszok.

Minta

GET /json/reply/v1/replies?limit=3
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": "replies",
            "id": "21",
            "attributes": {
                "fromAddress": "norepy@dbx.hu",
                "status": "HUMAN",
                "createdAt": "2020-05-05T12:21:17.240+0200",
                "statusDescription": "Ember által küldött válasz",
                "replyType": "SEND_API_REPLY",
                "origin": "PRIMARY",
                "messageUuid": "c12cc186-7d84-4a2f-b1e3-7a80f786676e",
                "incomingMessageUuid": "56d557e9-b9a4-42bb-9270-04944aadfe78"
            }
        },
        {
            "type": "replies",
            "id": "22",
            "attributes": {
                "fromAddress": "norepy@dbx.hu",
                "status": "HUMAN",
                "createdAt": "2020-05-07T10:48:40.664+0200",
                "statusDescription": "Ember által küldött válasz",
                "replyType": "SEND_API_REPLY",
                "origin": "PRIMARY",
                "messageUuid": "c12cc186-7d84-4a2f-b1e3-7a80f786676e",
                "incomingMessageUuid": "1e083c59-f040-4e07-8ad4-ca2fd24e329c"
            }
        },
        {
            "type": "replies",
            "id": "23",
            "attributes": {
                "fromAddress": "norepy@dbx.hu",
                "status": "HUMAN",
                "createdAt": "2020-05-07T11:06:08.179+0200",
                "statusDescription": "Ember által küldött válasz",
                "replyType": "SEND_API_REPLY",
                "replyHash": "b6d7fd01edcbe2db2b6edc7ad04d4d5e47e0afbfb8b40ee78b54185bf13f9664",
                "origin": "PRIMARY",
                "messageUuid": "c12cc186-7d84-4a2f-b1e3-7a80f786676e",
                "incomingMessageUuid": "2b8bcb6e-f428-4e3d-b54c-8a318227784b"
            }
        }
    ],
    "meta": {
        "total": 414,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Show reply

Válasz üzenet lekérése.

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/reply/v1/replies/{{uuid}}

path

Név Típus Leírás
uuid String Válasz üzenet UUID-ja.

Válasz

Típus Leírás
JReply1 [ ] A megtalált válasz.

Minta

GET /json/reply/v1/replies/{{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": "replies",
        "id": "88",
        "attributes": {
            "fromAddress": "norepy@dbx.hu",
            "status": "HUMAN",
            "createdAt": "2020-06-17T15:06:41.794+0200",
            "statusDescription": "Ember által küldött válasz",
            "replyType": "SEND_API_REPLY",
            "replyHash": "cb8172b6efb196c257d9876423a2276174d7b44bca8155821c32253425b7477d",
            "origin": "PRIMARY",
            "messageUuid": "c12cc186-7d84-4a2f-b1e3-7a80f786676e",
            "incomingMessageUuid": "e6e47835-113c-4f39-8342-1b16ef358bfa"
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Show reply dump

Válasz üzenethez tartozó dump lekérése.

Web service API

Kérés

Név Típus Leírás
requestMeta RequestMeta_V1 A kérés metaadatai.
replyUuid String Válasz üzenet UUID-ja.

Válasz

Név Típus Leírás
status ResponseStatus_V1 A válasz státusza.
params Param_V1 [ ] Egyéb paraméterek listája.
replyDump WReplyDump1 A válasz dump.

Minta

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://hammy.dbx.hu/api/reply/v1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:showReplyDump>
         <request>
            <replyUuid>73</replyUuid>
         </request>
      </v1:showReplyDump>
   </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <S:Body xmlns:ns2="http://hammy.dbx.hu/api/reply/v1">
      <ns2:showReplyDumpResponse>
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <replyDump>
               <replyUuid>73</replyUuid>
               <dump>Return-Path: &lt;test@test.hu>
X-Original-To: barni@example.com
Delivered-To: barni@example.com
Received: from localhost (localhost [127.0.0.1])
    by example.com (Postfix) with SMTP id 00E967E2C2B
    for &lt;barni@example.com>; Mon, 25 May 2020 16:21:58 +0200 (CEST)
Subject: Test subject {customer@customer.com}
Reply-To: replyto@to.com
Message-Id: &lt;20200525142207.00E967E2C2B@example.com>
Date: Mon, 25 May 2020 16:21:58 +0200 (CEST)
From: test@test.hu

Hello</dump>
            </replyDump>
         </response>
      </ns2:showReplyDumpResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/reply/v1/replyDumps/{{replyUuid}}

Név Típus Leírás
replyUuid String Válasz üzenet UUID-ja.

Válasz

Típus Leírás
JReplyDump1 A válasz dump.

Minta

GET /json/reply/v1/replyDumps/{{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": "replyDumps",
        "id": "73",
        "attributes": {
            "dump": "Return-Path: <test@test.hu>\nX-Original-To: barni@example.com\nDelivered-To: barni@example.com\nReceived: from localhost (localhost [127.0.0.1])\n\tby example.com (Postfix) with SMTP id 00E967E2C2B\n\tfor <barni@example.com>; Mon, 25 May 2020 16:21:58 +0200 (CEST)\nSubject: Test subject {customer@customer.com}\nReply-To: replyto@to.com\nMessage-Id: <20200525142207.00E967E2C2B@example.com>\nDate: Mon, 25 May 2020 16:21:58 +0200 (CEST)\nFrom: test@test.hu\n\nHello\n\n"
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Get statuses

Válasz státuszok lekérdezése.

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/reply/v1/statuses

Válasz

Név Típus Leírás
meta JListMeta1 A válaszhoz tartozó metaadatok.
list JReplyStatus1 [ ] A megtalált státuszok.

Minta

GET: /hammy/json/reply/v1/statuses
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": "replyStatuses",
      "id": "14553c0a-53be-4781-9337-9f88dd7defe1",
      "attributes": {
        "status": "ALIEN",
        "description": "Kimenő üzenet pár nem található"
      }
    },
    {
      "type": "replyStatuses",
      "id": "59c2211d-428a-4d13-b42a-48b57d78248f",
      "attributes": {
        "status": "HUMAN",
        "description": "Ember által küldött válasz"
      }
    },
    {
      "type": "replyStatuses",
      "id": "a1adb745-5178-45b3-be90-24236583ad2c",
      "attributes": {
        "status": "AUTO_REPLY",
        "description": "Automatikus válasz"
      }
    },
    {
      "type": "replyStatuses",
      "id": "ddabeb1c-7ca1-4abb-9e5c-0af73480fb85",
      "attributes": {
        "status": "PROBABLY_REPLY",
        "description": "Feltehetőleg válasz"
      }
    },
    {
      "type": "replyStatuses",
      "id": "83423f65-ab63-43b5-af73-9e7629485a20",
      "attributes": {
        "status": "UNIDENTIFIED",
        "description": "A levél kézbesítése ismeretlen okból meghiúsult"
      }
    },
    {
      "type": "replyStatuses",
      "id": "ec1c1d58-afa6-44ea-8822-101ae0b338ab",
      "attributes": {
        "status": "WRONG_ADDRESS",
        "description": "A kiküldés sikertelen, a cím hibás"
      }
    },
    {
      "type": "replyStatuses",
      "id": "dd0ab373-0056-41d7-9095-26f970277051",
      "attributes": {
        "status": "WRONG_PHONE_NUMBER",
        "description": "A kiküldés sikertelen. A telefonszám hibás"
      }
    },
    {
      "type": "replyStatuses",
      "id": "00621c54-e175-4f7c-9350-45dff044fd8f",
      "attributes": {
        "status": "WRONG_PSID",
        "description": "A kiküldés sikertelen. A PSID hibás"
      }
    },
    {
      "type": "replyStatuses",
      "id": "020ae4cd-bb94-4bbf-9a27-d30a46b6f160",
      "attributes": {
        "status": "DUMPED",
        "description": "Tartalom tárolva"
      }
    },
    {
      "type": "replyStatuses",
      "id": "c6987b85-cd5a-4cd0-81a4-cdacd849cf48",
      "attributes": {
        "status": "PENDING",
        "description": "Tartalom tárolása folyamatban"
      }
    },
    {
      "type": "replyStatuses",
      "id": "03c50a49-372b-4c80-a113-a6aa0314502c",
      "attributes": {
        "status": "FORWARD_BOUNCE",
        "description": "Továbbítás sikertelen"
      }
    },
    {
      "type": "replyStatuses",
      "id": "cce1ace5-7b96-4cf3-a361-37b46eed1c87",
      "attributes": {
        "status": "FORWARD_BOUNCE",
        "description": "Továbbítás sikertelen!"
      }
    },
    {
      "type": "replyStatuses",
      "id": "4fedec4e-c4fe-4aa6-a5be-10091719298c",
      "attributes": {
        "status": "STORAGE_EXCEEDED",
        "description": "A postafiók megtelt!"
      }
    },
    {
      "type": "replyStatuses",
      "id": "224b6fd9-1539-4f36-a038-54477bd1357d",
      "attributes": {
        "status": "INVALID_MAILBOX",
        "description": "Érvénytelen postafiók!"
      }
    },
    {
      "type": "replyStatuses",
      "id": "d5a39501-99e0-40a9-89fb-cf9260efb436",
      "attributes": {
        "status": "BLAME_IT_ON_WEATHER",
        "description": "Tranzakciós hiba lépett fel a kézbesítés során!"
      }
    },
    {
      "type": "replyStatuses",
      "id": "7c75e59d-b325-4e70-9a35-16750178c395",
      "attributes": {
        "status": "NO_MAILBOX",
        "description": "Nem létező postafiók!"
      }
    },
    {
      "type": "replyStatuses",
      "id": "3f3a9a90-6025-4846-a9f9-de668e3207a0",
      "attributes": {
        "status": "NO_CONNECTION",
        "description": "A címzett SMTP szerveréhez való kapcsolódás sikertelen!"
      }
    },
    {
      "type": "replyStatuses",
      "id": "ad4ba2c8-e71d-402f-a728-b4d76f4db5d7",
      "attributes": {
        "status": "NO_ROUTE",
        "description": "Nem található útvonal a címzett kiszolgálója felé!"
      }
    },
    {
      "type": "replyStatuses",
      "id": "10cd7d1d-2f1f-47d0-a703-789e0b8a3b84",
      "attributes": {
        "status": "DELIVERY_TIME_EXPIRED",
        "description": "Kézbesítési idő lejárt!"
      }
    },
    {
      "type": "replyStatuses",
      "id": "0a0aa391-7b2c-4c4d-8c14-fb1cb82cc485",
      "attributes": {
        "status": "AUTO_REPLY",
        "description": "Automatikus válasz"
      }
    },
    {
      "type": "replyStatuses",
      "id": "aa9817ce-c4d8-4726-9350-4c74e8cae940",
      "attributes": {
        "status": "REFUSED",
        "description": "A kézbesítés visszautasítva!"
      }
    },
    {
      "type": "replyStatuses",
      "id": "6e8d7318-c013-41df-9d70-fce467ee6b41",
      "attributes": {
        "status": "STATE",
        "description": "státusz leírás"
      }
    }
  ],
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}