API E-mail

Gestionarea e-mailurilor trimise — preluare, creare, trimitere și ștergere

URL de bază

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

Toate cererile returnează un răspuns JSON. În caz de succes result.code == 1, în caz de eroare result.code == 0.

GET /api/email/get

Preluarea unui singur mesaj e-mail pe baza identificatorului.

Parametri de interogare

ParametruTipObligatoriuDescriere
idintIdentificatorul mesajului e-mail

Exemplu de cerere

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

Preluarea unei copii a unui e-mail existent (șablon pregătit pentru o nouă trimitere).

Parametri de interogare

ParametruTipObligatoriuDescriere
idintIdentificatorul e-mailului de copiat

Exemplu de cerere

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

Preluarea paginată a listei de e-mailuri, cu opțiuni de filtrare.

Parametri de interogare

ParametruTipObligatoriuDescriere
list_offsetintDecalajul paginării (implicit: 0)
list_condition[company_user_id]intFiltrare după identificatorul angajatului expeditor

Exemplu de cerere

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

Preluarea listei e-mailurilor trimise pentru un anumit document.

Parametri de interogare

ParametruTipObligatoriuDescriere
list_condition[receipt_id]intIdentificatorul documentului
list_condition[company_user_id]intFiltrare după angajatul expeditor

Exemplu de cerere

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

Crearea sau modificarea unui mesaj e-mail. Pentru un e-mail nou, data[id] = 0.

Câmpuri POST — data obiectul

CâmpTipObligatoriuDescriere
idint0 = e-mail nou, >0 = modificare
company_user_idintIdentificatorul angajatului expeditor
email_subjectstringSubiectul e-mailului
email_recepientstringAdresa de e-mail a destinatarului
email_message_rawstringCorpul textului e-mailului
email_message_idintIdentificatorul șablonului de e-mail
email_directory_idintIdentificatorul folderului
email_status_idintIdentificatorul statusului
email_ticket_idintIdentificatorul tichetului asociat

Exemplu de cerere

POST /api/email/save
X-API-KEY: {cheia_dvs_api}
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

Ștergerea unui mesaj e-mail pe baza identificatorului.

Câmpuri POST — data obiectul

CâmpTipObligatoriuDescriere
idintIdentificatorul e-mailului de șters

Exemplu de cerere

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

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

Trimiterea imediată a unui mesaj e-mail din coada de trimitere. Trimite mesajul aflat în așteptare, pe baza identificatorului.

Parametri de interogare

ParametruTipObligatoriuDescriere
idintIdentificatorul e-mailului de trimis

Exemplu de cerere

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

Ia legătura cu noi

Ești interesat de software-ul nostru? Scrie-ne cu încredere!

Ai nevoie de ajutor?

Dacă nu găsești răspunsul și ai nevoie de asistență

Creează-ți contul acum,
plătește mai târziu!

Încearcă gratuit timp de 3 zile, fără riscuri și fără obligații!