Difference between revisions of "MOR API email send"
From Kolmisoft Wiki
Jump to navigationJump to search
m |
|||
| Line 12: | Line 12: | ||
** u - username to login. '''Required'''. | ** u - username to login. '''Required'''. | ||
** p - password to login. '''Required'''. | ** p - password to login. '''Required'''. | ||
** email_to_user_id - User ID | ** email_to_user_id - User ID which will receive email. If parameter is not supplied email is sent to authorizated user. | ||
** email | ** email template params. http://wiki.kolmisoft.com/index.php/Email_variables | ||
** [[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 24: | Line 24: | ||
*** <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string. | *** <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>Bad login</error> | ||
*** <error>Email not found</error> - Email not found by | *** <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>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 | *** <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 | ||
Revision as of 07:59, 20 July 2012
Send Email
- Call: /api/send_email
- Params:
- email_name - Email template name. Required.
- u - username to login. Required.
- p - password to login. Required.
- email_to_user_id - User ID which will receive email. If parameter is not supplied email is sent to authorizated user.
- email template params. http://wiki.kolmisoft.com/index.php/Email_variables
- hash - SHA1 hash constructed using API_Secret_Key ( More described in Constructing hash). Required.
- 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 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 : 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.
- Errors:
- 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!
- We recive in email:
