PostMessageToList
Initiates a message to one or more contact lists.
EXECUTE PostMessageToList MessageId = 'NCNSDNsd222as85dj92j2sM', TargetListIds = ' [" + " \"bzZ0cENGam1FZUtNX0poTDRYZzhlQTo2Mzow\"" + " ]', OverrideTemplateTargetLists = true, OverrideTemplateExclusionLists = false, IgnoreExclusionLists = true, OverrideMessageText = false, " + "ContentURL = 'http://image.exct.net/lib/fe6d15707662057c7411/m/1/dj_CC_AUS.jpg'," + "UtcOffset = '-0500', WindowStart = '1500', WindowEnd = '2200', AllowDuplication = false
Input
Name | Type | Required | Description |
MessageId | String | True | The encodedID can be found when creating a 'API Entry Event' type Outbound message in the UI. If you have already passed that point you can find the ID by looking at the API resource behind the scenes when you open that message in the UI. |
TargetListIds | String | False | A list of one or more List ID strings. The contacts in these Lists will be included in the send and will overwrite the Message's default inclusion lists. |
OverrideTemplateTargetLists | Boolean | False | A flag indicating TargetListIds will be provided for overriding the message default Target List Ids. |
ExclusionListIds | String | False | A list of one or more List ID strings. The contacts in these Lists will be excluded in the send and will overwrite the Message's default exclusion lists. |
OverrideTemplateExclusionLists | Boolean | False | A flag indicating ExclusionListIds will be provided for overriding the message default Exclusion List Ids. |
IgnoreExclusionLists | Boolean | False | A flag indicating that exclusion lists (even the default message exclusion lists) will not be used in the send. |
OverrideMessageText | Boolean | False | A flag indicating that the text provided should override the text stored with the Message. |
MessageText | String | False | Required when OverrideMessageText is true. |
UtcOffset | String | False | The UTC offset of the blackout window start and end times. UtcOffset is required in every REST call in order for the blackout window to be honored. |
WindowStart | String | False | The start time of the blackout window, in the UTC offset specified. To see if the SendTime is within the blackout window, convert the WindowStart and WindowEnd times to UTC and compare them to the SendTime. |
WindowEnd | String | False | The end time of the blackout window, in the UTC offset specified. To see if the SendTime is within the blackout window, convert the WindowStart and WindowEnd times to UTC and compare them to the SendTime. |
SendTime | Datetime | False | Date and Time in UTC that the message will go out. Example format: 2012-10-17 17:01. The BlackoutWindow will still be respected if used with this option. If the SendTime is set to a date and time in the past, the message will send immediately. |
AllowDuplication | Boolean | False | The same mobile number may receive multiple texts if this value is true. |
ContentURL | String | False | The URL of the media content sent via an MMS message. |
Result Set Columns
Name | Type | Description |
TokenId | String | A token that can be used to make a follow-up call to check the status of the request. |