Send API V4
Send
Web service API
Kérés
A kötelező oszlop jelentése:
- * - minden esetben kötelező
- E - EMAIL, PORTAL channel esetén kötelező
- P - POST channel esetén kötelező
- A - ARCHIVE channel esetén kötelező
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| clientHashKey | String | A webszolgáltatást hívó kliens azonosítója. Kérje az üzemeltetéstől. | * |
| requestId | String (150) | A kérés azonosítója a hívó oldalon. | |
| batchId | String (100) | A levélköteg azonosítója. | |
| partnerRef | String (100) | Partner azonosító. | |
| messageType | String (100) | A kérés típusa. Értéke egy hammy-ben létező levélsablon azonosítója. | |
| scenarioName | String (100) | Az emailhez tartozó szcenárió azonosítója. | |
| messageTypeVersion | Integer | A levélhez tartozó template verziószáma. | |
| mailSubject | String (600) | Email tárgya. A mező, illetve kérés típusa egyidejűleg nem adható meg. | |
| mailBody | String (CLOB) | Email szövege. A mező, illetve kérés típusa egyidejűleg nem adható meg. | |
| mailHtmlBody | String (CLOB) | HTML email szövege. A mező, illetve kérés típusa egyidejűleg nem adható meg. | |
| recipientPostalAddress | String (255) | A címzett teljes postai címe. | P |
| recipientPhoneNumber | String (50) | A címzett telefonszáma. | P |
| recipientName | String (100) | A címzett teljes neve. | * |
| recipientEmailAddressCC | String (100) | A másolatot kapó személy email címe. Pontosvesszővel felsorolva több is megadható. | |
| recipientNameCC | String (100) | A másolatot kapó személy neve. | |
| recipientEmailAddress | String (100) | A címzett email címe. | E |
| recipientPSID | String (100) | A címzett facebook azonosítója. | |
| replyToAddress | String (100) | A válasz-email címe. | |
| replyToName | String (100) | A válasz-email neve. | |
| fromAddress | String (100) | A küldő email címe. | |
| fromName | String (100) | A küldő teljes neve. | |
| fromPhoneNumber | String (100) | A küldő telefonszáma. | |
| fromPageAccessToken | String (100) | A küldő Page Access Token-je. | |
| bccAddress | String (150) | Titkos másolat email cím. | |
| xmlData | String (CLOB) | Az üzenethez tartozó adatok XML formátumban. | |
| archivingExpected | Boolean | true esetén a levél tárgya és szövege archiválódik. | |
| certificationExpected | Boolean | true érték esetén a levél aláírásra kerül. | |
| replyEnvelopeAttached | Boolean | true jelzi , hogy az üzenethez válaszboríték van csatolva. | |
| paymentSlipAttached | Boolean | true jelzi , hogy az üzenethez csekk van csatolva. | |
| channel | MessageChannel | A csatorna neve. | |
| userName | String (100) | A felhasználó neve. | |
| relatedMessageId | Integer | Kapcsolódó üzenet Id. | |
| campaignPartContentUuid | Integer | Kapcsolódó kampányrész UUID. | |
| letterType | String (LetterType) | A postai levél típusa. | P |
| repliedMessageUuid | String (100) | Annak az üzenetnek az azonosítója, amire a hívó oldal válaszol. | |
| attachments | Attachment_V1 [ ] | A csatolmányokat tartalmazó lista. | A |
| properties | Property_V1 [ ] | Az üzenethez tartozó egyéb adatok, metaadatok. | |
| params | Param_V1 [ ] | A szolgáltatás működését befolyásoló egyéb paraméterek listája. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| messageId | Integer | Az aktuális levél adatbázisbeli azonosítója. |
| status | ResponseStatus_V1 | A válasz státusza. |
| params | Param_V1 [ ] | A szolgáltatás működését befolyásoló egyéb paraméterek listája. |
Minta
REST API
Kérés
POST hammy/json/send/v4/send
multipart/form-data vagy multipart/mixed kérés.
A kötelező oszlop jelentése:
- * - minden esetben kötelező
- E - EMAIL, PORTAL channel esetén kötelező
- P - POST channel esetén kötelező
- A - ARCHIVE channel esetén kötelező
multipart név: message
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| requestMeta | JRequestMeta_V1 | Metainformációk. | |
| requestId | String (150) | A kérés azonosítója a hívó oldalon | |
| batchId | String (100) | A levélköteg azonosítója | |
| partnerRef | String (100) | Partner azonosító | |
| messageType | String (100) | A kérés típusa. Értéke egy hammy-ben létező levélsablon azonosítója. | |
| scenarioName | String (100) | Az emailhez tartozó szcenárió azonosítója. | |
| messageTypeVersion | Integer | A levélhez tartozó template verziószáma. | |
| mailSubject | String (600) | Email tárgya. A mező, illetve kérés típusa egyidejűleg nem adható meg. | |
| mailBody | String (CLOB) | Email szövege. A mező, illetve kérés típusa egyidejűleg nem adható meg. | |
| mailHtmlBody | String (CLOB) | HTML email szövege. A mező, illetve kérés típusa egyidejűleg nem adható meg. | |
| recipientPostalAddress | String (255) | A címzett teljes postai címe. | P |
| recipientEmailAddress | String (100) | A címzett email címe. | E |
| recipientName | String (100) | A címzett teljes neve. | * |
| recipientEmailAddressCC | String (100) | A másolatot kapó személy email címe. Pontosvesszővel felsorolva több is megadható. | |
| recipientNameCC | String (100) | A másolatot kapó személy neve. | |
| recipientPhoneNumber | String (50) | A címzett telefonszáma. | P |
| recipientPSID | String (100) | A címzett facebook azonosítója. | |
| replyToAddress | String (100) | A válasz-email címe. | |
| replyToName | String (100) | A válasz-email neve. | |
| fromAddress | String (100) | A küldő email címe. | |
| fromName | String (100) | A küldő teljes neve. | |
| fromPhoneNumber | String (100) | A küldő telefonszáma. | |
| fromPageAccessToken | String (100) | A küldő Page Access Token-je. | |
| bccAddress | String (150) | Titkos másolat email cím. | |
| xmlData | String (CLOB) | Az üzenethez tartozó adatok XML formátumban. | |
| archivingExpected | Boolean | true esetén a levél tárgya és szövege archiválódik. | |
| certificationExpected | Boolean | true érték esetén a levél aláírásra kerül. | |
| replyEnvelopeAttached | Boolean | true jelzi , hogy az üzenethez válaszboríték van csatolva. | |
| paymentSlipAttached | Boolean | true jelzi , hogy az üzenethez csekk van csatolva. | |
| channel | MessageChannel | A küldés csatornája. | |
| relatedMessageId | Integer | Kapcsolódó üzenet Id. | |
| campaignPartContentUuid | Integer | Kapcsolódó kampányrész UUID. | |
| letterType | String (100) | A postai levél típusa: NORMAL (normál levél), REGISTERED_MAIL (ajánlott), CERTIFIED_MAIL(tértivevényes). | P |
| repliedMessageUuid | String (100) | Annak az üzenetnek az azonosítója, amire a hívó oldal válaszol. | |
| calendar | JCalendar1 | Naptár objektum, ennek segítségével lehet naptár bejegyzést is csatolni az üzenethez. | |
| properties | JProperty1 [ ] | Az üzenethez tartozó egyéb adatok, metaadatok. | |
| attachments | JAttachment2 [ ] | A csatolmányokat tartalmazó lista. | A |
A csatolmányokat további partokban lehet megadni, a part neve a csatolmány referenciája.
Válasz
| Név | Típus | Leírás |
|---|---|---|
| messageId | Integer | Az aktuális levél adatbázisbeli azonosítója. (vnd.api ID) |
| meta | JMeta1 | A válaszhoz tartozó metainformációk. |
Minta
POST /hammy/json/send/v4/send?
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-type: application/json
Accept: application/json
{
"batchId":null,
"relatedMessageId":null,
"campaignPartContentUuid":null,
"messageType":"TESZTSABLON",
"scenarioName":null,
"messageTypeVersion":null,
"recipientName":"Teszt Ügyfél",
"recipientEmailAddress":"teszt@dbx.hu",
"recipientPostalAddress":null,
"recipientPostalAddressCountryCode":"HU",
"recipientPostalAddressPostalCode":"1027",
"recipientPostalAddressCity":"Budapest",
"recipientPostalAddressStreet":"Bem rakpart 56",
"recipientPostalAddressStreetType":"rakpart",
"recipientPostalAddressStreetNumber":"56",
"recipientPostalAddressBuilding":null,
"recipientPostalAddressFloor":null,
"recipientPostalAddressDoor":null,
"recipientEmailAddressCC":null,
"recipientNameCC":null,
"recipientPhoneNumber":"+36301325567",
"bccAddress":null,
"replyToAddress":null,
"replyToName":null,
"fromAddress":null,
"fromName":null,
"fromPhoneNumber":null,
"fromPageAccessToken":null,
"mailSubject":null,
"mailBody":null,
"mailHtmlBody":null,
"archivingExpected":false,
"certificationExpected":false,
"paymentSlipAttached":null,
"letterType":null,
"calendar":null,
"repliedMessageUuid":null,
"recipientPSID":null,
"properties":[
{
"id": null,
"key": "Teszt",
"value": "TesztErtek",
"index": null,
"isMetaData": false
}
]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"meta": {
"responseStatus": {
"code": 0,
"messages": []
},
"params": []
},
"messageId": 311328
}
Queue API minta
Quick send
Előkészület nélküli gyors levélküldés csv forrásból beolvasott címzetteknek.
Web service
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| filename | String | Bemeneti csv file neve. | |
| data | Byte [ ] | Input byte tömbbként. | |
| requestMeta | RequestMeta_V1 | A kéréshez tartozó metaadatok. | * |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| jobId | String | A küldésért felelős job azonosítója. |
| status | ResponseStatus_V1 | A válasz státusza. |
| params | Param_V1 [ ] | A szolgáltatás működését befolyásoló egyéb paraméterek listája. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:send="http://send.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<send:quickSend>
<request>
<filename>pelda.csv</filename>
<data>cid:145826013353</data>
<requestMeta>
<clientHashKey>221d316146c591897238</clientHashKey>
<userName>def</userName>
</requestMeta>
</request>
</send:quickSend>
</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>
<ns3:quickSendResponse xmlns:ns2="http://hammy.dbx.hu/api/send/v4" xmlns:ns3="http://send.api.hammy.dbx.hu/">
<response>
<jobId>c7030978-6bd5-4ed2-a66f-c4146459f877</jobId>
<status>
<code>0</code>
<messages/>
</status>
</response>
</ns3:quickSendResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
POST hammy/json/send/v4/quickSend
| Név | Típus | Leírás |
|---|---|---|
| filename | String | Bemeneti csv file neve. |
| csvSeparator | String | Elválasztó karaker a csv fileban. |
| csvFileEncoding | String | A csv karakterkódolása. |
| requestMeta | RequestMeta_V1 | A kéréshez tartozó metaadatok. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| id | String | Az válasz azonosítója. (vnd.api ID) |
| jobId | String | A küldésért felelős job azonosítója. |
| meta | JMeta1 | A válaszhoz tartozó metainformációk. |
CSV bemenet
A csv fájlban adhatjuk meg, hogy mely email címekre, milyen konfigurációval akarunk küldeni levelet. Alább látható egy példa csv fájl, amely segítségével 2 címzettnek küldhetünk DMS csatornán keresztül üzenetet.
recipientAddress;recipientName;request.messageType;request.fromAddress;request.fromName;request.archivingExpected;TANACSADO;request.property.ARCHIVE_TARGET
peldaemail1@gmail.com;Címzett Áron;AAA_Teszt_V1;hammy@dbx.hu;From;true;tanácsadó;DMS
peldaemail2@gmail.com;Fogadó Bertalan;AAA_Teszt_V2;hammy@dbx.hu;From;true;tanácsadó;DMS
Minta
Resend
Ebben a verzióban nem változott.
Set message properties
Ebben a verzióban nem változott.
Set attachment properties
Ebben a verzióban nem változott.
Send campaign part
Web service API
Kérés
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| memberUuid | String | A címzett UUID azonosítója. | * |
| campaignPartContentUuid | String | A kampányelem UUID azonosítója. | * |
| requestMeta | RequestMeta_V1 | A kéréshez tartozó metaadatok. | * |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| messageId | Integer | Az aktuális levél adatbázisbeli azonosítója. |
| status | ResponseStatus_V1 | A válasz státusza. |
| params | Param_V1 [ ] | A szolgáltatás működését befolyásoló egyéb paraméterek listája. |
Minta
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v4="http://hammy.dbx.hu/api/send/v4">
<soapenv:Header/>
<soapenv:Body>
<v4:sendCampaignPart>
<!--Optional:-->
<request>
<memberUuid>c47cebd3-c601-4a80-a920-a97850523ca6</memberUuid>
<campaignPartContentUuid>ca326575-50e8-4034-81a0-fb1df1a9d106</campaignPartContentUuid>
<!--Optional:-->
<requestMeta>
<!--Optional:-->
<clientHashKey>abc1236146c591897999</clientHashKey>
</requestMeta>
</request>
</v4:sendCampaignPart>
</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>
<ns2:sendCampaignPartResponse xmlns:ns2="http://hammy.dbx.hu/api/send/v4" xmlns:ns3="http://send.api.hammy.dbx.hu/">
<response>
<messageId>19219</messageId>
<status>
<code>0</code>
<messages/>
</status>
</response>
</ns2:sendCampaignPartResponse>
</S:Body>
</S:Envelope>
REST API
Kérés
POST hammy/json/send/v4/sendCampaignPart
| Név | Típus | Leírás | Kötelező |
|---|---|---|---|
| memberUuid | String | A címzett UUID azonosítója. | * |
| campaignPartContentUuid | String | A kampányelem UUID azonosítója. | * |
| requestMeta | JRequestMeta_V1 | A kéréshez tartozó metaadatok. |
Válasz
| Név | Típus | Leírás |
|---|---|---|
| messageId | Integer | Az aktuális levél adatbázisbeli azonosítója. (vnd.api ID) |
| meta | JMeta1 | A válaszhoz tartozó metainformációk. |
Minta
POST /hammy/json/send/v1/send?clientHashKey={{clientHashKey}}&userName={{userName}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/json
{
"memberUuid": "c47cebd3-c601-4a80-a920-a97850523ca6",
"campaignPartContentUuid": "ca326575-50e8-4034-81a0-fb1df1a9d106"
}
HTTP/1.1 200 OK
Authorization: JWT {{jwtToken}}
Content-Type: application/vnd.api+json
{
"data": {
"type": "sendResponse",
"id": "19218",
"attributes": {}
},
"meta": {
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}
Utoljára frissítve
