SendSmartMessage
Send message using Smart parameters
Task version: 1.2.0
Required Frends version: 5.5+
Required .NET version: 6.0
Compatible Agents: Crossplatform
Task Parameters
CustomerId : Guid
Your CustomerId
Default: -
Example: -
ServiceId : Guid
ServiceId for service to use to send the message
Default: -
Example: -
Sender : String
Sender address or name
Default: -
Example: +358101001234
Content : String
Message content. May contain variable placeholders like $(variable), which can be used by
Default: -
Example: Hello world
Recipients : Recipient[]
Message recipient phone numbers, preferably in E.164 format
Default: -
Example: -
🗝PersonalAccessToken : String
PAT (Personal Access Token) for sending messages
Default: -
Example: -
DlrUrl : String
Optional, URL for Delivery reports
Default: -
Example: -
CustomerData : String
Optional, data to attach to the message event, used in reporting.
Default: -
Example: -
SendDateTime : Nullable<DateTime>
Optional, for scheduled messages
Default: -
Example: 04/22/2025 10:45:23
AllowedSendTimeStart : String
Optional, for limiting time of day (UTC) when messages are allowed to be sent (start of range)
Default: -
Example: 08:00:00
AllowedSendTimeEnd : String
Optional, for limiting time of day (UTC) when messages are allowed to be sent (end of range)
Default: -
Example: 16:00:00
AllowedSendDays : DayOfWeek[]
Optional, for limiting day(s) of week when messages are allowed to be sent
Default: -
Example: -
RequestId : String
Optional, to detect duplicate requests. If not set, a value will be generated.
Default: -
Example: -
UnicodeCharacterHandlingPolicy : UnicodeCharacterHandlingPolicy
Optional, for controlling Unicode character handling
Possible values:
None: Optional, for controlling Unicode character handlingStrict: Optional, for controlling Unicode character handlingReplace: Optional, for controlling Unicode character handling
Default: 0
Example: -
ThrowErrorOnFailure : Boolean
Throw exception if return value of request is not successful.
Default: true
Example: -
ErrorMessageOnFailure : String
Error message in case of thrown exception or task failure
Default: -
Example: -
Task Result
Success : Boolean
True if message was queued successfully
Id : String
Smart send ID
RecipientCount : Nullable<Int32>
Total recipient count
MessagePartCount : Nullable<Int32>
Total message part count
SendDateTimeEstimate : Nullable<DateTime>
Rough estimate for when message has been sent to all recipients
Warnings : String[]
Warnings related to recipient-specific customizations
Error : Error
Error, in case sending was unsuccessful.
Task Changelog
Changelog for Task ArenaInteractive.SmartDialog.SendSmartMessage.
[1.0.0] - 2025-04-22
Changed
Initial implementation (Smart Send Message, SMS protocol)
[1.1.0] - 2025-08-18
Changed
Naming changes for solution, project and task to match guidelines
[1.2.0] - 2025-09-02
Changed
Changed
InputandOutputdefinitions fromrecordtoclass, updated unit test data to reflect this
Last updated
Was this helpful?