BatchMessage.md

OpenapiClient::BatchMessage

Properties

Name	Type	Description	Notes
sender	String	The sender of the message. Should be no longer than 11 characters for alphanumeric or 15 characters for numeric sender ID's. No spaces or special characters.
destinations	Array<String>	Telephone numbers of each of the recipients
content	String	Message to send to the recipient
deliveryreporturl	String	The url to which we should POST delivery reports to for this message. If none is specified, we'll use the global delivery report URL that you've configured on your account page.	[optional]
schedule	String	Date-time at which to send the batch. This is only used by the batch/schedule service.	[optional]
tag	String	An identifying label for the message, which you can use to filter and report on messages you've sent later. Ideal for campaigns. A maximum of 280 characters.	[optional]
ttl	Float	The number of minutes before the delivery report is deleted. Optional. Omit to prevent delivery report deletion. Integer.	[optional]
validity	Float	The optional number of minutes to attempt delivery before the message is marked as EXPIRED. Optional. The default is 2880 minutes. Integer.	[optional]
ai	Boolean	Used to determine whether The SMS Works AI Optimiser should be used in the event that the message is just longer than the 1 or 2 credit boundary. This setting overrides the AI Optimiser configuration on your SMS Works account.	[optional]

Example

require 'openapi_client'

instance = OpenapiClient::BatchMessage.new(
  sender: YourCompany,
  destinations: ["447777777777","447777777778","447777777779"],
  content: My super awesome batch message,
  deliveryreporturl: http://your.domain.com/delivery/report/path,
  schedule: Wed Jul 19 2017 20:26:28 GMT+0100 (BST),
  tag: SummerSpecial,
  ttl: 10,
  validity: 1440,
  ai: null
)