/batch/schedule

Schedules a batch of SMS messages to be sent at the date time you specify

curl --location --request POST 'https://api.thesmsworks.co.uk/v1/batch/schedule' \ --header 'Content-Type: application/json' \ --data-raw '{ "content": "My super awesome batch message", "deliveryreporturl": "http://your.domain.com/delivery/report/path", "destinations": [ "447777777777", "447777777778", "447777777779" ], "schedule": "Wed Jul 19 2017 20:26:28 GMT+0100 (BST)", "sender": "YourCompany", "tag": "SummerSpecial", "ttl": 10 }'

Request

Body Params application/json

SMS Message Batch

content

string

required

Message to send to the recipient

Example:

My super awesome batch message

deliveryreporturl

string

optional

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.

Example:

http://your.domain.com/delivery/report/path

destinations

array[string]

required

Telephone numbers of each of the recipients

Example:

["447777777777","447777777778","447777777779"]

schedule

string

optional

Date-time at which to send the batch. This is only used by the batch/schedule service.

Example:

Wed Jul 19 2017 20:26:28 GMT+0100 (BST)

sender

string

required

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.

Example:

YourCompany

tag

string

optional

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.

Example:

SummerSpecial

ttl

number

optional

The number of minutes before the message is deleted. Optional. Omit to prevent delivery report deletion. Integer.

Example:

Examples

application/json

Body

message

string

required

errorCode

number

required

Numeric code used to identify the error. Integer.

permanent

boolean

optional

status

string

required

Request

Responses