Difference between revisions of "BulkSms new"

From Catglobe Wiki
Jump to: navigation, search
Line 1: Line 1:
−
[[Category:Email_and_SMS_Functions]]
+
{{HelpFiles}}  
−
{{HelpFiles}}
 
  
−
====BulkSms_new====
+
==== BulkSms_new ====
  
−
Create new bulk SMS object
+
Create new bulk SMS object  
  
−
'''Syntax'''
+
'''Syntax'''  
  
−
BulkSms_new(''bulkSmsName, parentResourceId, mailTemplateResourceId, smsOutProviderName'')
+
BulkSms_new(''bulkSmsName, parentResourceId, mailTemplateResourceId, smsOutProviderName'')  
  
−
'''Arguments'''
+
'''Arguments'''  
  
−
* ''bulkSmsName'': (string) Name of the new bulk SMS
+
*''bulkSmsName'': (string) Name of the new bulk SMS  
−
* ''parentResourceId'': (number) Parent resource id 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.
+
*''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.
+
*''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'''
+
'''Return value'''  
  
−
Bulk SMS object returned in an array:
+
Bulk SMS object returned in an array:  
  
−
{| class="tableintopic" style="border-collapse: collapse; border: 1px solid #010101" width="1067" border="1" cellpadding="2"
+
{| width="1067" cellpadding="2" border="1" class="tableintopic" style="border-collapse: collapse; border: 1px solid #010101"
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="356" bgcolor="#C0C0C0" |
+
| width="356" bgcolor="#C0C0C0" style="border: 1px solid #010101" |  
−
'''Index'''
+
'''Index'''  
−
| style="border: 1px solid #010101" width="356" bgcolor="#C0C0C0" |
+
 
−
'''Data type'''
+
| width="356" bgcolor="#C0C0C0" style="border: 1px solid #010101" |  
−
| style="border: 1px solid #010101" width="356" bgcolor="#C0C0C0" |
+
'''Data type'''  
−
'''Value'''
+
 
 +
| width="356" bgcolor="#C0C0C0" style="border: 1px solid #010101" |  
 +
'''Value'''  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="356" |
+
| width="356" style="border: 1px solid #010101" |
−
BULKSMS_RESOURCE_ID
+
BULKSMS_RESOURCE_ID
−
| style="border: 1px solid #010101" width="356" |
+
 
−
number
+
| width="356" style="border: 1px solid #010101" |
−
| style="border: 1px solid #010101" width="356" |
+
number
−
0
+
 
 +
| width="356" style="border: 1px solid #010101" |  
 +
0  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="356" |
+
| width="356" style="border: 1px solid #010101" |
−
BULKSMS_NAME
+
BULKSMS_NAME
−
| style="border: 1px solid #010101" width="356" |
+
 
−
string
+
| width="356" style="border: 1px solid #010101" |
−
| style="border: 1px solid #010101" width="356" |
+
string
−
Entered value
+
 
 +
| width="356" style="border: 1px solid #010101" |  
 +
Entered value  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="356" |
+
| width="356" style="border: 1px solid #010101" |
−
BULKSMS_PARENT_RESOURCE_ID
+
BULKSMS_PARENT_RESOURCE_ID
−
| style="border: 1px solid #010101" width="356" |
+
 
−
number
+
| width="356" style="border: 1px solid #010101" |
−
| style="border: 1px solid #010101" width="356" |
+
number
−
Entered value
+
 
 +
| width="356" style="border: 1px solid #010101" |  
 +
Entered value  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="356" |
+
| width="356" style="border: 1px solid #010101" |
−
BULKSMS_MAIL_TEMPLATE_RESOURCE_ID
+
BULKSMS_MAIL_TEMPLATE_RESOURCE_ID
−
| style="border: 1px solid #010101" width="356" |
+
 
−
number
+
| width="356" style="border: 1px solid #010101" |
−
| style="border: 1px solid #010101" width="356" |
+
number
−
Entered value
+
 
 +
| width="356" style="border: 1px solid #010101" |  
 +
Entered value  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="356" |
+
| width="356" style="border: 1px solid #010101" |
−
BULKSMS_OUT_PROVIDER_NAME
+
BULKSMS_OUT_PROVIDER_NAME
−
| style="border: 1px solid #010101" width="356" |
+
 
−
string
+
| width="356" style="border: 1px solid #010101" |
−
| style="border: 1px solid #010101" width="356" |
+
string
−
It should be an existing SMS provider by exact name from the SMS provider list.
+
 
 +
| width="356" style="border: 1px solid #010101" |  
 +
It should be an existing SMS provider by exact name from the SMS provider list.  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="356" |
+
| width="356" style="border: 1px solid #010101" |
−
BULKSMS_USER_RESOURCE_IDS
+
BULKSMS_USER_RESOURCE_IDS
−
| style="border: 1px solid #010101" width="356" |
+
 
−
array
+
| width="356" style="border: 1px solid #010101" |
−
| style="border: 1px solid #010101" width="356" |
+
array
−
{}
+
 
 +
| width="356" style="border: 1px solid #010101" |  
 +
{}  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="356" |
+
| width="356" style="border: 1px solid #010101" |
−
BULKSMS_GROUP_RESOURCE_IDS
+
BULKSMS_GROUP_RESOURCE_IDS
−
| style="border: 1px solid #010101" width="356" |
+
 
−
array
+
| width="356" style="border: 1px solid #010101" |
−
| style="border: 1px solid #010101" width="356" |
+
array
−
{}
+
 
 +
| width="356" style="border: 1px solid #010101" |  
 +
{}  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="356" |
+
| width="356" style="border: 1px solid #010101" |
−
BULKSMS_GROUP_TO_BE_REBUILD_RESOURCE_IDS
+
BULKSMS_GROUP_TO_BE_REBUILD_RESOURCE_IDS
−
| style="border: 1px solid #010101" width="356" |
+
 
−
array
+
| width="356" style="border: 1px solid #010101" |
−
| style="border: 1px solid #010101" width="356" |
+
array
−
{}
+
 
 +
| width="356" style="border: 1px solid #010101" |  
 +
{}  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="356" |
+
| width="356" style="border: 1px solid #010101" |
−
BULKSMS_NO_IN_OUT_QUEUE
+
BULKSMS_NO_IN_OUT_QUEUE
−
| style="border: 1px solid #010101" width="356" |
+
 
−
Number (read only)
+
| width="356" style="border: 1px solid #010101" |  
−
| style="border: 1px solid #010101" width="356" |
+
Number (read only)  
−
Default is 0
+
 
 +
| width="356" style="border: 1px solid #010101" |  
 +
Default is 0  
 +
 
 
|- align="left" valign="top"
 
|- align="left" valign="top"
−
| style="border: 1px solid #010101" width="356" |
+
| width="356" style="border: 1px solid #010101" |  
−
BULKSMS_NO_OF_SENT
+
BULKSMS_NO_OF_SENT
−
| style="border: 1px solid #010101" width="356" |
 
−
Number (read only)
 
−
| style="border: 1px solid #010101" width="356" |
 
−
Default is 0
 
  
−
'''Example'''
+
| width="356" style="border: 1px solid #010101" |
 +
Number (read only)
  
−
string bulkSmsName = "TestBulkSMS";
+
| width="356" style="border: 1px solid #010101" |
 +
Default is 0 <!-- imported from file: 8089.htm-->
  
−
number parentResourceId = 34778803;
+
|}
  
−
number mailTemplateResourceId = 501537;
+
<br>
  
−
string smsOutProviderName= "TeleCo"
+
'''Example'''
  
−
array newBS = BulkSms_new(bulkSmsName, parentResourceId, mailTemplateResourceId, smsOutProviderName);
+
string bulkSmsName = "TestBulkSMS";  
  
−
print(newBS); //{35,0,TestBulkSMS,34778803,501537,TeleCo,{},{},{},0,0}
+
number parentResourceId = 34778803;  
  
−
'''Availability'''
+
number mailTemplateResourceId = 501537;
  
−
Version 5.8.1
+
string smsOutProviderName= "TeleCo"
−
__NOTOC__
+
 
−
<!-- imported from file: 8089.htm-->
+
array newBS = BulkSms_new(bulkSmsName, parentResourceId, mailTemplateResourceId, smsOutProviderName);
 +
 
 +
print(newBS); //{35,0,TestBulkSMS,34778803,501537,TeleCo,{},{},{},0,0}
 +
 
 +
'''Availability'''
 +
 
 +
Version 5.8.1 __NOTOC__ <br>
 +
 
 +
[[Category:Email_and_SMS_Functions]]

Revision as of 10:12, 1 February 2012



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


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

Retrieved from "http://wiki.catglobe.com/index.php?title=BulkSms_new&oldid=23757"