BulkSms new
BulkSms_new
Create new bulk SMS object
Syntax
BulkSms_new(bulkSmsName, parentResourceId, mailTemplateResourceId, smsOutProviderName)
Arguments
- bulkSmsName: (string) Name of the new bulk SMS
- parentResourceId: (number) Parent resource id of the new bulk SMS
- mailTemplateResourceId: (number) Mail template resource Id. The mail template that is to be used for the bulk Sms.
- smsOutProviderName: (string) Case sensitive name of the outgoing SMS provider that should be used to send the SMS. Please look in your system SMS provider list to find the correct provider to use.
Return value
Bulk SMS object returned in an array:
|
Index |
Data type |
Value |
|
BULKSMS_RESOURCE_ID |
number |
0 |
|
BULKSMS_NAME |
string |
Entered value |
|
BULKSMS_PARENT_RESOURCE_ID |
number |
Entered value |
|
BULKSMS_MAIL_TEMPLATE_RESOURCE_ID |
number |
Entered value |
|
BULKSMS_OUT_PROVIDER_NAME |
string |
It should be an existing SMS provider by exact name from the SMS provider list. |
|
BULKSMS_USER_RESOURCE_IDS |
array |
{} |
|
BULKSMS_GROUP_RESOURCE_IDS |
array |
{} |
|
BULKSMS_GROUP_TO_BE_REBUILD_RESOURCE_IDS |
array |
{} |
|
BULKSMS_NO_IN_OUT_QUEUE |
Number (read only) |
Default is 0 |
|
BULKSMS_NO_OF_SENT |
Number (read only) |
Default is 0 |
|
BULKSMS_TEMPLATE_RESOURCE_ID |
Number |
|
|
BULKSMS_DEPENDANT_BULKMAIL |
Number |
|
|
BULKSMS_SELECTED_HISTORY |
array |
|
|
BULKSMS_SELECTED_RECIPIENTS |
Example
string bulkSmsName = "TestBulkSMS";
number parentResourceId = 34778803;
number mailTemplateResourceId = 501537;
string smsOutProviderName= "TeleCo"
array newBS = BulkSms_new(bulkSmsName, parentResourceId, mailTemplateResourceId, smsOutProviderName);
print(newBS); //{35,0,TestBulkSMS,34778803,501537,TeleCo,{},{},{},0,0}
Availability
Version 5.8.1
