MOR API email send

From Kolmisoft Wiki

Jump to: navigation, search


[edit] Description

MOR API Send Email

[edit] Usage

  • From MOR X4 call: /api/email_send
  • For Backwards-compatibility old name 'send_email' is also usable. Call: /api/send_email
  • Methods: POST, GET(if allowed, not recomended)

[edit] Parametres

NOTE. If in email template there are used some parameters and you do not send them over API, client will get email with empty spaces instead of those parameters. Before sending email over API, be sure that you send all parameters used in email template.

[edit] Request

We have email_name = registration_confirmation_for_user, email_to_user_id = 142, login_username = new_first_name, login_url =, server_ip =, API key = 123456

We send:

HTML POST: http://<SERVER_IP>/billing/api/email_send?u=username&email_name=registration_confirmation_for_user&email_to_user_id=142&login_username=new_first_name&

NOTE that username are not included in hash

We recive in email:

Your device settings: Server IP: Device type: Username: Password: ---- Settings to login to MOR interface: Login URL: Username: new_first_name Password: Thank you for registering!

[edit] Returns


<?xml version="1.0" encoding="UTF-8"?>
  <email_sending_status>Email sent</email_sending_status>


  • <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
  • <error>Bad login</error>
  • <error>Email not found</error> - Email not found by supplied name in param email_name under logged user account.
  • <error>User not found</error> - User not found by param email_to_user_id.
  • <error>Configuration error. Please consult this help link. (Net::SMTPFatalError - 554 5.7.1 ... </error> - SMTP error. Form more SMTP errors visit :
  • <email_sending_status>E-mail has been disabled</email_sending_status> - Turn on email sending in Settings.

[edit] See also

Personal tools


Try M2