Difference between revisions of "MOR API email send"

From Kolmisoft Wiki
Jump to navigationJump to search
(Created page with 'MOR API Send Email <br><br> ---- <br><br> * Call: /api/send_email * Params: ** email_name - Email template name. '''Required'''. ** u - username to login. '''Required'''. …')
 
Line 14: Line 14:
** email_to_user_id - User ID witch will receive email. If param not suplaed email send to authorizated user.
** email_to_user_id - User ID witch will receive email. If param not suplaed email send to authorizated user.
** email templaite params. http://wiki.kolmisoft.com/index.php/Email_variables  
** email templaite params. http://wiki.kolmisoft.com/index.php/Email_variables  
** message - Message that you want to send. '''Required'''.
** [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
** [[MOR API hash construction | hash]] - SHA1 hash constructed using '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.


Line 36: Line 35:
*** /api/send_email?u=admin&p=admin1&email_name=registration_confirmation_for_user&email_to_user_id=142&login_username=new_first_name&login_url=www.kolmisoft.com&server_ip=127.0.0.2&hash=565582398d663e87b5fe3a523f8937fb693bf1e1
*** /api/send_email?u=admin&p=admin1&email_name=registration_confirmation_for_user&email_to_user_id=142&login_username=new_first_name&login_url=www.kolmisoft.com&server_ip=127.0.0.2&hash=565582398d663e87b5fe3a523f8937fb693bf1e1
'''* Note that username and password are not included in hash'''
'''* Note that username and password are not included in hash'''
**We recive:
**We recive in email:
*** Your device settings: Server IP: 127.0.0.2 Device type: Username: Password: ---- Settings to login to MOR interface: Login URL: www.kolmisoft.com Username: new_first_name Password: Thank you for registering!
*** Your device settings: Server IP: 127.0.0.2 Device type: Username: Password: ---- Settings to login to MOR interface: Login URL: www.kolmisoft.com Username: new_first_name Password: Thank you for registering!

Revision as of 07:45, 20 July 2012

MOR API

Send Email






  • Returns:
    • Success

<email_sending_status>Email sent</email_sending_status>

    • Errors:
      • <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 suplaiet name in param email_name under loged 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 : http://wiki.kolmisoft.com/index.php/GUI_Error_-_Email_SMTP
      • <email_sending_status>E-mail has been disabled</email_sending_status> - Turn on email sending in Settings.



  • Example:
    • We have email_name = registration_confirmation_for_user, email_to_user_id = 142, login_username = new_first_name, login_url = www.kolmisoft.com, server_ip = 127.0.0.2, API key = 123456
    • We send:
      • /api/send_email?u=admin&p=admin1&email_name=registration_confirmation_for_user&email_to_user_id=142&login_username=new_first_name&login_url=www.kolmisoft.com&server_ip=127.0.0.2&hash=565582398d663e87b5fe3a523f8937fb693bf1e1

* Note that username and password are not included in hash

    • We recive in email:
      • Your device settings: Server IP: 127.0.0.2 Device type: Username: Password: ---- Settings to login to MOR interface: Login URL: www.kolmisoft.com Username: new_first_name Password: Thank you for registering!
Retrieved from "https://wiki.kolmisoft.com/index.php?title=MOR_API_email_send&oldid=13643"