Regisztráció Belépés

E-mail API

Kimenő e-mailek kezelése — lekérés, létrehozás, küldés és törlés

Végpontok

Authentikáció

Minden API kéréshez szükséges az X-API-KEY header küldése.

X-API-KEY: {az_api_kulcsod}

Maradt még kérdésed?

Írj ticketet nekünk, vagy nézz körbe a keresőnkben.

Ha tetszett, oszd meg másokkal

Alap URL

https://{tenant}.logzi.com/api/email/

Minden kérés JSON választ ad vissza. Sikeres válasz esetén result.code == 1, hiba esetén result.code == 0.

GET /api/email/get

Egyetlen e-mail üzenet lekérése azonosító alapján.

Query paraméterek

ParaméterTípusKötelezőLeírás
idintE-mail üzenet azonosítója

Példa kérés

GET /api/email/get?id=55
X-API-KEY: {az_api_kulcsod}
GET /api/email/clone

Meglévő e-mail másolatának lekérése (új küldéshez előkészített sablon).

Query paraméterek

ParaméterTípusKötelezőLeírás
idintA másolandó e-mail azonosítója

Példa kérés

GET /api/email/clone?id=55
X-API-KEY: {az_api_kulcsod}
GET /api/email/list

E-mailek lapozható listájának lekérése szűrési lehetőségekkel.

Query paraméterek

ParaméterTípusKötelezőLeírás
list_offsetintLapozás eltolása (alapértelmezett: 0)
list_condition[company_user_id]intSzűrés küldő munkatárs azonosítóra

Példa kérés

GET /api/email/list?list_offset=0
X-API-KEY: {az_api_kulcsod}
GET /api/email/list_receipt

Egy adott bizonylathoz küldött e-mailek listájának lekérése.

Query paraméterek

ParaméterTípusKötelezőLeírás
list_condition[receipt_id]intBizonylat azonosítója
list_condition[company_user_id]intSzűrés küldő munkatársra

Példa kérés

GET /api/email/list_receipt?list_condition[receipt_id]=123
X-API-KEY: {az_api_kulcsod}
POST /api/email/save

E-mail üzenet létrehozása vagy módosítása. Új e-mailhez data[id] = 0.

POST mezők — data objektum

MezőTípusKötelezőLeírás
idint0 = új e-mail, >0 = módosítás
company_user_idintKüldő munkatárs azonosítója
email_subjectstringE-mail tárgya
email_recepientstringCím(zett) e-mail cím
email_message_rawstringE-mail szövegtörzse
email_message_idintE-mail sablon azonosítója
email_directory_idintMappa azonosítója
email_status_idintStátusz azonosítója
email_ticket_idintKapcsolódó jegy azonosítója

Példa kérés

POST /api/email/save
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "company_user_id": 3,
    "email_subject": "Számla melléklet",
    "email_recepient": "ugyfel@pelda.hu",
    "email_message_raw": "Kedves Ügyfelünk, mellékeljük a számlát."
  }
}
POST /api/email/delete

E-mail üzenet törlése azonosító alapján.

POST mezők — data objektum

MezőTípusKötelezőLeírás
idintA törlendő e-mail azonosítója

Példa kérés

POST /api/email/delete
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{ "data": { "id": 55 } }
GET /api/email/send_queue

E-mail üzenet azonnali küldése a küldési sorból. Azonosító alapján kiküldi a várakozó üzenetet.

Query paraméterek

ParaméterTípusKötelezőLeírás
idintA küldendő e-mail azonosítója

Példa kérés

GET /api/email/send_queue?id=55
X-API-KEY: {az_api_kulcsod}

Vedd fel a kapcsolatot velünk

Érdeklődsz a szoftverünkkel kapcsolatban, írj bátran!

Érdeklődés küldése

Segítségre van szükséged?

Ha nem találod a választ és szükséged van segítségre

Nézz körbe a help centerben

Regisztrációdat hozd létre most,
fizess később!

Próbáld ki 3 napig ingyen, kockázatok és kötöttségek nélkül!
Regisztráció készítése
Regisztráció