Difference between revisions of "BulkSms new"
Line 1: | Line 1: | ||
− | + | {{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" border="1" cellpadding="2" width="1067" |
|- align="left" valign="top" | |- align="left" valign="top" | ||
− | | | + | | style="border: 1px solid #010101" bgcolor="#C0C0C0" width="356" | |
− | '''Index''' | + | '''Index''' |
− | | | + | | style="border: 1px solid #010101" bgcolor="#C0C0C0" width="356" | |
− | '''Data type''' | + | '''Data type''' |
− | | | + | | style="border: 1px solid #010101" bgcolor="#C0C0C0" width="356" | |
− | '''Value''' | + | '''Value''' |
|- align="left" valign="top" | |- align="left" valign="top" | ||
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | BULKSMS_RESOURCE_ID | + | BULKSMS_RESOURCE_ID |
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | number | + | number |
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | 0 | + | 0 |
|- align="left" valign="top" | |- align="left" valign="top" | ||
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | BULKSMS_NAME | + | BULKSMS_NAME |
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | string | + | string |
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | Entered value | + | Entered value |
|- align="left" valign="top" | |- align="left" valign="top" | ||
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | BULKSMS_PARENT_RESOURCE_ID | + | BULKSMS_PARENT_RESOURCE_ID |
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | number | + | number |
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | Entered value | + | Entered value |
|- align="left" valign="top" | |- align="left" valign="top" | ||
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | BULKSMS_MAIL_TEMPLATE_RESOURCE_ID | + | BULKSMS_MAIL_TEMPLATE_RESOURCE_ID |
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | number | + | number |
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | Entered value | + | Entered value |
|- align="left" valign="top" | |- align="left" valign="top" | ||
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | BULKSMS_OUT_PROVIDER_NAME | + | BULKSMS_OUT_PROVIDER_NAME |
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | string | + | string |
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | It should be an existing SMS provider by exact name from the SMS provider list. | + | 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" | |
− | BULKSMS_USER_RESOURCE_IDS | + | BULKSMS_USER_RESOURCE_IDS |
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | array | + | array |
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | {} | + | {} |
|- align="left" valign="top" | |- align="left" valign="top" | ||
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | BULKSMS_GROUP_RESOURCE_IDS | + | BULKSMS_GROUP_RESOURCE_IDS |
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | array | + | array |
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | {} | + | {} |
|- align="left" valign="top" | |- align="left" valign="top" | ||
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | BULKSMS_GROUP_TO_BE_REBUILD_RESOURCE_IDS | + | BULKSMS_GROUP_TO_BE_REBUILD_RESOURCE_IDS |
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | array | + | array |
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | {} | + | {} |
|- align="left" valign="top" | |- align="left" valign="top" | ||
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | BULKSMS_NO_IN_OUT_QUEUE | + | BULKSMS_NO_IN_OUT_QUEUE |
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | Number (read only) | + | Number (read only) |
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | Default is 0 | + | Default is 0 |
|- align="left" valign="top" | |- align="left" valign="top" | ||
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | BULKSMS_NO_OF_SENT | + | BULKSMS_NO_OF_SENT |
− | | | + | | style="border: 1px solid #010101" width="356" | |
− | Number (read only) | + | Number (read only) |
− | | width="356" style="border: 1px solid #010101" | | + | | style="border: 1px solid #010101" width="356" | |
− | + | Default is 0 | |
+ | |- align="left" valign="top" | ||
+ | | style="border: 1px solid #010101" width="356" | | ||
+ | BULKSMS_DEPENDANT_BULKMAIL | ||
+ | |||
+ | | style="border: 1px solid #010101" width="356" | | ||
+ | Number | ||
+ | |||
+ | | style="border: 1px solid #010101" width="356" | | ||
+ | |||
+ | |- align="left" valign="top" | ||
+ | | style="border: 1px solid #010101" width="356" | | ||
+ | BULKSMS_SELECTED_HISTORY | ||
+ | |||
+ | | style="border: 1px solid #010101" width="356" | | ||
+ | array(read only) | ||
+ | |||
+ | | style="border: 1px solid #010101" width="356" | | ||
+ | {} | ||
+ | |||
+ | <!-- imported from file: 8089.htm--> | ||
|} | |} | ||
− | |||
− | |||
− | + | '''Example''' | |
− | + | string bulkSmsName = "TestBulkSMS"; | |
− | number | + | 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 __NOTOC__ |
Revision as of 09:00, 14 July 2016
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_DEPENDANT_BULKMAIL |
Number |
|
BULKSMS_SELECTED_HISTORY |
array(read only) |
{}
|
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