Reply Matcher API V1

HammyReplyMatcher1API WSDL letöltése

Find reply matchers

Válasz mintaillesztők 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.
uuid	String	Válasz mintaillesztő UUID-ja.
status	String [ ]	[DEPRECATED] Válaszok státuszai.
createdAtFrom	Date	Létrehozás dátuma ettől.
createdAtTo	Date	Létrehozás dátuma eddig.
updatedAtFrom	Date	Utolsó módosítás dátuma ettől.
updatedAtTo	Date	Utolsó módosítás dátuma eddig.

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.
replyMatchers	WReplyMatcher_V1 [ ]	A találatok listája.
count	Integer	Találatok száma.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.service.replymatcher.api.hammy.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <ws:findReplyMatchers>
            <request>
                <requestMeta>
                <clientHashKey>?</clientHashKey>
                <userName>Y</userName>
                </requestMeta>
                <limit>10</limit>
                <!--Optional:-->
                <offset>0</offset>
                <!--<uuid>?</uuid>-->
                <!--<name>?</name>-->
                <statuses>NO_MAILBOX</statuses>
                <!--<createdAtFrom>?</createdAtFrom>-->
                <!--<createdAtTo>?</createdAtTo>-->
                <!--<updatedAtFrom>?</updatedAtFrom>-->
                <!--<updatedAtTo>?</updatedAtTo>-->
            </request>
        </ws:findReplyMatchers>
    </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://ws.service.replymatcher.api.hammy.dbx.hu/">
        <ns2:findReplyMatchersResponse>
            <response>
                <status>
                <code>0</code>
                <messages/>
                </status>
                <replyMatchers>
                <uuid>1</uuid>
                <status>NO_MAILBOX</status>
                <statusDescription>Nem létező postafiók!</statusDescription>
                <replyExpressions>
                    <expression>(DELIVERY FAILURE:|ERROR|STATUS:) (550|511|5.1.1)</expression>
                </replyExpressions>
                <replyExpressions>
                    <expression>DIAGNOSTIC-CODE: .* SAID: 550</expression>
                </replyExpressions>
                </replyMatchers>
            </response>
        </ns2:findReplyMatchersResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/replyMatcher/v1/replyMatchers

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.
id	String	A mintaillesztő ID-ja.
statuses	String [ ]	[DEPRECATED] Válaszok státuszai.
createdAtFrom	Date	Létrehozás dátuma ettől.
createdAtTo	Date	Létrehozás dátuma eddig.
updatedAtFrom	Date	Utolsó módosítás dátuma ettől.
updatedAtTo	Date	Utolsó módosítás dátuma eddig.
priority	Integer	Válasz minta prioritása.
isSoft	Boolean	Válasz minta jellege SOFT-e.

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
list	JReplyMatcher1 [ ]	A megtalált mintaillesztők.

Minta

KérésVálasz

GET {{baseUrl}}/json/replyMatcher/v1/replyMatchers?createdAtTo=2019-07-20&statuses%5B%5D=REFUSED
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": "replyMatchers",
            "id": "9",
            "attributes": {
                "createdAt": "2019-07-28T15:39:38.476+0000",
                "updatedAt": "2019-09-10T06:08:09.635+0000",
                "status": "REFUSED",
                "statusDescription": "A kézbesítés visszautasítva vala!",
                "replyExpressions": [
                    {
                        "expression": "(DELIVERY FAILURE:|ERROR|STATUS:) (5.7.1|571)",
                        "createdAt": "2019-07-29T15:39:38.481+0000",
                        "updatedAt": "2019-07-29T15:39:38.481+0000"
                    }
                ]
            }
        }
    ],
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Create reply matcher

Válasz mintaillesztő létrehozása.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
replyMatcher	WReplyMatcher_V1	A létrehozandó mintaillesztő.

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.
replyMatcher	WReplyMatcher_V1	A létrehozott mintaillesztő.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.service.replymatcher.api.hammy.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <ws:createReplyMatcher>
            <request>
                <requestMeta>
                <clientHashKey>?</clientHashKey>
                <userName>?</userName>
                <!--<params>
                    <param>
                        <key>?</key>
                        <value>?</value>
                        <ref>?</ref>
                    </param>
                </params>-->
                </requestMeta>
                <replyMatcher>
                <uuid>1</uuid>
                <status>NO_MAILBOX</status>
                <statusDescription>Nem létező postafiók!</statusDescription>
                <replyExpressions>
                    <expression>(DELIVERY FAILURE:|ERROR|STATUS:) (550|511|5.1.1)</expression>
                </replyExpressions>
                <replyExpressions>
                    <expression>DIAGNOSTIC-CODE: .* SAID: 550</expression>
                </replyExpressions>
                </replyMatcher>
            </request>
        </ws:createReplyMatcher>
    </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://ws.service.replymatcher.api.hammy.dbx.hu/">
        <ns2:createReplyMatcherResponse>
            <response>
                <status>
                <code>0</code>
                <messages/>
                </status>
                <replyMatcher>
                <uuid>1</uuid>
                <createdAt>2019-04-10T11:24:26.201+02:00</createdAt>
                <updatedAt>2019-04-10T11:24:46.556+02:00</updatedAt>
                <status>NO_MAILBOX</status>
                <statusDescription>Nem létező postafiók!</statusDescription>
                <replyExpressions>
                    <expression>(DELIVERY FAILURE:|ERROR|STATUS:) (550|511|5.1.1)</expression>
                </replyExpressions>
                <replyExpressions>
                    <expression>DIAGNOSTIC-CODE: .* SAID: 550</expression>
                </replyExpressions>
                </replyMatcher>
            </response>
        </ns2:createReplyMatcherResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/replyMatcher/v1/replyMatchers

body: JReplyMatcher1

Válasz

Típus	Leírás
JReplyMatcher1	A létrehozott mintaillesztő.

Minta

KérésVálasz

POST {{baseUrl}}/json/replyMatcher/v1/replyMatchers
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "replyMatchers",
        "id": "78348957-23d1-4493-b959-d2891603e38d",
        "attributes": {
            "name": "TestReplyMatcherWithExpressions2",
            "status": "BLAME_IT_ON_WEATHER",
            "statusDescription": "Status Description",
            "bounceCount": 3,
            "resendIntervalInHours": 2,
            "priority": 4,
            "soft": false,
            "replyExpressions": [
                    {
                        "expression": "this\\s+is\\s+text"
                    },
                    {
                        "expression": "Status: 5.2.2"
                    },
                    {
                        "expression": "^\\d+(\\.\\d+)?"
                    }
                ]
        }
    }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "replyMatchers",
        "id": "78348957-23d1-4493-b959-d2891603e38d",
        "attributes": {
            "name": "TestReplyMatcherWithExpressions2",
            "createdAt": "2020-11-19T10:18:08.129+0100",
            "updatedAt": "2021-01-18T14:56:05.472+0100",
            "status": "BLAME_IT_ON_WEATHER",
            "statusDescription": "Status Description",
            "bounceCount": 3,
            "resendIntervalInHours": 2,
            "priority": 4,
            "replyExpressions": [
                {
                    "expression": "this\\s+is\\s+text",
                    "createdAt": "2020-11-19T10:18:08.126+0100",
                    "updatedAt": "2020-11-19T10:18:08.138+0100"
                },
                {
                    "expression": "Status: 5.2.2",
                    "createdAt": "2020-11-19T10:18:08.126+0100",
                    "updatedAt": "2020-11-19T10:18:08.138+0100"
                },
                {
                    "expression": "^\\d+(\\.\\d+)?",
                    "createdAt": "2020-11-19T10:18:08.126+0100",
                    "updatedAt": "2020-11-19T10:18:08.139+0100"
                }
            ],
            "soft": false
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Update reply matcher

Válasz mintaillesztő módosítása.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
replyMatcher	WReplyMatcher_V1	A módosítandó mintaillesztő.

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.
replyMatcher	WReplyMatcher_V1	A módosított mintaillesztő.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.service.replymatcher.api.hammy.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <ws:updateReplyMatcher>
            <request>
                <requestMeta>
                <clientHashKey>?</clientHashKey>
                <userName>?</userName>
                <!--<params>
                    <param>
                        <key>?</key>
                        <value>?</value>
                        <ref>?</ref>
                    </param>
                </params>-->
                </requestMeta>
                <replyMatcher>
                <uuid>1</uuid>
                <status>NO_MAILBOX</status>
                <statusDescription>Nem létező postafiók!</statusDescription>
                <replyExpressions>
                    <expression>(DELIVERY FAILURE:|ERROR|STATUS:) (550|511|5.1.1)</expression>
                </replyExpressions>
                <replyExpressions>
                    <expression>DIAGNOSTIC-CODE: .* SAID: 550</expression>
                </replyExpressions>
                </replyMatcher>
            </request>
        </ws:updateReplyMatcher>
    </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://ws.service.replymatcher.api.hammy.dbx.hu/">
        <ns2:updateReplyMatcherResponse>
            <response>
                <status>
                <code>0</code>
                <messages/>
                </status>
                <replyMatcher>
                <uuid>1</uuid>
                <createdAt>2019-04-10T11:24:26.201+02:00</createdAt>
                <updatedAt>2019-04-10T11:24:46.556+02:00</updatedAt>
                <status>NO_MAILBOX</status>
                <statusDescription>Nem létező postafiók!</statusDescription>
                <replyExpressions>
                    <expression>(DELIVERY FAILURE:|ERROR|STATUS:) (550|511|5.1.1)</expression>
                </replyExpressions>
                <replyExpressions>
                    <expression>DIAGNOSTIC-CODE: .* SAID: 550</expression>
                </replyExpressions>
                </replyMatcher>
            </response>
        </ns2:updateReplyMatcherResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

PUT hammy/json/replyMatcher/v1/replyMatchers/{{uuid}}

body: JReplyMatcher1

path

Név	Típus	Leírás
uuid	String	A módosítandó illesztő UUID-ja.

Válasz

Típus	Leírás
JReplyMatcher1	A módosított mintaillesztő.

Minta

KérésVálasz

PUT {{baseUrl}}/json/replyMatcher/v1/replyMatchers/{{uuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
    "data": 
        {
            "type": "replyMatchers",
            "id": "{{uuid}}",
            "attributes": {
                "createdAt": "2019-07-29T15:39:38.476+0000",
                "updatedAt": "2019-07-29T15:39:38.476+0000",
                "status": "REFUSED",
                "statusDescription": "A kézbesítés visszautasítva vala!",
                "replyExpressions": [
                    {
                        "expression": "(DELIVERY FAILURE:|ERROR|STATUS:) (5.7.1|571)",
                        "createdAt": "2019-07-29T15:39:38.481+0000",
                        "updatedAt": "2019-07-29T15:39:38.481+0000"
                    }
                ]
            }
        }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "replyMatchers",
        "id": "9",
        "attributes": {
            "createdAt": "2019-07-19T15:39:38.476+0000",
            "updatedAt": "2019-08-09T10:09:23.531+0000",
            "status": "REFUSED",
            "statusDescription": "A kézbesítés visszautasítva vala!",
            "replyExpressions": [
                {
                    "expression": "(DELIVERY FAILURE:|ERROR|STATUS:) (5.7.1|571)",
                    "createdAt": "2019-07-19T15:39:38.481+0000",
                    "updatedAt": "2019-07-19T15:39:38.481+0000"
                }
            ]
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}