Základná URL
https://{tenant}.logzi.com/api/email/
Každá požiadavka vracia odpoveď vo formáte JSON. Pri úspešnej odpovedi je result.code == 1, v prípade chyby result.code == 0.
/api/email/get
Získanie jednej e-mailovej správy na základe identifikátora.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Identifikátor e-mailovej správy |
Príklad požiadavky
GET /api/email/get?id=55
X-API-KEY: {vas_api_kluc}/api/email/clone
Získanie kópie existujúceho e-mailu (šablóna pripravená na nové odoslanie).
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Identifikátor e-mailu, ktorý sa má skopírovať |
Príklad požiadavky
GET /api/email/clone?id=55
X-API-KEY: {vas_api_kluc}/api/email/list
Získanie stránkovateľného zoznamu e-mailov s možnosťou filtrovania.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
list_offset | int | Posun stránkovania (predvolene: 0) | |
list_condition[company_user_id] | int | Filter podľa identifikátora odosielajúceho pracovníka |
Príklad požiadavky
GET /api/email/list?list_offset=0
X-API-KEY: {vas_api_kluc}/api/email/list_receipt
Získanie zoznamu e-mailov odoslaných k danému dokladu.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
list_condition[receipt_id] | int | Identifikátor dokladu | |
list_condition[company_user_id] | int | Filter podľa odosielajúceho pracovníka |
Príklad požiadavky
GET /api/email/list_receipt?list_condition[receipt_id]=123
X-API-KEY: {vas_api_kluc}/api/email/save
Vytvorenie alebo úprava e-mailovej správy. Pre nový e-mail data[id] = 0.
POST polia — objekt data
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | int | 0 = nový e-mail, >0 = úprava | |
company_user_id | int | Identifikátor odosielajúceho pracovníka | |
email_subject | string | Predmet e-mailu | |
email_recepient | string | E-mailová adresa príjemcu | |
email_message_raw | string | Telo textu e-mailu | |
email_message_id | int | Identifikátor e-mailovej šablóny | |
email_directory_id | int | Identifikátor priečinka | |
email_status_id | int | Identifikátor stavu | |
email_ticket_id | int | Identifikátor súvisiaceho tiketu |
Príklad požiadavky
POST /api/email/save
X-API-KEY: {vas_api_kluc}
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."
}
}/api/email/delete
Odstránenie e-mailovej správy na základe identifikátora.
POST polia — objekt data
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Identifikátor e-mailu, ktorý sa má odstrániť |
Príklad požiadavky
POST /api/email/delete
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{ "data": { "id": 55 } }/api/email/send_queue
Okamžité odoslanie e-mailovej správy z odosielacieho frontu. Na základe identifikátora odošle čakajúcu správu.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Identifikátor e-mailu, ktorý sa má odoslať |
Príklad požiadavky
GET /api/email/send_queue?id=55
X-API-KEY: {vas_api_kluc}Zaregistruj sa teraz,
zaplať neskôr!
