Campaign API V1

HammyCampaign1API WSDL letöltése

Show campaign

Visszaadja a megadott azonosítójú kampányt.

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/campaign/v1/campaigns/{{uuid}}

Név	Típus	Leírás
uuid	String	A keresett kampány UUID-ja.

Válasz

Típus	Leírás
JCampaign1	A keresett kampány adatai.

Minta

KérésVálasz

GET /hammy/json/campaign/v1/campaigns/{{campaignUuid}}
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": "campaigns",
        "id": "c798c680-162b-4aaa-a4c8-edd1bb87688b",
        "attributes": {
            "createdAt": "2020-02-19T09:40:31.055+0100",
            "numOfCampaignParts": 2
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Find campaigns

Kampányok 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 találatok maximális száma.
offset	Integer	A találati lista kezdete.
title	String	A kampány címe.
createdBy	String	A kampányt létrehozó felhasználó neve.
createdAtFrom	Date	A kampány létrehozásának kezdete.
createdAtTo	Date	A kampány létrehozásának vége.
closedAtFrom	Date	A kampány zárási kérelmének kezdete.
closedAtTo	Date	A kampány zárási kérelmének vége.
scheduledAtFrom	Date	A kampányhoz tartozó kampány rész ütemezési idejének kezdete.
scheduledAtTo	Date	A kampányhoz tartozó kampány rész ütemezési idejének vége.
comment	String	A kampányhoz tartozó megjegyzés.
closed	Boolean	Megadja, hogy vége van-e a kampánynak.

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	A találatok száma.
campaigns	WCampaign1 [ ]	A megtalált kampányok adatai.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://hammy.dbx.hu/api/campaign/v1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:findCampaigns>
         <!--Optional:-->
         <request>
            <!--Optional:-->
            <requestMeta>
               <!--Optional:-->
               <clientHashKey>221d316146c591897238</clientHashKey>
               <!--Optional:-->
               <userName>admin</userName>
               <!--Optional:-->
               <params>
                  <!--Zero or more repetitions:-->
                  <param>
                     <key>?</key>
                     <value>?</value>
                     <!--Optional:-->
                     <ref>?</ref>
                  </param>
               </params>
            </requestMeta>
            <!--Optional:-->
            <limit>2</limit>
            <!--Optional:-->
            <offset>?</offset>
            <!--Optional:-->
            <title>?</title>
            <!--Optional:-->
            <createdBy>?</createdBy>
            <!--Optional:-->
            <createdAtFrom>?</createdAtFrom>
            <!--Optional:-->
            <createdAtTo>?</createdAtTo>
            <!--Optional:-->
            <closedAtFrom>?</closedAtFrom>
            <!--Optional:-->
            <closedAtTo>?</closedAtTo>
            <!--Optional:-->
            <scheduledAtFrom>?</scheduledAtFrom>
            <!--Optional:-->
            <scheduledAtTo>?</scheduledAtTo>
            <!--Optional:-->
            <comment>?</comment>
            <!--Optional:-->
            <closed>?</closed>
         </request>
      </v1:findCampaigns>
   </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/campaign/v1" xmlns:ns3="http://hammy.dbx.hu/model/campaign/v1">
      <ns2:findCampaignsResponse>
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <total>489</total>
            <campaigns>
               <campaign>
                  <uuid>?</uuid>
                  <title>trialCampaign</title>
                  <description>Ez egy próba kampány</description>
                  <createdBy>admin</createdBy>
                  <createdAt>2021-06-10T09:11:41.859+02:00</createdAt>
                  <comment>?</comment>
                  <numOfCampaignParts>0</numOfCampaignParts>
               </campaign>
               <campaign>
                  <uuid>f3e304bd-5648-44b2-b670-19b6176cd499</uuid>
                  <title>trialCampaign</title>
                  <description>Ez egy próba kampány</description>
                  <createdBy>admin</createdBy>
                  <createdAt>2021-06-10T09:09:28.107+02:00</createdAt>
                  <numOfCampaignParts>0</numOfCampaignParts>
               </campaign>
            </campaigns>
         </response>
      </ns2:findCampaignsResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/campaign/v1/campaigns

Paraméter	Típus	Leírás
title	String	A kampány címe.
createdBy	String	A kampányt létrehozó felhasználó neve.
createdAtFrom	Date	A kampány létrehozásának kezdete.
createdAtTo	Date	A kampány létrehozásának vége.
closedAtFrom	Date	A kampány zárási kérelmének kezdete.
closedAtTo	Date	A kampány zárási kérelmének vége.
scheduledAtFrom	Date	A kampányhoz tartozó kampány rész ütemezési idejének kezdete.
scheduledAtTo	Date	A kampányhoz tartozó kampány rész ütemezési idejének vége.
comment	String	A kampányhoz tartozó megjegyzés.
closed	Boolean	Megadja, hogy vége van-e a kampánynak.
limit	Integer	A találatok maximális száma.
sort	String	A találatok rendezése.
offset	Integer	A találati lista kezdete.
clientHashKey	String	A hívó kliens azonosítója.
params	Param_V1 [ ]	Egyéb paraméterek listája.
userName	String	A felhasználó neve.

Válasz

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

Minta

KérésVálasz

GET {{baseUrl}}/json/campaign/v1/campaigns?createdAtFrom=2022-07-14&createdAtTo=2022-07-17
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": "campaigns",
            "id": "1ef1f237-102b-4d32-9abf-145569cd3110",
            "attributes": {
                "title": "Szegmentálás teszt (esemény alapú)",
                "createdBy": "admin",
                "createdAt": "2022-07-14T12:46:31.706+02:00",
                "numOfCampaignParts": 2
            }
        },
        {
            "type": "campaigns",
            "id": "4c764ca0-c8d4-49c6-bb6f-2cd90aec72ed",
            "attributes": {
                "title": "szcenárió teszt",
                "createdBy": "admin",
                "createdAt": "2022-07-14T12:24:08.823+02:00",
                "numOfCampaignParts": 4
            }
        }
    ],
    "meta": {
        "total": 2,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Create campaign

Kampány létrehozása.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A híváshoz kapcsolódó metaadatok.
campaign	WCampaign1	Létrehozandó kampány adatai.

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.
campaign	WCampaign1	A létrehozott kampány adatai.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://hammy.dbx.hu/api/campaign/v1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:createCampaign>
         <!--Optional:-->
         <request>
            <!--Optional:-->
            <requestMeta>
               <!--Optional:-->
               <clientHashKey>221d316146c591897238</clientHashKey>
               <!--Optional:-->
               <userName>admin</userName>
               <!--Optional:-->
               <params>
                  <!--Zero or more repetitions:-->
                  <param>
                     <key>?</key>
                     <value>?</value>
                     <!--Optional:-->
                     <ref>?</ref>
                  </param>
               </params>
            </requestMeta>
            <campaign>
               <!--Optional: -->
             <uuid>?</uuid>
               <!--Optional:-->
               <title>trialCampaign</title>
               <!--Optional:-->
               <description>Ez egy próba kampány</description>
               <!--Optional:-->
               <createdBy>?</createdBy>
               <!--Optional:-->
               <createdAt>?</createdAt>
               <!--Optional:-->
               <closedAt>?</closedAt>
               <!--Optional:-->
               <comment>?</comment>
               <!--Optional:-->
               <numOfCampaignParts>?</numOfCampaignParts>
            </campaign>
         </request>
      </v1:createCampaign>
   </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/campaign/v1" xmlns:ns3="http://hammy.dbx.hu/model/campaign/v1">
      <ns2:createCampaignResponse>
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <campaign>
               <uuid>f3e304bd-5648-44b2-b670-19b6176cd499</uuid>
               <title>trialCampaign</title>
               <description>Ez egy próba kampány</description>
               <createdBy>admin</createdBy>
               <numOfCampaignParts>0</numOfCampaignParts>
            </campaign>
         </response>
      </ns2:createCampaignResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/campaign/v1/campaigns

Név	Típus	Leírás
uuid	String	Kampány UUID azonosító. (vnd.api ID)
title	String	A kampány neve.
createdBy	String	A kampányt létrehozó felhasználó neve.
description	String	A kampány szabad szöveges leírása.
createdAt	Date	A kampány létrehozásának ideje.
closedAt	Date	A kampány befejezésének ideje.
comment	String	A kampányhoz fűzött megjegyzés.
numOfCampaignParts	Integer	A kampányhoz tartozó kampány részek száma.

Válasz

Típus	Leírás
JCampaign1	A létrehozott kampány adatai.

Minta

KérésVálasz

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

{
    "data": {
            "id": "uuid1",
            "type": "campaigns",
            "attributes": {
                "title": "Teszt kampány"
            }
    }
}

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

{
    "data": {
        "type": "campaigns",
        "id": "uuid1",
        "attributes": {
            "title": "Teszt kampány",
            "createdBy": "admin",
            "numOfCampaignParts": 0
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Update campaign

Kampány módosítása.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A híváshoz kapcsolódó metaadatok.
campaign	WCampaign1	Módosítandó kampány adatai.

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.
campaign	WCampaign1	A módosított kampány adatai.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://hammy.dbx.hu/api/campaign/v1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:updateCampaign>
         <!--Optional:-->
         <request>
            <!--Optional:-->
            <requestMeta>
               <!--Optional:-->
               <clientHashKey>221d316146c591897238</clientHashKey>
               <!--Optional:-->
               <userName>admin</userName>
               <!--Optional:-->
               <params>
                  <!--Zero or more repetitions:-->
                  <param>
                     <key>?</key>
                     <value>?</value>
                     <!--Optional:-->
                     <ref>?</ref>
                  </param>
               </params>
            </requestMeta>
            <campaign>
               <!--Optional:-->
               <uuid>f3e304bd-5648-44b2-b670-19b6176cd499</uuid>
               <!--Optional:-->
              <title>trialCampaign</title>
               <!--Optional:-->
               <description>Ez már nem csak egy próba kampány</description>
               <!--Optional:-->
               <createdBy>?</createdBy>
               <!--Optional:-->
               <createdAt>?</createdAt>
               <!--Optional:-->
               <closedAt>?</closedAt>
               <!--Optional:-->
               <comment>?</comment>
               <!--Optional:-->
               <numOfCampaignParts>?</numOfCampaignParts>
            </campaign>
         </request>
      </v1:updateCampaign>
   </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/campaign/v1" xmlns:ns3="http://hammy.dbx.hu/model/campaign/v1">
      <ns2:updateCampaignResponse>
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <campaign>
               <uuid>f3e304bd-5648-44b2-b670-19b6176cd499</uuid>
               <title>trialCampaign</title>
               <description>Ez már nem csak egy próba kampány</description>
               <createdBy>admin</createdBy>
               <createdAt>2021-06-10T09:09:28.107+02:00</createdAt>
               <numOfCampaignParts>0</numOfCampaignParts>
            </campaign>
         </response>
      </ns2:updateCampaignResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

PUT hammy/json/campaign/v1/campaigns/{{uuid}}

body: JCampaign1

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

Válasz

Típus	Leírás
JCampaign1	A módosított kampány adatai.

Minta

KérésVálasz

PUT /hammy/json/campaign/v1/campaigns/{{campaignUuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
    "data": {
            "id": "uuid1",
            "type": "campaigns",
            "attributes": {
                "title": "Teszt kampány"
            }
    }
}

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

{
    "data": {
        "type": "campaigns",
        "id": "uuid1",
        "attributes": {
            "title": "Teszt kampány",
            "createdBy": "admin",
            "createdAt": "2020-09-15T11:07:31.121+0000",
            "numOfCampaignParts": 0
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Show campaign part

Kampányelem 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/campaign/campaignParts/{{uuid}}

Név	Típus	Leírás
uuid	String	A keresett kampányelem UUID-ja.

Válasz

Típus	Leírás
JCampaignPart1	A keresett kampányelem adatai.

Minta

KérésVálasz

GET /hammy/json/campaign/v1/campaignsParts/{{campaignPartUuid}}
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": "campaignParts",
        "id": "cap-000002",
        "attributes": {
            "campaignUuid": "ee8b1205-4dab-402a-94f5-b520104c5cde",
            "fromEmailAddress": "sample2@example.com",
            "fromName": "Sam Sample 2",
            "replyToEmailAddress": "reply2@example.com",
            "replyToName": "Customer Service 2",
            "supervisorEmailAddress": "supervisor2@example.com",
            "title": "Example campaign part 2",
            "description": "This is just an example campaign part2.",
            "status": "DRAFT",
            "considerUnsubscribed": false,
            "createdBy": "admin",
            "createdAt": "2021-04-06T11:26:41.382+0200",
            "assetDeliveryMode": "INLINE"
        },
        "relationships": {
            "segmentRules": {
                "data": []
            },
            "contents": {
                "data": []
            }
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Find campaign parts

Kampányelemek 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 találatok maximális száma.
offset	Integer	A találati lista kezdete.
campaignUuid	String	A kampány UUID-ja.
scheduledAtFrom	Date	A kampány ütemezett idejének kezdete.
scheduledAtTo	Date	A kampány ütemezett idejének vége.

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	A találatok száma.
campaignParts	WCampaignPart1 [ ]	A megtalált kampányrészek adatai.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://hammy.dbx.hu/api/campaign/v1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:findCampaignParts>
         <!--Optional:-->
         <request>
            <!--Optional:-->
            <requestMeta>
               <!--Optional:-->
               <clientHashKey>221d316146c591897238</clientHashKey>
               <!--Optional:-->
               <userName>admin</userName>
               <!--Optional:-->
               <params>
                  <!--Zero or more repetitions:-->
                  <param>
                     <key>?</key>
                     <value>?</value>
                     <!--Optional:-->
                     <ref>?</ref>
                  </param>
               </params>
            </requestMeta>
            <!--Optional:-->
            <limit>2</limit>
            <!--Optional:-->
            <offset>0</offset>
            <!--Optional:-->
            <campaignUuid>?</campaignUuid>
            <!--Optional:-->
            <scheduledAtFrom>?</scheduledAtFrom>
            <!--Optional:-->
            <scheduledAtTo>?</scheduledAtTo>
         </request>
      </v1:findCampaignParts>
   </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/campaign/v1" xmlns:ns3="http://hammy.dbx.hu/model/campaign/v1">
      <ns2:findCampaignPartsResponse>
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <total>8</total>
            <campaignParts>
               <campaignPart>
                  <uuid>cap-000038</uuid>
                  <campaignUuid>af45c231-f2f1-48a7-b680-1485b1211ca4</campaignUuid>
                  <campaignPartType>SENDING</campaignPartType>
                  <fromEmailAddress>sample2@example.com</fromEmailAddress>
                  <fromName>Sam Sample 2</fromName>
                  <replyToEmailAddress>reply2@example.com</replyToEmailAddress>
                  <replyToName>Customer Service 2</replyToName>
                  <supervisorEmailAddress>supervisor2@example.com</supervisorEmailAddress>
                  <title>Example campaign part 2</title>
                  <description>This is just an example campaign part2.</description>
                  <status>DRAFT</status>
                  <considerUnsubscribed>false</considerUnsubscribed>
                  <createdBy>admin</createdBy>
                  <createdAt>2021-06-07T13:51:56.131+02:00</createdAt>
                  <assetDeliveryMode>INLINE</assetDeliveryMode>
                  <segmentRules/>
                  <contents>
                     <content>
                        <uuid>cac000001-3</uuid>
                        <messageType>Üres_próba</messageType>
                        <scenarioName>GIVENNAME</scenarioName>
                        <totalOpens>0</totalOpens>
                        <uniqueOpens>0</uniqueOpens>
                        <totalClicks>0</totalClicks>
                        <uniqueClicks>0</uniqueClicks>
                        <properties/>
                     </content>
                  </contents>
               </campaignPart>
               <campaignPart>
                  <uuid>cap-000036</uuid>
                  <campaignUuid>af45c231-f2f1-48a7-b680-1485b1211ca4</campaignUuid>
                  <campaignPartType>SENDING</campaignPartType>
                  <fromEmailAddress>sample2@example.com</fromEmailAddress>
                  <fromName>Sam Sample 2</fromName>
                  <replyToEmailAddress>reply2@example.com</replyToEmailAddress>
                  <replyToName>Customer Service 2</replyToName>
                  <supervisorEmailAddress>supervisor2@example.com</supervisorEmailAddress>
                  <title>Example campaign part 2</title>
                  <description>This is just an example campaign part2.</description>
                  <status>DRAFT</status>
                  <considerUnsubscribed>false</considerUnsubscribed>
                  <createdBy>admin</createdBy>
                  <createdAt>2021-06-07T13:51:18.949+02:00</createdAt>
                  <assetDeliveryMode>INLINE</assetDeliveryMode>
                  <segmentRules/>
                  <contents>
                     <content>
                        <uuid>cac000001-2</uuid>
                        <messageType>Üres_próba</messageType>
                        <scenarioName>GIVENNAME</scenarioName>
                        <subject>Teszt</subject>
                        <totalOpens>0</totalOpens>
                        <uniqueOpens>0</uniqueOpens>
                        <totalClicks>0</totalClicks>
                        <uniqueClicks>0</uniqueClicks>
                        <properties/>
                     </content>
                  </contents>
               </campaignPart>
            </campaignParts>
         </response>
      </ns2:findCampaignPartsResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/campaign/v1/campaignParts

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
list	JCampaignPart1 [ ]	A megtalált kampányrészek.

Minta

KérésVálasz

GET {{baseUrl}}/json/campaign/v1/campaignParts?campaignUuid={{campaignUuid}}
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": "campaignParts",
            "id": "cap-000002",
            "attributes": {
                "campaignUuid": "ee8b1205-4dab-402a-94f5-b520104c5cde",
                "fromEmailAddress": "sample2@example.com",
                "fromName": "Sam Sample 2",
                "replyToEmailAddress": "reply2@example.com",
                "replyToName": "Customer Service 2",
                "supervisorEmailAddress": "supervisor2@example.com",
                "title": "Example campaign part 2",
                "description": "This is just an example campaign part2.",
                "status": "DRAFT",
                "considerUnsubscribed": false,
                "createdBy": "admin",
                "createdAt": "2021-04-06T11:26:41.382+0200",
                "assetDeliveryMode": "INLINE"
            },
            "relationships": {
                "segmentRules": {
                    "data": []
                },
                "contents": {
                    "data": []
                }
            }
        }
    ],
    "meta": {
        "total": 1,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Create campaign part

Kampányelem létrehozása.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A híváshoz kapcsolódó metaadatok.
campaignPart	WCampaignPart1	Létrehozandó kampányelem adatai.

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.
campaignPart	WCampaignPart1	A létrehozott kampányelem adatai.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://hammy.dbx.hu/api/campaign/v1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:createCampaignPart>
         <!--Optional:-->
         <request>
            <!--Optional:-->
            <requestMeta>
               <!--Optional:-->
               <clientHashKey>221d316146c591897238</clientHashKey>
               <!--Optional:-->
               <userName>admin</userName>
               <!--Optional:-->
               <params>
                  <!--Zero or more repetitions:-->
                  <param>
                     <key>?</key>
                     <value>?</value>
                     <!--Optional:-->
                     <ref>?</ref>
                  </param>
               </params>
            </requestMeta>
            <campaignPart>
               <!--Optional:-->
               <uuid>egyszepuuid</uuid>
               <campaignUuid>c798c680-162b-4aaa-a4c8-edd1bb87688b</campaignUuid>
               <campaignPartType>INFO</campaignPartType>
               <!--Optional:-->
               <fromEmailAddress>?</fromEmailAddress>
               <!--Optional:-->
               <fromName>?</fromName>
               <!--Optional:-->
               <replyToEmailAddress>?</replyToEmailAddress>
               <!--Optional:-->
               <replyToName>?</replyToName>
               <!--Optional:-->
               <supervisorEmailAddress>?</supervisorEmailAddress>
               <!--Optional:-->
               <title>ExampleCampaign</title>
               <!--Optional:-->
               <description>This is an example query</description>
               <!--Optional:-->
               <status>?</status>
               <considerUnsubscribed>false</considerUnsubscribed>
               <!--Optional:-->
               <createdBy>?</createdBy>
               <!--Optional:-->
               <createdAt>?</createdAt>
               <!--Optional:-->
               <scheduledAt>?</scheduledAt>
               <!--Optional:-->
               <deletedBy>?</deletedBy>
               <!--Optional:-->
               <deletedAt>?</deletedAt>
               <!--Optional:-->
               <assetDeliveryMode>?</assetDeliveryMode>
               <!--Optional:-->
               <recipientCount>?</recipientCount>
               <!--Optional:-->
               <lastRecipientSyncTime>?</lastRecipientSyncTime>
               <!--Optional:-->
               <unsubscribedFromRecipientCount>?</unsubscribedFromRecipientCount>
               <!--Optional:-->
               <sampleSize>?</sampleSize>
               <!--Optional:-->
               <segmentRules>
                  <!--Zero or more repetitions:-->
                  <segmentRule>
                     <!--Optional:-->
                     <recipientSegmentRule>
                        <!--Optional:-->
                        <createdAt>?</createdAt>
                        <!--Optional:-->
                        <createdBy>?</createdBy>
                        <!--Zero or more repetitions:-->
                        <definitions>
                           <!--Optional:-->
                           <attributeType>?</attributeType>
                           <!--Optional:-->
                           <description>?</description>
                           <!--Optional:-->
                           <filterValue>?</filterValue>
                           <!--Optional:-->
                           <name>?</name>
                           <!--Optional:-->
                           <operand>?</operand>
                           <!--Optional:-->
                           <operator>?</operator>
                           <!--Optional:-->
                           <ruleType>?</ruleType>
                           <!--Optional:-->
                           <uuid>?</uuid>
                        </definitions>
                        <!--Optional:-->
                        <description>?</description>
                        <!--Optional:-->
                        <name>?</name>
                        <!--Optional:-->
                        <organizationUuid>?</organizationUuid>
                        <!--Optional:-->
                        <template>?</template>
                        <!--Optional:-->
                        <uuid>?</uuid>
                     </recipientSegmentRule>
                     <!--Optional:-->
                     <sourceCampaignPartUuid>?</sourceCampaignPartUuid>
                     <!--Optional:-->
                     <sourceRecipientGroupUuid>?</sourceRecipientGroupUuid>
                     <!--Optional:-->
                     <uuid>?</uuid>
                  </segmentRule>
               </segmentRules>
               <!--Optional:-->
               <contents>
                  <!--Zero or more repetitions:-->
                  <content>
                     <!--Optional:-->
                     <uuid>?</uuid>
                     <!--Optional:-->
                     <messageType>?</messageType>
                     <!--Optional:-->
                     <scenarioName>?</scenarioName>
                     <!--Optional:-->
                     <subject>?</subject>
                     <!--Optional:-->
                     <totalOpens>?</totalOpens>
                     <!--Optional:-->
                     <uniqueOpens>?</uniqueOpens>
                     <!--Optional:-->
                     <totalClicks>?</totalClicks>
                     <!--Optional:-->
                     <uniqueClicks>?</uniqueClicks>
                     <!--Optional:-->
                     <usersOfClicks>?</usersOfClicks>
                     <!--Optional:-->
                     <properties>
                        <!--Zero or more repetitions:-->
                        <property>
                           <!--Optional:-->
                           <uuid>?</uuid>
                           <!--Optional:-->
                           <key>?</key>
                           <!--Optional:-->
                           <valueType>?</valueType>
                           <!--Optional:-->
                           <value>?</value>
                           <!--Optional:-->
                           <index>?</index>
                        </property>
                     </properties>
                  </content>
               </contents>
            </campaignPart>
         </request>
      </v1:createCampaignPart>
   </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/campaign/v1" xmlns:ns3="http://hammy.dbx.hu/model/campaign/v1">
      <ns2:createCampaignPartResponse>
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <campaignPart>
               <uuid>egyszepuuid</uuid>
               <campaignUuid>c798c680-162b-4aaa-a4c8-edd1bb87688b</campaignUuid>
               <campaignPartType>INFO</campaignPartType>
               <title>ExampleCampaign</title>
               <description>This is an example query</description>
               <considerUnsubscribed>false</considerUnsubscribed>
               <createdBy>admin</createdBy>
               <assetDeliveryMode>INLINE</assetDeliveryMode>
               <segmentRules/>
               <contents/>
            </campaignPart>
         </response>
      </ns2:createCampaignPartResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/campaign/v1/campaignParts

body: JCampaignPart1

Válasz

Típus	Leírás
JCampaignPart1	A létrehozott kampányelem adatai.

Minta

KérésVálasz

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

{
    "data": {
            "id": "cap-000031",
            "type": "campaignParts",
            "attributes": {
                "campaignUuid": "af45c231-f2f1-48a7-b680-1485b1211ca4",
                "campaignPartType": "SENDING",
                "fromEmailAddress": "sample2@example.com", 
                "fromName": "Sam Sample 2",
                "replyToEmailAddress":  "reply2@example.com",
                "replyToName": "Customer Service 2",
                "supervisorEmailAddress":  "supervisor2@example.com",
                "title": "Example campaign part 2",
                "description": "This is just an example campaign part2.",
                "status": "DRAFT"
            },
            "relationships": {
                    "contents": {
                        "data": [
                            {
                                "type": "campaignPartContents",
                                "id": "cac000001-1"
                            }
                        ]
                    }
            }
    },
    "included": [
        {
            "type": "campaignPartContents",
            "id": "cac000001-1",
            "attributes": {
                "messageType": "Üres_próba",
                "templateVersionId": "opcionális uuid x",
                "scenarioDefId": "uuid sd",
                "scenarioDefVersionId": "opcionális uuid sdv"
            },
            "relationships": {
                "properties": {
                    "data": []
                }
            }
        }
    ]
}

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

{
    "data": {
        "type": "campaignParts",
        "id": "cap-000031",
        "attributes": {
            "campaignUuid": "af45c231-f2f1-48a7-b680-1485b1211ca4",
            "campaignPartType": "SENDING",
            "fromEmailAddress": "sample2@example.com",
            "fromName": "Sam Sample 2",
            "replyToEmailAddress": "reply2@example.com",
            "replyToName": "Customer Service 2",
            "supervisorEmailAddress": "supervisor2@example.com",
            "title": "Example campaign part 2",
            "description": "This is just an example campaign part2.",
            "status": "DRAFT",
            "considerUnsubscribed": false,
            "createdBy": "admin",
            "assetDeliveryMode": "INLINE"
        },
        "relationships": {
            "segmentRules": {
                "data": []
            },
            "contents": {
                "data": [
                    {
                        "type": "campaignPartContents",
                        "id": "cac000001-1"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "type": "campaignPartContents",
            "id": "cac000001-1",
            "attributes": {
                "messageType": "Üres_próba",
                "templateVersionId": "opcionális uuid x",
                "scenarioDefId": "uuid sd",
                "scenarioDefVersionId": "opcionális uuid sdv",
                "totalOpens": 0,
                "uniqueOpens": 0,
                "totalClicks": 0,
                "uniqueClicks": 0
            },
            "relationships": {
                "properties": {
                    "data": []
                }
            }
        }
    ],
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Update campaign part

Kampányelem módosítása.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A híváshoz kapcsolódó metaadatok.
campaignPart	WCampaignPart1	Módosítandó kampányelem adatai.

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.
campaignPart	WCampaignPart1	A módosított kampányelem adatai.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://hammy.dbx.hu/api/campaign/v1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:updateCampaignPart>
         <!--Optional:-->
         <request>
            <!--Optional:-->
            <requestMeta>
               <!--Optional:-->
               <clientHashKey>221d316146c591897238</clientHashKey>
               <!--Optional:-->
               <userName>admin</userName>
               <!--Optional:-->
               <params>
                  <!--Zero or more repetitions:-->
                  <param>
                     <key>?</key>
                     <value>?</value>
                     <!--Optional:-->
                     <ref>?</ref>
                  </param>
               </params>
            </requestMeta>
            <campaignPart>
               <!--Optional:-->
               <uuid>egyszepuuid</uuid>
               <campaignUuid>c798c680-162b-4aaa-a4c8-edd1bb87688b</campaignUuid>
               <campaignPartType>INFO</campaignPartType>
               <!--Optional:-->
               <fromEmailAddress>?</fromEmailAddress>
               <!--Optional:-->
               <fromName>?</fromName>
               <!--Optional:-->
               <replyToEmailAddress>?</replyToEmailAddress>
               <!--Optional:-->
               <replyToName>?</replyToName>
               <!--Optional:-->
               <supervisorEmailAddress>?</supervisorEmailAddress>
               <!--Optional:-->
               <title>ExampleCampaign</title>
               <!--Optional:-->
               <description>This is not an example query anymore</description>
               <!--Optional:-->
               <status>?</status>
               <considerUnsubscribed>false</considerUnsubscribed>
               <!--Optional:-->
               <createdBy>?</createdBy>
               <!--Optional:-->
               <createdAt>?</createdAt>
               <!--Optional:-->
               <scheduledAt>?</scheduledAt>
               <!--Optional:-->
               <deletedBy>?</deletedBy>
               <!--Optional:-->
               <deletedAt>?</deletedAt>
               <!--Optional:-->
               <assetDeliveryMode>?</assetDeliveryMode>
               <!--Optional:-->
               <recipientCount>?</recipientCount>
               <!--Optional:-->
               <lastRecipientSyncTime>?</lastRecipientSyncTime>
               <!--Optional:-->
               <unsubscribedFromRecipientCount>?</unsubscribedFromRecipientCount>
               <!--Optional:-->
               <sampleSize>?</sampleSize>
               <!--Optional:-->
               <segmentRules>
                  <!--Zero or more repetitions:-->
                  <segmentRule>
                     <!--Optional:-->
                     <recipientSegmentRule>
                        <!--Optional:-->
                        <createdAt>?</createdAt>
                        <!--Optional:-->
                        <createdBy>?</createdBy>
                        <!--Zero or more repetitions:-->
                        <definitions>
                           <!--Optional:-->
                           <attributeType>?</attributeType>
                           <!--Optional:-->
                           <description>?</description>
                           <!--Optional:-->
                           <filterValue>?</filterValue>
                           <!--Optional:-->
                           <name>?</name>
                           <!--Optional:-->
                           <operand>?</operand>
                           <!--Optional:-->
                           <operator>?</operator>
                           <!--Optional:-->
                           <ruleType>?</ruleType>
                           <!--Optional:-->
                           <uuid>?</uuid>
                        </definitions>
                        <!--Optional:-->
                        <description>?</description>
                        <!--Optional:-->
                        <name>?</name>
                        <!--Optional:-->
                        <organizationUuid>?</organizationUuid>
                        <!--Optional:-->
                        <template>?</template>
                        <!--Optional:-->
                        <uuid>?</uuid>
                     </recipientSegmentRule>
                     <!--Optional:-->
                     <sourceCampaignPartUuid>?</sourceCampaignPartUuid>
                     <!--Optional:-->
                     <sourceRecipientGroupUuid>?</sourceRecipientGroupUuid>
                     <!--Optional:-->
                     <uuid>?</uuid>
                  </segmentRule>
               </segmentRules>
               <!--Optional:-->
               <contents>
                  <!--Zero or more repetitions:-->
                  <content>
                     <!--Optional:-->
                     <uuid>?</uuid>
                     <!--Optional:-->
                     <messageType>?</messageType>
                     <!--Optional:-->
                     <scenarioName>?</scenarioName>
                     <!--Optional:-->
                     <subject>?</subject>
                     <!--Optional:-->
                     <totalOpens>?</totalOpens>
                     <!--Optional:-->
                     <uniqueOpens>?</uniqueOpens>
                     <!--Optional:-->
                     <totalClicks>?</totalClicks>
                     <!--Optional:-->
                     <uniqueClicks>?</uniqueClicks>
                     <!--Optional:-->
                     <usersOfClicks>?</usersOfClicks>
                     <!--Optional:-->
                     <properties>
                        <!--Zero or more repetitions:-->
                        <property>
                           <!--Optional:-->
                           <uuid>?</uuid>
                           <!--Optional:-->
                           <key>?</key>
                           <!--Optional:-->
                           <valueType>?</valueType>
                           <!--Optional:-->
                           <value>?</value>
                           <!--Optional:-->
                           <index>?</index>
                        </property>
                     </properties>
                  </content>
               </contents>
            </campaignPart>
         </request>
      </v1:updateCampaignPart>
   </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/campaign/v1" xmlns:ns3="http://hammy.dbx.hu/model/campaign/v1">
      <ns2:updateCampaignPartResponse>
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <campaignPart>
               <uuid>egyszepuuid</uuid>
               <campaignUuid>c798c680-162b-4aaa-a4c8-edd1bb87688b</campaignUuid>
               <campaignPartType>INFO</campaignPartType>
               <title>ExampleCampaign</title>
               <description>This is not an example query anymore</description>
               <considerUnsubscribed>false</considerUnsubscribed>
               <createdBy>admin</createdBy>
               <createdAt>2021-06-10T09:26:23.234+02:00</createdAt>
               <assetDeliveryMode>INLINE</assetDeliveryMode>
               <segmentRules/>
               <contents/>
            </campaignPart>
         </response>
      </ns2:updateCampaignPartResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

PUT hammy/json/campaign/v1/campaignParts/{{uuid}}

body: JCampaignPart1

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

Válasz

Típus	Leírás
JCampaignPart1	A módosított kampányelem adatai.

Minta

KérésVálasz

PUT /hammy/json/campaign/v1/campaignsParts/{{campaignUuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "campaignParts",
        "id": "cap-000001",
        "attributes": {
            "campaignUuid": "af45c231-f2f1-48a7-b680-1485b1211ca4",
            "campaignPartType": "SENDING",
            "fromEmailAddress": "sample2@example.com",
            "fromName": "Sam Sample 2",
            "replyToEmailAddress": "reply2@example.com",
            "replyToName": "Customer Service 2",
            "supervisorEmailAddress": "supervisor2@example.com",
            "title": "Example campaign part 2",
            "description": "This is just an example campaign part2.",
            "status": "DRAFT",
            "considerUnsubscribed": false,
            "createdBy": "admin",
            "createdAt": "2021-02-10T11:52:41.332+0100",
            "assetDeliveryMode": "INLINE"
        },
        "relationships": {
            "contents": {
                "data": [
                    {
                        "type": "campaignPartContents",
                        "id": "cac000001-7"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "type": "campaignPartContents",
            "id": "cac000001-1",
            "attributes": {
                "messageType": "Üres_próba"
            },
            "relationships": {
                "properties": {
                    "data": []
                }
            }
        }
    ]
}

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

{
    "data": {
        "type": "campaignParts",
        "id": "cap-000001",
        "attributes": {
            "campaignUuid": "ee8b1205-4dab-402a-94f5-b520104c5cde",
            "campaignPartType": "SENDING",
            "fromEmailAddress": "sample2@example.com",
            "fromName": "Sam Sample 2",
            "replyToEmailAddress": "reply2@example.com",
            "replyToName": "Customer Service 2",
            "supervisorEmailAddress": "supervisor2@example.com",
            "title": "Example campaign part 2",
            "description": "This is just an example campaign part2.",
            "status": "DRAFT",
            "considerUnsubscribed": false,
            "createdBy": "admin",
            "createdAt": "2021-04-06T11:17:05.504+0200",
            "assetDeliveryMode": "INLINE"
        },
        "relationships": {
            "segmentRules": {
                "data": []
            },
            "contents": {
                "data": [
                    {
                        "type": "campaignPartContents",
                        "id": "cac000001-7"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "type": "campaignPartContents",
            "id": "cac000001-7",
            "attributes": {
                "totalOpens": 0,
                "uniqueOpens": 0,
                "totalClicks": 0,
                "uniqueClicks": 0
            },
            "relationships": {
                "properties": {
                    "data": []
                }
            }
        }
    ],
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Update campaign part

Status = Approval

Minta

KérésVálasz

PUT /hammy/json/campaign/v1/campaignsParts/{{campaignUuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
  "data":{
    "id":"6b248ccd-dc46-4ad2-99d6-fc18d0642d6e",
    "attributes":{
      "campaignPartType":"NORMAL",
      "templateKind":"NORMAL",
      "fromEmailAddress":"bela.teszt@gmail.com",
      "fromName":"Teszt Bela",
      "replyToEmailAddress":"ilona.teszt@gmail.com",
      "replyToName":"Teszt Ilona",
      "supervisorEmailAddress":null,
      "title":"Teszt 13",
      "description":null,
      "status":"APPROVAL",
      "considerUnsubscribed":true,
      "backOfficeSending":false,
      "createdBy":"admin",
      "createdAt":null,
      "scheduledAt":"2024-10-02T13:30:53.813Z",
      "deletedBy":null,
      "deletedAt":null,
      "assetDeliveryMode":"INLINE",
      "recipientCount":null,
      "lastRecipientSyncTime":null,
      "recipientSyncStartedAt":null,
      "recipientSyncJobCreatedAt":null,
      "recipientGroupUuid":"44a4c851-95a3-4032-b33f-c5fb07c05b81",
      "recipientDuplicationHandlingType":"EMAIL_ADDRESS_MATCHING",
      "segmentationLimit":null,
      "repeatStartAt":null,
      "repeatEndAt":null,
      "repetitiveSendingCronExpression":null,
      "creationRelatedUuid":null,
      "campaignUuid":"d21db306-f95a-4d5e-9bd6-7cd50a41fe5e"
    },
    "type":"campaignParts",
    "relationships":{
      "segmentRules":{
        "data":[
          {
            "id":"f6a3d8e9-9b9c-4ad6-9cff-a1f1547f6e6b",
            "type":"campaignPartRecipientSegmentRules"
          }
        ]
      },
      "contents":{
        "data":[
          {
            "id":"34f3cbd2-9107-4559-a294-26c4702ab8ee",
            "type":"campaignPartContents"
          }
        ]
      }
    }
  },
  "included":[
    {
      "id":"f6a3d8e9-9b9c-4ad6-9cff-a1f1547f6e6b",
      "attributes":{
        "sourceRecipientGroupUuid":null,
        "sourceCampaignPartUuid":"d02ee1e3-ebcc-48a1-97d9-b25243b30d4c"
      },
      "type":"campaignPartRecipientSegmentRules",
      "relationships":{
        "recipientSegmentRule":{
          "data":{
            "id":"ffe37755-3260-418e-a510-d513226fe2ad",
            "type":"recipientSegmentRules"
          }
        }
      }
    },
    {
      "id":"ffe37755-3260-418e-a510-d513226fe2ad",
      "attributes":{
        "name":"_"
      },
      "type":"recipientSegmentRules"
    },
    {
      "id":"34f3cbd2-9107-4559-a294-26c4702ab8ee",
      "attributes":{
        "messageType":"FIX_CSATOLMANYOS",
        "scenarioDefId":null,
        "scenarioDefVersionId":null,
        "totalOpens":0,
        "uniqueOpens":0,
        "totalClicks":0,
        "uniqueClicks":0,
        "totalSent":null
      },
      "type":"campaignPartContents"
    }
  ]
}

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

{
  "data": {
    "type": "campaignParts",
    "id": "6b248ccd-dc46-4ad2-99d6-fc18d0642d6e",
    "attributes": {
      "campaignUuid": "d21db306-f95a-4d5e-9bd6-7cd50a41fe5e",
      "campaignPartType": "NORMAL",
      "templateKind": "NORMAL",
      "fromEmailAddress": "bela.teszt@gmail.com",
      "fromName": "Teszt Bela",
      "replyToEmailAddress": "ilona.teszt@gmail.com",
      "replyToName": "Teszt Ilona",
      "title": "Teszt 13",
      "status": "APPROVAL",
      "considerUnsubscribed": true,
      "backOfficeSending": false,
      "createdBy": "admin",
      "createdAt": "2024-10-02T15:30:26.878+02:00",
      "scheduledAt": "2024-10-02T15:33:17.537+02:00",
      "scheduledBy": "admin",
      "creationMode": "MANUAL",
      "assetDeliveryMode": "INLINE",
      "calendarNecessary": false,
      "recipientGroupUuid": "44a4c851-95a3-4032-b33f-c5fb07c05b81",
      "recipientDuplicationHandlingType": "EMAIL_ADDRESS_MATCHING"
    },
    "relationships": {
      "calendar": {
        "data": {
          "type": "calendars",
          "id": "6b248ccd-dc46-4ad2-99d6-fc18d0642d6e"
        }
      },
      "segmentRules": {
        "data": [
          {
            "type": "campaignPartRecipientSegmentRules",
            "id": "f6a3d8e9-9b9c-4ad6-9cff-a1f1547f6e6b"
          }
        ]
      },
      "contents": {
        "data": [
          {
            "type": "campaignPartContents",
            "id": "34f3cbd2-9107-4559-a294-26c4702ab8ee"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "campaignPartContents",
      "id": "34f3cbd2-9107-4559-a294-26c4702ab8ee",
      "attributes": {
        "messageType": "FIX_CSATOLMANYOS",
        "totalOpens": 0,
        "uniqueOpens": 0,
        "totalClicks": 0,
        "uniqueClicks": 0
      },
      "relationships": {
        "properties": {
          "data": []
        }
      }
    },
    {
      "type": "recipientSegmentRules",
      "id": "ffe37755-3260-418e-a510-d513226fe2ad",
      "attributes": {
        "name": "_",
        "createdBy": "admin",
        "createdAt": "2024-10-02T15:33:17.632+02:00",
        "organizationUuid": "default"
      },
      "relationships": {
        "definitions": {
          "data": []
        }
      }
    },
    {
      "type": "calendars",
      "id": "6b248ccd-dc46-4ad2-99d6-fc18d0642d6e",
      "attributes": {}
    },
    {
      "type": "campaignPartRecipientSegmentRules",
      "id": "f6a3d8e9-9b9c-4ad6-9cff-a1f1547f6e6b",
      "attributes": {
        "sourceCampaignPartUuid": "d02ee1e3-ebcc-48a1-97d9-b25243b30d4c"
      },
      "relationships": {
        "recipientSegmentRule": {
          "data": {
            "type": "recipientSegmentRules",
            "id": "ffe37755-3260-418e-a510-d513226fe2ad"
          }
        }
      }
    }
  ],
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Update campaign part

Status = Scheduled

Minta

KérésVálasz

PUT /hammy/json/campaign/v1/campaignsParts/{{campaignUuid}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
  "data":{
    "id":"6b248ccd-dc46-4ad2-99d6-fc18d0642d6e",
    "attributes":{
      "campaignPartType":"NORMAL",
      "templateKind":"NORMAL",
      "fromEmailAddress":"bela.teszt@gmail.com",
      "fromName":"Teszt Bela",
      "replyToEmailAddress":"ilona.teszt@gmail.com",
      "replyToName":"Teszt Ilona",
      "supervisorEmailAddress":null,
      "title":"Teszt 13",
      "description":null,
      "status":"SCHEDULED",
      "considerUnsubscribed":true,
      "backOfficeSending":false,
      "createdBy":"admin",
      "createdAt":null,
      "scheduledAt":"2024-10-02T13:30:53.813Z",
      "deletedBy":null,
      "deletedAt":null,
      "assetDeliveryMode":"INLINE",
      "recipientCount":null,
      "lastRecipientSyncTime":null,
      "recipientSyncStartedAt":null,
      "recipientSyncJobCreatedAt":null,
      "recipientGroupUuid":"44a4c851-95a3-4032-b33f-c5fb07c05b81",
      "recipientDuplicationHandlingType":"EMAIL_ADDRESS_MATCHING",
      "segmentationLimit":null,
      "repeatStartAt":null,
      "repeatEndAt":null,
      "repetitiveSendingCronExpression":null,
      "creationRelatedUuid":null,
      "campaignUuid":"d21db306-f95a-4d5e-9bd6-7cd50a41fe5e"
    },
    "type":"campaignParts",
    "relationships":{
      "segmentRules":{
        "data":[
          {
            "id":"f6a3d8e9-9b9c-4ad6-9cff-a1f1547f6e6b",
            "type":"campaignPartRecipientSegmentRules"
          }
        ]
      },
      "contents":{
        "data":[
          {
            "id":"34f3cbd2-9107-4559-a294-26c4702ab8ee",
            "type":"campaignPartContents"
          }
        ]
      }
    }
  },
  "included":[
    {
      "id":"f6a3d8e9-9b9c-4ad6-9cff-a1f1547f6e6b",
      "attributes":{
        "sourceRecipientGroupUuid":null,
        "sourceCampaignPartUuid":"d02ee1e3-ebcc-48a1-97d9-b25243b30d4c"
      },
      "type":"campaignPartRecipientSegmentRules",
      "relationships":{
        "recipientSegmentRule":{
          "data":{
            "id":"ffe37755-3260-418e-a510-d513226fe2ad",
            "type":"recipientSegmentRules"
          }
        }
      }
    },
    {
      "id":"ffe37755-3260-418e-a510-d513226fe2ad",
      "attributes":{
        "name":"_"
      },
      "type":"recipientSegmentRules"
    },
    {
      "id":"34f3cbd2-9107-4559-a294-26c4702ab8ee",
      "attributes":{
        "messageType":"FIX_CSATOLMANYOS",
        "scenarioDefId":null,
        "scenarioDefVersionId":null,
        "totalOpens":0,
        "uniqueOpens":0,
        "totalClicks":0,
        "uniqueClicks":0,
        "totalSent":null
      },
      "type":"campaignPartContents"
    }
  ]
}

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

{
  "data": {
    "type": "campaignParts",
    "id": "6b248ccd-dc46-4ad2-99d6-fc18d0642d6e",
    "attributes": {
      "campaignUuid": "d21db306-f95a-4d5e-9bd6-7cd50a41fe5e",
      "campaignPartType": "NORMAL",
      "templateKind": "NORMAL",
      "fromEmailAddress": "bela.teszt@gmail.com",
      "fromName": "Teszt Bela",
      "replyToEmailAddress": "ilona.teszt@gmail.com",
      "replyToName": "Teszt Ilona",
      "title": "Teszt 13",
      "status": "SCHEDULED",
      "considerUnsubscribed": true,
      "backOfficeSending": false,
      "createdBy": "admin",
      "createdAt": "2024-10-02T15:30:26.878+02:00",
      "scheduledAt": "2024-10-02T15:30:53.813+02:00",
      "scheduledBy": "admin",
      "approvedAt": "2024-10-02T15:40:31.010+02:00",
      "approvedBy": "teszt",
      "creationMode": "MANUAL",
      "assetDeliveryMode": "INLINE",
      "calendarNecessary": false,
      "recipientGroupUuid": "44a4c851-95a3-4032-b33f-c5fb07c05b81",
      "recipientDuplicationHandlingType": "EMAIL_ADDRESS_MATCHING"
    },
    "relationships": {
      "calendar": {
        "data": {
          "type": "calendars",
          "id": "6b248ccd-dc46-4ad2-99d6-fc18d0642d6e"
        }
      },
      "segmentRules": {
        "data": [
          {
            "type": "campaignPartRecipientSegmentRules",
            "id": "f6a3d8e9-9b9c-4ad6-9cff-a1f1547f6e6b"
          }
        ]
      },
      "contents": {
        "data": [
          {
            "type": "campaignPartContents",
            "id": "34f3cbd2-9107-4559-a294-26c4702ab8ee"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "campaignPartContents",
      "id": "34f3cbd2-9107-4559-a294-26c4702ab8ee",
      "attributes": {
        "messageType": "FIX_CSATOLMANYOS",
        "totalOpens": 0,
        "uniqueOpens": 0,
        "totalClicks": 0,
        "uniqueClicks": 0
      },
      "relationships": {
        "properties": {
          "data": []
        }
      }
    },
    {
      "type": "recipientSegmentRules",
      "id": "ffe37755-3260-418e-a510-d513226fe2ad",
      "attributes": {
        "name": "_",
        "createdBy": "admin",
        "createdAt": "2024-10-02T15:33:17.632+02:00",
        "organizationUuid": "default"
      },
      "relationships": {
        "definitions": {
          "data": []
        }
      }
    },
    {
      "type": "calendars",
      "id": "6b248ccd-dc46-4ad2-99d6-fc18d0642d6e",
      "attributes": {}
    },
    {
      "type": "campaignPartRecipientSegmentRules",
      "id": "f6a3d8e9-9b9c-4ad6-9cff-a1f1547f6e6b",
      "attributes": {
        "sourceCampaignPartUuid": "d02ee1e3-ebcc-48a1-97d9-b25243b30d4c"
      },
      "relationships": {
        "recipientSegmentRule": {
          "data": {
            "type": "recipientSegmentRules",
            "id": "ffe37755-3260-418e-a510-d513226fe2ad"
          }
        }
      }
    }
  ],
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Copy campaign part

Kampányelem lemásolása ugyanabba, vagy egy másik kampányba.

Típusok

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
sourceCampaignPartUuid	String	Forrás elem azonosítója, amit le akarunk másolni.
targetCampaignUuid	String	Cél kampány azonosítója, amibe másolni akarjuk az elemet.

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.
campaignPart	WCampaignPart1	A lemásolt kampányelem adatai.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://hammy.dbx.hu/api/campaign/v1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:copyCampaignPart>
         <!--Optional:-->
         <request>
            <!--Optional:-->
            <requestMeta>
               <!--Optional:-->
               <clientHashKey>221d316146c591897238</clientHashKey>
               <!--Optional:-->
               <userName>admin</userName>
               <!--Optional:-->
               <params>
                  <!--Zero or more repetitions:-->
                  <param>
                     <key>?</key>
                     <value>?</value>
                     <!--Optional:-->
                     <ref>?</ref>
                  </param>
               </params>
            </requestMeta>
            <!--Optional:-->
            <sourceCampaignPartUuid>d34eeec6-4431-4efa-aed6-8bb955cf3a87</sourceCampaignPartUuid>
            <!--Optional:-->
            <targetCampaignUuid>614d57c5-7236-4a00-a416-71cc2e6f7bcb</targetCampaignUuid>
         </request>
      </v1:copyCampaignPart>
   </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/campaign/v1" xmlns:ns3="http://hammy.dbx.hu/model/campaign/v1">
      <ns2:copyCampaignPartResponse>
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <campaignPart>
               <uuid>33c0fcf6-8d55-4c63-88bb-8cae956715df</uuid>
               <campaignUuid>614d57c5-7236-4a00-a416-71cc2e6f7bcb</campaignUuid>
               <campaignPartType>SENDING</campaignPartType>
               <fromEmailAddress>pelda.bela@dbx.hu</fromEmailAddress>
               <fromName>Példa Béla</fromName>
               <replyToEmailAddress>pelda.bela@dbx.hu</replyToEmailAddress>
               <replyToName>Példa Béla</replyToName>
               <supervisorEmailAddress>pelda.bela@dbx.hu</supervisorEmailAddress>
               <title>Scenario példa node</title>
               <description>Statisztikák működésének tesztelése</description>
               <status>DRAFT</status>
               <considerUnsubscribed>false</considerUnsubscribed>
               <createdBy>admin</createdBy>
               <assetDeliveryMode>INLINE</assetDeliveryMode>
               <segmentRules>
                  <segmentRule>
                     <recipientSegmentRule>
                        <createdAt>2021-06-18T15:28:26.302+02:00</createdAt>
                        <createdBy>admin</createdBy>
                        <definitions>
                           <attributeType>STRING</attributeType>
                           <description>A címlista minden tagját kiválasztja küldésre.</description>
                           <name>allRecipients</name>
                           <operand>recipientAddress</operand>
                           <operator>ALL</operator>
                           <ruleType>ATTRIBUTE</ruleType>
                           <uuid>03d8beea-35ad-44ab-acdb-36ba37784be8</uuid>
                        </definitions>
                        <description>A címlista minden tagját kiválasztja küldésre.</description>
                        <name>allRecipients</name>
                        <organizationUuid>default</organizationUuid>
                        <template>false</template>
                        <uuid>768502c2-a9c7-4e75-af33-e216703793de</uuid>
                     </recipientSegmentRule>
                     <sourceRecipientGroupUuid>c93d50e7-7593-411d-80a0-4fa15c045ec2</sourceRecipientGroupUuid>
                     <uuid>dfc360bd-dd29-4a7e-9065-0186a7d818f0</uuid>
                  </segmentRule>
               </segmentRules>
               <contents>
                  <content>
                     <uuid>d9da6370-9753-4a5e-a159-c8f1dfd162a9</uuid>
                     <scenarioName>CAMPAIGN_BASED_SCENARIO</scenarioName>
                     <subject>Teszt szkenárió node</subject>
                     <totalOpens>0</totalOpens>
                     <uniqueOpens>0</uniqueOpens>
                     <totalClicks>0</totalClicks>
                     <uniqueClicks>0</uniqueClicks>
                     <properties/>
                  </content>
               </contents>
            </campaignPart>
         </response>
      </ns2:copyCampaignPartResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/campaign/v1/campaigns/{{targetCampaignUuid}}/copyCampaignPart

path

Név	Típus	Leírás
targetCampaignUuid	String	Cél kampány azonosítója, amibe másolni akarjuk az elemet.

body

Mező	Típus	Leírás
uuid	String	vnd.api ID
sourceCampaignPartUuid	String	Forrás elem azonosítója, amit le akarunk másolni.
targetCampaignUuid	String	Cél kampány azonosítója, amibe másolni akarjuk az elemet.

Válasz

Típus	Leírás
JCampaignPart1	A lemásolt kampányelem adatai.

Minta

KérésVálasz

PUT /hammy/json/campaign/v1/campaignsParts/{{targetCampaignUuid}}/copyCampaignPart
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
    "data": {
            "type": "copyCampaignPartRequests",
            "attributes": {
                "sourceCampaignPartUuid": "d34eeec6-4431-4efa-aed6-8bb955cf3a87"
            }
    }
}

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

{
    "data": {
        "type": "campaignParts",
        "id": "9e2152e0-42c0-45e1-8627-47981a22333b",
        "attributes": {
            "campaignUuid": "614d57c5-7236-4a00-a416-71cc2e6f7bcb",
            "campaignPartType": "SENDING",
            "fromEmailAddress": "pelda.bela@dbx.hu",
            "fromName": "Példa Béla",
            "replyToEmailAddress": "pelda.bela@dbx.hu",
            "replyToName": "Példa Béla",
            "supervisorEmailAddress": "pelda.bela@dbx.hu",
            "title": "Scenario példa node",
            "description": "Statisztikák működésének tesztelése",
            "status": "DRAFT",
            "considerUnsubscribed": false,
            "createdBy": "admin",
            "assetDeliveryMode": "INLINE"
        },
        "relationships": {
            "segmentRules": {
                "data": [
                    {
                        "type": "campaignPartRecipientSegmentRules",
                        "id": "517fa9b9-3f50-4897-8358-d330c46783a7"
                    }
                ]
            },
            "contents": {
                "data": [
                    {
                        "type": "campaignPartContents",
                        "id": "494ae65b-6591-4ecb-b5ac-c6e350f25f73"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "type": "recipientSegmentRules",
            "id": "8031868d-ef7c-499d-a74a-3deffc436408",
            "attributes": {
                "name": "allRecipients",
                "description": "A címlista minden tagját kiválasztja küldésre.",
                "createdBy": "admin",
                "createdAt": "2021-06-18T15:28:26.302+0200",
                "organizationUuid": "default",
                "definitions": [
                    {
                        "uuid": "2b110d5b-8bbc-4f80-9157-6a445d461ff1",
                        "ruleType": "ATTRIBUTE",
                        "attributeType": "STRING",
                        "operand": "recipientAddress",
                        "operator": "ALL",
                        "name": "allRecipients",
                        "description": "A címlista minden tagját kiválasztja küldésre."
                    }
                ]
            }
        },
        {
            "type": "campaignPartContents",
            "id": "494ae65b-6591-4ecb-b5ac-c6e350f25f73",
            "attributes": {
                "scenarioName": "CAMPAIGN_BASED_SCENARIO",
                "subject": "Teszt szkenárió node",
                "totalOpens": 0,
                "uniqueOpens": 0,
                "totalClicks": 0,
                "uniqueClicks": 0
            },
            "relationships": {
                "properties": {
                    "data": []
                }
            }
        },
        {
            "type": "campaignPartRecipientSegmentRules",
            "id": "517fa9b9-3f50-4897-8358-d330c46783a7",
            "attributes": {
                "sourceRecipientGroupUuid": "c93d50e7-7593-411d-80a0-4fa15c045ec2"
            },
            "relationships": {
                "recipientSegmentRule": {
                    "data": {
                        "type": "recipientSegmentRules",
                        "id": "8031868d-ef7c-499d-a74a-3deffc436408"
                    }
                }
            }
        }
    ],
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Synchronize campaign part recipients

Egy adott kampányelem címzettlistájának frissítése/szinkronizálása a leválogatási szabályokkal.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

POST hammy/json/campaign/v1/campaignParts/{{uuid}}/synchronizeRecipients

Név	Típus	Leírás
uuid	String	A szinkronizálandó kampányelem UUID-ja.

Paraméter	Típus	Leírás
uuid	String	A kampányelem UUID-ja. (vnd.api ID)
async	Boolean	Aszinkron címzettlista frissítés.

Válasz

Név	Típus	Leírás
meta	JMeta1	Metaadatok.

Minta

KérésVálasz

POST {{baseUrl}}/json/campaign/v1/campaignParts/{{uuid}}/synchronizeRecipients?async=true
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": "emptyResponse",
        "id": "4766c19e-3ec8-42a3-84bd-70791fbd9efe",
        "attributes": {}
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Show recipient segment rule

Visszaadja a keresett címzett-leválogatási szabályt.

REST API

REST API Info

Kérés

GET hammy/json/campaign/v1/recipientSegmentRules/{{uuid}}

Név	Típus	Leírás
uuid	String	a szabály UUID-ja.

Válasz

Típus	Leírás
JRecipientSegmentRule1	A keresett szabály.

Minta

KérésVálasz

GET {{baseUrl}}/json/campaign/v1/recipientSegmentRules/{{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": "recipientSegmentRules",
        "id": "e499e9bc-8211-4fe9-aa94-f774e35d819c",
        "attributes": {
            "name": "X-GENERATION",
            "description": "X generációs",
            "createdBy": "admin",
            "createdAt": "2021-06-07T15:25:37.354+0200",
            "organizationUuid": "default",
            "definitions": [
                {
                    "uuid": "32067bc7-e8a5-41fc-b0dc-c488e0694564",
                    "ruleType": "ATTRIBUTE",
                    "attributeType": "DATE",
                    "operand": "yearOfBirth",
                    "operator": "GE",
                    "filterValue": "1960-01-01",
                    "name": "X-GENERATION",
                    "description": "1960 után született"
                },
                {
                    "uuid": "5dac2266-7566-43c7-b2df-21ced6393ca3",
                    "ruleType": "ATTRIBUTE",
                    "attributeType": "DATE",
                    "operand": "yearOfBirth",
                    "operator": "LE",
                    "filterValue": "1980-01-01",
                    "name": "X-GENERATION",
                    "description": "1980 előtt született"
                }
            ]
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Find recipient segment rules

Visszaadja a címzett-leválogatási szabályokat a megadott szűrők alapján.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
limit	Integer	A találatok maximális száma.
offset	Integer	A találati lista kezdete.
campaignPartUuid	String	A szabályhoz tartozó kampányelem UUID-je.
name	String	A leválogatási szabály neve.
createdBy	String	A szabály készítőjének felhasználóneve.
createdAtFrom	Date	Alsó korlát a szabály létrehozási idejére.
createdAtTo	Date	Felső korlát a szabály létrehozási idejére.

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	A találatok száma.
recipientSegmentRules	JRecipientSegmentRule1 [ ]	A megtalált szabályok adatai.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://hammy.dbx.hu/api/campaign/v1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:findRecipientSegmentRules>
         <!--Optional:-->
         <request>
            <!--Optional:-->
            <requestMeta>
               <!--Optional:-->
               <clientHashKey>221d316146c591897238</clientHashKey>
               <!--Optional:-->
               <userName>admin</userName>
               <!--Optional:-->
               <params>
                  <!--Zero or more repetitions:-->
                  <param>
                     <key>?</key>
                     <value>?</value>
                     <!--Optional:-->
                     <ref>?</ref>
                  </param>
               </params>
            </requestMeta>
            <!--Optional:-->
            <limit>2</limit>
            <!--Optional:-->
            <offset>0</offset>
            <!--Optional:-->
            <campaignPartUuid>?</campaignPartUuid>
            <!--Optional:-->
            <name>?</name>
            <!--Optional:-->
            <createdBy>?</createdBy>
            <!--Optional:-->
            <createdAtFrom>?</createdAtFrom>
            <!--Optional:-->
            <createdAtTo>?</createdAtTo>
         </request>
      </v1:findRecipientSegmentRules>
   </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/campaign/v1" xmlns:ns3="http://hammy.dbx.hu/model/campaign/v1">
      <ns2:findRecipientSegmentRulesResponse>
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <total>4</total>
            <recipientSegmentRules>
               <recipientSegmentRule>
                  <uuid>2bf1dbdf-1852-49be-af9e-ed88cd0086ca</uuid>
                  <name>X-Generation</name>
                  <description>X generációs</description>
                  <createdBy>admin</createdBy>
                  <createdAt>2021-06-10T10:00:17.712+02:00</createdAt>
                  <organizationUuid>default</organizationUuid>
                  <definitions>
                     <definition>
                        <uuid>826557f0-6b73-434f-a31c-5bc0bba59697</uuid>
                        <ruleType>ATTRIBUTE</ruleType>
                        <attributeType>DATE</attributeType>
                        <operand>yearOfBirth</operand>
                        <operator>GE</operator>
                        <filterValue>1960-01-01</filterValue>
                        <name>X-Generation</name>
                        <description>1960 után született</description>
                     </definition>
                  </definitions>
               </recipientSegmentRule>
               <recipientSegmentRule>
                  <uuid>?</uuid>
                  <name>X-Generation</name>
                  <description>X generációs</description>
                  <createdBy>admin</createdBy>
                  <createdAt>2021-06-10T09:32:07.059+02:00</createdAt>
                  <organizationUuid>default</organizationUuid>
                  <definitions>
                     <definition>
                        <uuid>632b2c17-19b6-41d9-84c2-f592ca3a4773</uuid>
                        <ruleType>ATTRIBUTE</ruleType>
                        <attributeType>DATE</attributeType>
                        <operand>yearOfBirth</operand>
                        <operator>GE</operator>
                        <filterValue>1960-01-01</filterValue>
                        <name>X-Generation</name>
                        <description>1960 után született</description>
                     </definition>
                  </definitions>
               </recipientSegmentRule>
            </recipientSegmentRules>
         </response>
      </ns2:findRecipientSegmentRulesResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/campaign/v1/recipientSegmentRules

Paraméter	Típus	Leírás
campaignPartUuid	String	A szabályhoz tartozó kampányelem UUID-je.
name	String	A leválogatási szabály neve.
createdBy	String	A szabály készítőjének felhasználóneve.
createdAtFrom	Date	Alsó korlát a szabály létrehozási idejére.
createdAtTo	Date	Felső korlát a szabály létrehozási idejére.
limit	Integer	A találatok maximális száma.
sort	String	A találatok rendezése.
offset	Integer	A találati lista kezdete.
clientHashKey	String	A hívó kliens azonosítója.
params	Param_V1 [ ]	Egyéb paraméterek listája.
userName	String	A felhasználó neve.

Válasz

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

Minta

KérésVálasz

GET {{baseUrl}}/json/campaign/v1/recipientSegmentRules?campaignPartUuid={{campaignPartUuid}}
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": "recipientSegmentRules",
            "id": "e499e9bc-8211-4fe9-aa94-f774e35d819c",
            "attributes": {
                "name": "X-GENERATION",
                "description": "X generációs",
                "createdBy": "admin",
                "createdAt": "2021-06-07T15:25:37.354+0200",
                "organizationUuid": "default",
                "definitions": [
                    {
                        "uuid": "5dac2266-7566-43c7-b2df-21ced6393ca3",
                        "ruleType": "ATTRIBUTE",
                        "attributeType": "DATE",
                        "operand": "yearOfBirth",
                        "operator": "LE",
                        "filterValue": "1980-01-01",
                        "name": "X-GENERATION",
                        "description": "1980 előtt született"
                    },
                    {
                        "uuid": "32067bc7-e8a5-41fc-b0dc-c488e0694564",
                        "ruleType": "ATTRIBUTE",
                        "attributeType": "DATE",
                        "operand": "yearOfBirth",
                        "operator": "GE",
                        "filterValue": "1960-01-01",
                        "name": "X-GENERATION",
                        "description": "1960 után született"
                    }
                ]
            }
        }
    ],
    "meta": {
        "total": 1,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Create recipient segment rule

Leválogatási szabály létrehozása.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
recipientSegmentRule	JRecipientSegmentRule1	A leválogatási szabály adatai.

Válasz

Mező	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.
recipientSegmentRule	JRecipientSegmentRule1	A létrehozott szabály.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://hammy.dbx.hu/api/campaign/v1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:createRecipientSegmentRule>
         <!--Optional:-->
         <request>
            <!--Optional:-->
            <requestMeta>
               <!--Optional:-->
               <clientHashKey>221d316146c591897238</clientHashKey>
               <!--Optional:-->
               <userName>admin</userName>
               <!--Optional:-->
               <params>
                  <!--Zero or more repetitions:-->
                  <param>
                     <key>?</key>
                     <value>?</value>
                     <!--Optional:-->
                     <ref>?</ref>
                  </param>
               </params>
            </requestMeta>
            <recipientSegmentRule>
               <!--Optional:-->
               <uuid>?</uuid>
               <!--Optional:-->
               <name>X-Generation</name>
               <!--Optional:-->
               <description>X generációs</description>
               <!--Optional:-->
               <createdBy>?</createdBy>
               <!--Optional:-->
               <createdAt>?</createdAt>
               <!--Optional:-->
               <organizationUuid>default</organizationUuid>
               <!--Optional:-->
               <definitions>
                  <!--Zero or more repetitions:-->
                  <definition>
                     <!--Optional:-->
                     <uuid>?</uuid>
                     <!--Optional:-->
                     <ruleType>ATTRIBUTE</ruleType>
                     <!--Optional:-->
                     <attributeType>DATE</attributeType>
                     <!--Optional:-->
                     <operand>yearOfBirth</operand>
                     <!--Optional:-->
                     <operator>GE</operator>
                     <!--Optional:-->
                     <filterValue>1960-01-01</filterValue>
                     <!--Optional:-->
                     <name>X-Generation</name>
                     <!--Optional:-->
                     <description>1960 után született</description>
                  </definition>
               </definitions>
            </recipientSegmentRule>
         </request>
      </v1:createRecipientSegmentRule>
   </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/campaign/v1" xmlns:ns3="http://hammy.dbx.hu/model/campaign/v1">
      <ns2:createRecipientSegmentRuleResponse>
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <recipientSegmentRule>
               <uuid>2bf1dbdf-1852-49be-af9e-ed88cd0086ca</uuid>
               <name>X-Generation</name>
               <description>X generációs</description>
               <createdBy>admin</createdBy>
               <organizationUuid>default</organizationUuid>
               <definitions>
                  <definition>
                     <uuid>826557f0-6b73-434f-a31c-5bc0bba59697</uuid>
                     <ruleType>ATTRIBUTE</ruleType>
                     <attributeType>DATE</attributeType>
                     <operand>yearOfBirth</operand>
                     <operator>GE</operator>
                     <filterValue>1960-01-01</filterValue>
                     <name>X-Generation</name>
                     <description>1960 után született</description>
                  </definition>
               </definitions>
            </recipientSegmentRule>
         </response>
      </ns2:createRecipientSegmentRuleResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/campaign/v1/recipientSegmentRules

body: JRecipientSegmentRule1

Válasz

Típus	Leírás
JRecipientSegmentRule1 [ ]	A létrehozott szabály.

Minta

KérésVálasz

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

{
  "data": {
        "type": "recipientSegmentRules",
        "id": "e499e9bc-8211-4fe9-aa94-f774e35d819h",
        "attributes": {
            "name": "X-GENERATION",
            "description": "X generációs",
            "createdAt": "2021-02-28T13:53:09.000+0100",
            "organizationUuid": "default",
            "definitions": [
                {
                    "uuid": "32067bc7-e8a5-41fc-b0dc-c488e069456h",
                    "ruleType": "ATTRIBUTE",
                    "attributeType": "DATE",
                    "operand": "yearOfBirth",
                    "operator": "GE",
                    "filterValue": "1960-01-01",
                    "name": "X-GENERATION",
                    "description": "1960 után született"
                },
                {
                    "uuid": "5dac2266-7566-43c7-b2df-21ced6393cah",
                    "ruleType": "ATTRIBUTE",
                    "attributeType": "DATE",
                    "operand": "yearOfBirth",
                    "operator": "LE",
                    "filterValue": "1980-01-01",
                    "name": "X-GENERATION",
                    "description": "1980 előtt született"
                }
            ]
        }
  },
  "included": [
  ]
}

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

{
    "data": {
        "type": "recipientSegmentRules",
        "id": "e499e9bc-8211-4fe9-aa94-f774e35d819h",
        "attributes": {
            "name": "X-GENERATION",
            "description": "X generációs",
            "createdBy": "admin",
            "organizationUuid": "default",
            "definitions": [
                {
                    "uuid": "5dac2266-7566-43c7-b2df-21ced6393cah",
                    "ruleType": "ATTRIBUTE",
                    "attributeType": "DATE",
                    "operand": "yearOfBirth",
                    "operator": "LE",
                    "filterValue": "1980-01-01",
                    "name": "X-GENERATION",
                    "description": "1980 előtt született"
                },
                {
                    "uuid": "32067bc7-e8a5-41fc-b0dc-c488e069456h",
                    "ruleType": "ATTRIBUTE",
                    "attributeType": "DATE",
                    "operand": "yearOfBirth",
                    "operator": "GE",
                    "filterValue": "1960-01-01",
                    "name": "X-GENERATION",
                    "description": "1960 után született"
                }
            ]
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Update recipient segment rule

Leválogatási szabály 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.
recipientSegmentRule	JRecipientSegmentRule1	A módosítandó szabály adatai.

Válasz

Mező	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.
recipientSegmentRule	JRecipientSegmentRule1	A módosított szabály.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://hammy.dbx.hu/api/campaign/v1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:updateRecipientSegmentRule>
         <!--Optional:-->
          <request>
            <!--Optional:-->
            <requestMeta>
               <!--Optional:-->
               <clientHashKey>221d316146c591897238</clientHashKey>
               <!--Optional:-->
               <userName>admin</userName>
               <!--Optional:-->
               <params>
                  <!--Zero or more repetitions:-->
                  <param>
                     <key>?</key>
                     <value>?</value>
                     <!--Optional:-->
                     <ref>?</ref>
                  </param>
               </params>
            </requestMeta>
            <recipientSegmentRule>
               <!--Optional:-->
               <uuid>?</uuid>
               <!--Optional:-->
               <name>X-Generation</name>
               <!--Optional:-->
               <description>X generációs</description>
               <!--Optional:-->
               <createdBy>?</createdBy>
               <!--Optional:-->
               <createdAt>?</createdAt>
               <!--Optional:-->
               <organizationUuid>default</organizationUuid>
               <!--Optional:-->
               <definitions>
                  <!--Zero or more repetitions:-->
                  <definition>
                     <!--Optional:-->
                     <uuid>e499e9bc-8211-4fe9-aa94-f774e35d819h</uuid>
                     <!--Optional:-->
                     <ruleType>ATTRIBUTE</ruleType>
                     <!--Optional:-->
                     <attributeType>DATE</attributeType>
                     <!--Optional:-->
                     <operand>yearOfBirth</operand>
                     <!--Optional:-->
                     <operator>GE</operator>
                     <!--Optional:-->
                     <filterValue>1960-01-01</filterValue>
                     <!--Optional:-->
                     <name>X-Generation</name>
                     <!--Optional:-->
                     <description>1960 után született</description>
                  </definition>
               </definitions>
            </recipientSegmentRule>
         </request>
      </v1:updateRecipientSegmentRule>
   </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/campaign/v1" xmlns:ns3="http://hammy.dbx.hu/model/campaign/v1">
      <ns2:updateRecipientSegmentRuleResponse>
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <recipientSegmentRule>
               <uuid>?</uuid>
               <name>X-Generation</name>
               <description>X generációs</description>
               <createdBy>admin</createdBy>
               <createdAt>2021-06-10T09:32:07.059+02:00</createdAt>
               <organizationUuid>default</organizationUuid>
               <definitions>
                  <definition>
                     <uuid>e499e9bc-8211-4fe9-aa94-f774e35d819h</uuid>
                     <ruleType>ATTRIBUTE</ruleType>
                     <attributeType>DATE</attributeType>
                     <operand>yearOfBirth</operand>
                     <operator>GE</operator>
                     <filterValue>1960-01-01</filterValue>
                     <name>X-Generation</name>
                     <description>1960 után született</description>
                  </definition>
               </definitions>
            </recipientSegmentRule>
         </response>
      </ns2:updateRecipientSegmentRuleResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

PUT hammy/json/campaign/v1/recipientSegmentRules/{{uuid}}

body: JRecipientSegmentRule1

Név	Típus	Leírás
uuid	String	a szabály UUID-ja.

Válasz

Típus	Leírás
JRecipientSegmentRule1	A módosított szabály.

Minta

KérésVálasz

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

{
    "data": {
        "type": "recipientSegmentRules",
        "attributes": {
            "name": "X-GENERATION",
            "description": "X generációs",
            "createdBy": "admin",
            "organizationUuid": "default",
            "definitions": [
                {
                    "uuid": "2bf8359a-f176-43c5-9448-11c88bbd9bf2",
                    "ruleType": "ATTRIBUTE",
                    "attributeType": "DATE",
                    "operand": "yearOfBirth",
                    "operator": "LT",
                    "filterValue": "1980-01-01",
                    "name": "BORNBEFORE1980",
                    "description": "1980 előtt született"
                },
                {
                    "uuid": "813f9c76-0063-46be-a0e1-7dc608336c70",
                    "ruleType": "ATTRIBUTE",
                    "attributeType": "DATE",
                    "operand": "yearOfBirth",
                    "operator": "GE",
                    "filterValue": "1960-01-01",
                    "name": "BORNAFTER1959",
                    "description": "1960-ban vagy utána született"
                }
            ]
        }
    },
  "included": [
  ]
}

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

{
    "data": {
        "type": "recipientSegmentRules",
        "id": "e499e9bc-8211-4fe9-aa94-f774e35d819c",
        "attributes": {
            "name": "X-GENERATION",
            "description": "X generációs",
            "createdBy": "admin",
            "createdAt": "2021-06-07T15:25:37.354+0200",
            "organizationUuid": "default",
            "definitions": [
                {
                    "uuid": "2bf8359a-f176-43c5-9448-11c88bbd9bf2",
                    "ruleType": "ATTRIBUTE",
                    "attributeType": "DATE",
                    "operand": "yearOfBirth",
                    "operator": "LT",
                    "filterValue": "1980-01-01",
                    "name": "BORNBEFORE1980",
                    "description": "1980 előtt született"
                },
                {
                    "uuid": "813f9c76-0063-46be-a0e1-7dc608336c70",
                    "ruleType": "ATTRIBUTE",
                    "attributeType": "DATE",
                    "operand": "yearOfBirth",
                    "operator": "GE",
                    "filterValue": "1960-01-01",
                    "name": "BORNAFTER1959",
                    "description": "1960-ban vagy utána született"
                }
            ]
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Find campaign part recipients

Kampányelemhez tartozó címzettek keresé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/campaign/v1/campaignPartRecipients

Paraméter	Típus	Leírás
uuid	String	Címzett UUID-ja.
campaignPartUuid	String	Kampányelem UUID-ja.
messageType	String	Sablon neve.
memberUuid	String	Member UUID.
recipientName	String	Címzett neve
recipientEmailAddress	String	Címzett email címe.
unsubscribed	Boolean	Leiratkozott-e a címzett
withActivity	Boolean	A címzettekhez tartozó eseményeket is le akarjuk-e kérdezni.
sent	Boolean	El lett-e küldve a levél a címzettnek.
opened	Boolean	Megnyitotta-e a címzett a levelet.
linkClicked	Boolean	Kattintott-e linkre a címzett.
mailLinkFilters	JMailLinkFilter1 [ ]	Levélbe rakott link szűrő (kattintott vagy nem).
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.

Válasz

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

Minta

KérésVálasz

GET {{baseUrl}}/json/campaign/v1/campaignPartRecipients?campaignUuid={{campaignUuid}}&withActivity=true
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": "campaignPartRecipients",
            "id": "cfde8be8-74a7-42e6-90f4-742e5496dadb",
            "attributes": {
                "campaignPartUuid": "cap-000001",
                "memberUuid": "d2bd66f8-ace1-4286-8751-e70ee3cedede",
                "recipientEmailAddress": "pelda.bela@dbx.hu",
                "withActivity": true,
                "sent": false,
                "opened": false,
                "unsubscribed": false,
                "clicked": false,
                "mailLinkUuids": []
            }
        }
    ],
    "meta": {
        "total": 1,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Create campaign part recipient

Kampányelem címzett létrehozása.

REST API

Ez a szolgáltatás jelenleg csak REST API-n keresztül elérhető.

REST API

REST API Info

Kérés

POST hammy/json/campaign/v1/campaignPartRecipients

body: JCampaignPartRecipient1

Válasz

Típus	Leírás
JCampaignPartRecipient1	A létrehozott címzett adatai.

Minta

KérésVálasz

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

{
  "data": {
            "type": "campaignPartRecipients",
            "id": "cfde8be8-74a7-42e6-90f4-742e5496dadb",
            "attributes": {
                "campaignPartUuid": "cap-000001",
                "memberUuid": "d2bd66f8-ace1-4286-8751-e70ee3cedede"
            }      
          }
}

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

{
    "data": {
        "type": "campaignPartRecipients",
        "id": "cfde8be8-74a7-42e6-90f4-742e5496dadb",
        "attributes": {
            "campaignPartUuid": "cap-000001",
            "memberUuid": "d2bd66f8-ace1-4286-8751-e70ee3cedede",
            "recipientEmailAddress": "pelda.bela@dbx.hu",
            "unsubscribed": false,
            "mailLinkUuids": []
        }
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Delete campaign part recipient

Kampányelem címzett törlé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

DELETE hammy/json/campaign/v1/campaignPartRecipients/{{uuid}}

Mező	Típus	Leírás
uuid	String	A törlendő címzett UUID-je.

Válasz

Név	Típus	Leírás
meta	JMeta1	Metaadatok.

Minta

KérésVálasz

DELETE /hammy/json/campaign/v1/campaignPartRecipients/{{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": "emptyResponse",
        "id": "fbfebb9a-2fed-4e2a-924c-628834eae2fd",
        "attributes": {}
    },
    "meta": {
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}