Newsman – Knowledge Base
Metoda API Newsman: transactional.messageSendTemplate
Prototip: transactional.messageSendTemplate(list_id, message, recipients, params, account_id)
Descriere: Trimite un mail prin API http folosind un template stocat. Contul SMTP folosit va fi ales pe baza adresei de from a listei sau se poate trimite un cont specific.
Metoda HTTP: POST
Endpoint HTTP: /transactional.messageSendTemplate.json
Endpoint XML-RPC: transactional.messageSendTemplate
Tip raspuns: arrayInformatii raspuns: Array conținând o listă cu item-uri de tip dicționar (email, status, reason, send_id) pentru fiecare destinatar
Parametrii request POST
| Variabila | Tip | Descriere |
|---|---|---|
| list_id | int|string | ID-ul listei pe baza căreia va fi identificat contul SMTP |
| message | array|struct | Array conținând informațiile mesajului care va fi trimis. Array-ul trebuie să conțină cheile următoare:
|
| recipients | array|struct | Array conținând destinatarii mesajului. Fiecare item trebuie să fie un array cu următoarele chei:
|
| params | array|struct|boolean | Array conținând parametrii globali pentru template. Poate fi null sau false. |
| account_id | string|boolean | ID-ul unui anumit cont SMTP prin care să se realizeze trimiterea (opțional). |
Parametrii raspuns
| Parametru | Descriere |
|---|---|
| array | array conținând o listă cu item-uri de tip dicționar (email, status, reason, send_id) pentru fiecare destinatar |
Exemplu output
[ { "send_id": "xxxxx-xxxxx-xxxxx-xxxxx", "status": "queued", "reason": "", "email": "john@example.com" } ]
Erori raspuns
| Cod | Mesaj | Descriere |
|---|---|---|
| 407 | Missing required param list_id | Parametrul list_id este obligatoriu |
| 407 | Missing required param message | Parametrul message este obligatoriu |
| 407 | Missing required param recipients | Parametrul recipients este obligatoriu |
| 407 | Missing required param params | Parametrul params este obligatoriu |
| 101 | Not allowed for list_id = %s | Acces nepermis la list_id |
| 17001 | Invalid message | Valoarea parametrului message este invalidă |
| 17002 | Invalid recipients | Valoarea parametrului recipients este invalidă |
| 17003 | Could not find the SMTP account | Nu a fost găsit contul SMTP |
| 17004 | The SMTP account is inactive | Contul SMTP este inactiv |
| 17005 | Could not send message: error_reason | Nu s-a putut trimite mesajul |
Exemple de erori
{ "err": true, "message": "Missing required param list_id", "code": 407 }
{ "err": true, "message": "Missing required param message", "code": 407 }
{ "err": true, "message": "Missing required param recipients", "code": 407 }
{ "err": true, "message": "Missing required param params", "code": 407 }
{ "err": true, "message": "Invalid message", "code": 17001 }
{ "err": true, "message": "Invalid recipients", "code": 17002 }
{ "err": true, "message": "Could not find the SMTP account", "code": 17003 }
{ "err": true, "message": "The SMTP account is inactive", "code": 17004 }
{ "err": true, "message": "Could not send message: Request error Missing name for recipient john@example.com. If empty please use empty string", "code": 17005 }