Cg huyphong: /* Sms_send */

2012-04-17T04:05:15Z

Sms_send

← Older revision		Revision as of 04:05, 17 April 2012
Line 11:		Line 11:
	'''Arguments'''		'''Arguments'''

	''userResourceId:'' array of ids of the users who are to receive the SMS		''userResourceId:'' array of resource ids of the users who are to receive the SMS

	''smsoutprovidername'': the name of the provider which will be used to send the SMS. Look for the ones available in your lists of SMS providers and copy the exact name from there.		''smsoutprovidername'': the name of the provider which will be used to send the SMS. Look for the ones available in your lists of SMS providers and copy the exact name from there.

Nguyentanphong at 08:19, 1 February 2012

2012-02-01T08:19:30Z

Show changes

Cg_pham at 08:08, 12 December 2011

2011-12-12T08:08:05Z

← Older revision		Revision as of 08:08, 12 December 2011
Line 1:		Line 1:
	[[Category:Email_and_SMS_Functions]]		[[Category:Email_and_SMS_Functions]]
			{{HelpFiles}}

	====Sms_send====		====Sms_send====

Cg_pham at 04:40, 22 March 2011

2011-03-22T04:40:03Z

← Older revision		Revision as of 04:40, 22 March 2011
Line 1:		Line 1:
	[[Category:~~HelpBooks~~]]		[[Category:Email_and_SMS_Functions]]

Catglobe: jrfconvert import

2011-03-07T08:48:23Z

jrfconvert import

New page

[[Category:HelpBooks]]

====Sms_send====

This function makes it possible to send SMS messages to users.

'''Syntax'''

Sms_send(''userResourceIds, smsoutprovidername, message, [fromresourceid]'')

'''Arguments'''

''userResourceId:'' array of ids of the users who are to receive the SMS

''smsoutprovidername'': the name of the provider which will be used to send the SMS. Look for the ones available in your lists of SMS providers and copy the exact name from there.

''message'': the text that you want to send to the users. Should be a string of max 160 characters or it may get truncated.

''fromresourceid'': (optional) used to determine the source resource, which is again used to determine which keywords to use in the mail template, and also determines which SENT box the message ends up in. Default is current user.

'''Return type'''

An array of status codes will be returned as result of the function. There will exist one status for each user to which an SMS was sent. The status codes are:

{| class="tableintopic" style="border-collapse: collapse; border: 1px solid #010101" width="907" border="1" cellpadding="2"
|- align="left" valign="top"
| style="border: 1px solid #010101" width="48" bgcolor="#FACEAA" |
Code
| style="border: 1px solid #010101" width="288" bgcolor="#FACEAA" |
Constant name
| style="border: 1px solid #010101" width="571" bgcolor="#FACEAA" |
Description
|- align="left" valign="top"
| style="border: 1px solid #010101" width="48" |
0
| style="border: 1px solid #010101" width="288" |
SMS_STATUS_SUCCESSFUL
| style="border: 1px solid #010101" width="571" |
Sent successfully
|- align="left" valign="top"
| style="border: 1px solid #010101" width="48" |
1
| style="border: 1px solid #010101" width="288" |
SMS_STATUS_NO_VALID_PHONE_NUMBER
| style="border: 1px solid #010101" width="571" |
No valid phone number is found to receive the message or user does not have at least 1 phone number
|- align="left" valign="top"
| style="border: 1px solid #010101" width="48" |
2
| style="border: 1px solid #010101" width="288" |
SMS_STATUS_MESSAGE_TOO_LONG
| style="border: 1px solid #010101" width="571" |
The message length exceeds 160 characters
|- align="left" valign="top"
| style="border: 1px solid #010101" width="48" |
3
| style="border: 1px solid #010101" width="288" |
SMS_STATUS_NOT_USER_RESOURCE
| style="border: 1px solid #010101" width="571" |
The type of given resource is not type of user
|- align="left" valign="top"
| style="border: 1px solid #010101" width="48" |
4
| style="border: 1px solid #010101" width="288" |
SMS_STATUS_USER_DOES_NOT_EXIST
| style="border: 1px solid #010101" width="571" |
The given user does not exist
|- align="left" valign="top"
| style="border: 1px solid #010101" width="48" |
5
| style="border: 1px solid #010101" width="288" |
SMS_STATUS_USER_DELETED
| style="border: 1px solid #010101" width="571" |
This user has been deleted
|- align="left" valign="top"
| style="border: 1px solid #010101" width="48" |
6
| style="border: 1px solid #010101" width="288" |
SMS_STATUS_USER_DISABLED
| style="border: 1px solid #010101" width="571" |
This user has been disabled
|- align="left" valign="top"
| style="border: 1px solid #010101" width="48" |
7
| style="border: 1px solid #010101" width="288" |
SMS_STATUS_MISSING_RESOURCE_ACCESS
| style="border: 1px solid #010101" width="571" |
Current user does not have at least observer access to given user

'''Examples'''

array users = {1234567,1234568,1234569};

string smsprovidername = "TeleCo";

string msg = "The project has been completed";

Sms_send(users,smsprovidername,msg);

'''Availability'''

Version 5.8.1
__NOTOC__

Sms send - Revision history

Cg huyphong: /* Sms_send */

Nguyentanphong at 08:19, 1 February 2012

Cg_pham at 08:08, 12 December 2011

Cg_pham at 04:40, 22 March 2011

Catglobe: jrfconvert import