Levelek — emails
| Művelet | Mit tesz | Jog |
|---|---|---|
GET /emails/list |
levelek, szűrőkkel | emails:read |
GET /emails/get |
egy levél, a szövegével és a csatolmányai listájával | emails:read |
GET /emails/schema |
a mezők leírása | emails:read |
POST /emails/send |
levél küldése | emails:send |
POST /emails/draft |
piszkozat egy felhasználónak | emails:write |
A piszkozat a list-ben és a get-ben nem jelenik meg.
A mezők
Szekció neve “A mezők”| Mező | Régi | Típus | Listában | Leírás | |
|---|---|---|---|---|---|
id |
emailid |
integer |
csak olvasható | ✓ | belső azonosító |
direction |
email_direction |
string |
csak olvasható | ✓ | in — bejövő, out — kimenő |
status |
email_state |
string |
csak olvasható | ✓ | az állapot — lent |
projectId |
prid |
integer |
csak olvasható | ✓ | a projekt belső azonosítója |
projectCode |
prcode |
string |
csak olvasható | ✓ | a projekt külső azonosítója |
projectName |
— | string |
csak olvasható | ✓ | a projekt neve |
accountId |
— | integer |
csak olvasható | ✓ | a levél e-mail fiókjának belső azonosítója |
accountName |
— | string |
csak olvasható | ✓ | a fiók neve |
subject |
email_subject |
string(250) |
csak olvasható | ✓ | a tárgy |
body |
email_message |
string |
csak olvasható | a levél szövege, HTML — csak a get adja |
|
from |
from_address · from_name |
object |
csak olvasható | ✓ | a feladó: address, name |
replyTo |
reply_address · reply_name |
object |
csak olvasható | ✓ | a válaszcím, ha van |
to · cc · bcc |
to_addresses · cc_addresses · bcc_addresses |
array |
csak olvasható | ✓ | a címzettek, a másolat és a titkos másolat: [{ "address", "name" }] |
createdAt |
— | string |
csak olvasható | ✓ | a levél felvételének ideje |
scheduledAt |
scheduled_time |
string |
csak olvasható | ✓ | a kimenő levél tervezett küldése |
sentAt |
send_time |
string |
csak olvasható | ✓ | a küldés ideje; a bejövő levélnél a feladó küldése |
updatedAt |
— | string |
csak olvasható | ✓ | az utolsó módosítás ideje |
userId |
userid |
integer |
csak olvasható | ✓ | a levél kezelője; üres, ha nem felhasználó (a rendszer vagy egy API-kulcs) |
userCode |
user_code |
string |
csak olvasható | ✓ | a kezelő külső azonosítója |
userName |
— | string |
csak olvasható | ✓ | a kezelő neve |
userExtCode |
— | string |
csak olvasható | ✓ | a kezelő egyéb kódja |
listId |
lsid |
integer |
csak olvasható | ✓ | az ügyfél listája |
listCode |
lscode |
string |
csak olvasható | ✓ | a lista külső azonosítója |
listName |
— | string |
csak olvasható | ✓ | a lista neve |
listItemId |
listitem_num |
integer |
csak olvasható | ✓ | az ügyfél listatétele |
listItemCode |
— | string |
csak olvasható | ✓ | a listatétel külső azonosítója |
listItemName |
spec_header1_data |
string |
csak olvasható | ✓ | az ügyfél a lista első fejléc-oszlopából — listánként más adat |
contactNo |
— | integer |
csak olvasható | ✓ | a listatétel kontaktjának sorszáma |
contactName |
— | string |
csak olvasható | ✓ | a kontakt neve |
interviewId |
interviewid |
integer |
csak olvasható | ✓ | a hívás rekordja, amelyikhez a levél tartozik |
interviewCode |
— | string |
csak olvasható | ✓ | az interjú kódja |
hasAttachments |
— | boolean |
csak olvasható | ✓ | van-e csatolmánya |
attachments |
— | array |
csak olvasható | a csatolmányok: no (sorszám), fileName, inline (a szövegbe ágyazott kép) — csak a get adja |
Az állapot: new · reopened · scheduled · open · suspended · forwarded · replied · closed · sent ·
blocked (tiltólistás címzett miatt nem ment ki) · misconfigured (a fiók beállítása hibás) · failed · deleted.
GET /emails/list Levelek
Szekció neve “GET /emails/list Levelek”A levelek, lapozva (A lapozás). A szűrők mind elhagyhatók:
| Paraméter | Régi | Típus | Leírás |
|---|---|---|---|
projectId · projectCode |
prid · prcode |
a projekt levelei | |
direction |
direction |
string |
in vagy out |
status |
— | string |
egy állapot |
userId · userCode |
userid · user_code |
a felhasználó levelei | |
listId · listCode |
lsid · lscode |
a lista ügyfeleinek levelei | |
listItemId |
— | integer |
egy ügyfél levelei |
address |
email_address |
string |
a levél egyik címe pontosan ez |
sentSince · sentUntil |
start_date · end_date |
string |
a küldés ideje — a még ki nem ment levélnél a tervezett idő — ettől, eddig |
{ "emails": [ { "id": 90211, "direction": "in", "status": "new", "projectId": 12, "projectCode": "SUPPORT", "projectName": "Ügyfélszolgálat", "accountId": 4, "accountName": "Ügyfélszolgálat", "subject": "Számla kérdés", "from": { "address": "anna.kovacs@example.com", "name": "Kovács Anna" }, "to": [{ "address": "info@example.com", "name": "info@example.com" }], "cc": [], "bcc": [], "createdAt": "2026-10-19T09:12:04+02:00", "scheduledAt": null, "sentAt": "2026-10-19T09:11:58+02:00", "updatedAt": "2026-10-19T09:12:05+02:00", "userId": null, "userCode": null, "userName": null, "userExtCode": null, "listId": 3, "listCode": "OKT-2026", "listName": "Októberi lista", "listItemId": 884513, "listItemCode": "C-20932", "listItemName": "Kovács Anna", "contactNo": 1, "contactName": "Kovács Anna", "interviewId": null, "interviewCode": null, "hasAttachments": false } ], "hasMore": false}curl "$BASE/emails/list?direction=in&status=new" -H "X-API-Key: $API_KEY"GET /emails/get Egy levél
Szekció neve “GET /emails/get Egy levél”A levél a lista mezőivel, a szövegével (body) és a csatolmányai listájával (attachments).
curl "$BASE/emails/get?id=90211" -H "X-API-Key: $API_KEY"GET /emails/schema A mezők leírása
Szekció neve “GET /emails/schema A mezők leírása”A címek és a csatolmányok leírása a mezők mellett áll. A válasz alakja: A mezők leírása.
curl "$BASE/emails/schema" -H "X-API-Key: $API_KEY"POST /emails/send Levél küldése
Szekció neve “POST /emails/send Levél küldése”A levél a projekt e-mail fiókjából megy: a feladó és a válaszcím a fiók beállítása, és a fiók másolat-címei mindig
megkapják. A kérés a címzettet adja, a másolatot és a titkos másolatot bővíti. A válasz 202: a levél küldésre vár, a
get mutatja, hova jutott — a Location fejléc oda mutat. Ugyanaz a levél — tárgy, első címzett, szöveg — 10 percen
belül csak egyszer megy ki: a másodiké failed.
| Mező | Régi | Típus | Leírás | |
|---|---|---|---|---|
projectId · projectCode |
prid · prcode |
kötelező | a projekt; a levél a projekt e-mail fiókjából megy | |
to |
to_addresses |
array |
kötelező | a címzettek: [{ "address": …, "name": … }], a név elhagyható; a cím legfeljebb 80 karakter |
cc · bcc |
cc_addresses · bcc_addresses |
array |
a másolat és a titkos másolat, ugyanígy | |
subject |
email_subject |
string(250) |
kötelező | a tárgy |
body |
email_message |
string |
a szöveg, HTML; a nem biztonságos részei (szkript, űrlap) kimaradnak | |
attachments |
attachments |
array |
[{ "fileName": …, "content": … }], a tartalom base64-ben; fájlonként legfeljebb 5 MB, együtt 15 MB |
|
sendAt |
send_time |
string |
a küldés ideje; elhagyva most | |
listItemId, vagy listId / listCode és listItemCode |
listitem_num · lsid · lscode · extcode |
az ügyfél listatétele, a projekt egyik listájából vagy telefonkönyvéből | ||
contactNo |
contact_num |
integer |
a listatétel kontaktja |
{ "projectCode": "SUPPORT", "to": [{ "address": "anna.kovacs@example.com", "name": "Kovács Anna" }], "subject": "Visszaigazolás", "body": "<p>Kedves Anna!</p><p>Megkaptuk a kérését.</p>", "listItemId": 884512, "contactNo": 1}{ "id": 90240 }| HTTP | code |
Mikor |
|---|---|---|
422 |
VALIDATION_FAILED |
nincs címzett (NO_RECIPIENT) · érvénytelen cím (INVALID_ADDRESS) · üres vagy túl hosszú tárgy (SUBJECT_REQUIRED, SUBJECT_TOO_LONG) · túl hosszú szöveg (BODY_TOO_LONG) · tiltólistás címzett (BLOCKED_RECIPIENT) · üres vagy túl nagy csatolmány (ATTACHMENT_EMPTY, ATTACHMENT_TOO_LARGE, ATTACHMENTS_TOO_LARGE) · a listatétel nem a projekté (ITEM_NOT_IN_PROJECT) |
422 |
VALIDATION_FAILED |
a projektnek nincs e-mail fiókja (PROJECT_NO_ACCOUNT) · a fiók beállítása hiányos (ACCOUNT_NO_SMTP, ACCOUNT_NO_FROM) |
curl "$BASE/emails/send" -H "X-API-Key: $API_KEY" -H "Content-Type: application/json" \ -d '{"projectCode": "SUPPORT", "to": [{"address": "anna.kovacs@example.com"}], "subject": "Visszaigazolás", "body": "<p>Megkaptuk.</p>"}'POST /emails/draft Piszkozat
Szekció neve “POST /emails/draft Piszkozat”A piszkozat a megadott felhasználó Piszkozatok mappájába kerül: a felületen ő nyitja meg, és ő küldi el. A bejövő levélre
írt válasz-piszkozatot (replyToId) a levél Válasz gombja nyitja; a szövege a kérésé, aláírás és idézet nélkül. A
címzett és a tárgy elhagyható. A piszkozat az API-n nem olvasható vissza: a válasz 201, Location nélkül.
| Mező | Régi | Típus | Leírás | |
|---|---|---|---|---|
userId · userCode |
— | kötelező | a felhasználó, akié a piszkozat: aktív, és kezelheti a projekt leveleit | |
replyToId |
— | integer |
a levél, amire a piszkozat válasz: a projekt, a fiók és az ügyfél az eredetié; a to alapból az eredeti válaszcíme vagy feladója, a subject alapból Re: … |
|
projectId · projectCode |
— | új levélnél kötelező | a projekt; a piszkozat a projekt e-mail fiókjáé | |
to · cc · bcc · subject · body · attachments · listItemId (vagy listId / listCode és listItemCode) · contactNo |
— | mint a send-nél; válasznál a projekt és az ügyfél nem adható meg |
{ "userCode": "HR-1042", "replyToId": 90211, "body": "<p>Kedves Anna!</p><p>A számlát csatoltan küldjük.</p>"}{ "id": 90241 }| HTTP | code |
Mikor |
|---|---|---|
409 |
CONFLICT |
a felhasználónak már van piszkozata erre a levélre (DRAFT_EXISTS) |
422 |
VALIDATION_FAILED |
a felhasználó nem kezelheti a projekt leveleit (DRAFT_USER_NOT_ALLOWED) · a levélre nem lehet válaszolni (REPLY_NOT_POSSIBLE) · a projektnek nincs e-mail fiókja (PROJECT_NO_ACCOUNT) · 80 karakternél hosszabb cím (INVALID_ADDRESS) · túl hosszú tárgy vagy szöveg, csatolmány és listatétel, mint a send-nél |
curl "$BASE/emails/draft" -H "X-API-Key: $API_KEY" -H "Content-Type: application/json" \ -d '{"userCode": "HR-1042", "projectCode": "SUPPORT", "to": [{"address": "anna.kovacs@example.com"}], "subject": "Ajánlat"}'A régi API-ból
Szekció neve “A régi API-ból”| Cím | Kérés | Válasz | Működés |
|---|---|---|---|
email/list → GET /emails/list |
a message (a szöveg a listában) nincs: a szöveg a get-ben |
az állapot szóval, a címek objektumként | a piszkozat nincs benne |
email/get → GET /emails/get |
emailid → id |
— | — |
email/new → POST /emails/send |
a from_*, a reply_* és a cfid nincs: a feladó, a válaszcím és a fiók a projekté |
emailid → id |
a csatolmány együtt 15 MB lehet (a régiben 5); a listatételnek nem kell a címzett címével egyeznie |
| — | — | — | csak az újban: emails/schema, emails/draft |