ClickSend - Send an SMS to a list

Use the ClickSend - Send an SMS to a list action A tool for building the processes, logic, and direction within workflows. to send an SMS message to a ClickSend list.

For more information about ClickSend, go to ClickSend.

Before you begin: 

Jump to:

Configure the ClickSend - Send an SMS to a list action

  1. Add the action to the workflow and open the action configuration panel. For more information, see Add an action to the workflow.

  1. Select a Connection. If you do not have a connection, see Add a connection.
  2. In Messages, click Add item.
  3. Specify the To list contact list ID.
  4. Specify the From sender ID.
  5. Specify the Message content.
  6. Configure the details of the SMS, such as country, source, your reference, schedule time, and a custom reply-to email address.
  7. If you want to add more SMSs messages to send, click Add item again and configure the message.
  8. Create or select a variable for the output.

For more information on all the required and optional configuration fields, go to ClickSend - Send an SMS to a list action fields and settings.

ClickSend - Send an SMS to a list action fields and settings

Section

Field

Description

Variable types

(Unlabeled)

Connection Credentials and other settings required to pass data between the workflow and the indicated service, which could be a cloud service, business application, or content store.

The ClickSend connection to use to send the SMS message.

To refresh the available connections, click .

(n/a)
Messages Message Click Add item to create a new SMS message to send. (n/a)
  To list

Your contact list ID.

You can use the output object of a ClickSend - Get contact lists action to retrieve the List ID.

You can post to a list with up to 20000 recipients with each action. The response is far less detailed than the normal ClickSend - Send an SMS action.

Text, Decimal, Integer, Boolean, DateTime, Collection
  From Your sender ID. This is the number that shows on the recipient's phone when they receive the message. Text, Decimal, Integer, Boolean, DateTime, Collection
  Message

The text of your message.

A standard SMS message has a maximum of 160 characters. Longer messages are definitely possible, however exceeding 160 characters creates a ‘second’ message. The end user will see this as one long message on their handset. When a message is longer than 160 characters, this is referred to as a multi-part message as it contains multiple messages (or multiple-parts). The total SMS limit then becomes 153 characters per ‘part’ as the 7 characters are used up by invisible headers and footers which denote which part of the message is being sent. If a message contains any characters that aren't in the GSM 03.38 character set, the message type will be treated as Unicode. See How many characters can I send in a message for more information.

You are required to add an opt-out message to the end of your message body if you are sending a marketing message. This can be in the form of asking users to reply STOP to opt-out or by including StopMsg.me/xxxxx which is a placeholder that will add a link that can be clicked to out-out.

 Text, Decimal, Integer, Boolean, DateTime, Collection
  Source Your method of sending the message, for example; 'nintex', 'wordpress', 'php', 'c#'. Text, Decimal, Integer, Boolean, DateTime, Collection
  Your reference A description of the SMS message for your future reference. Text, Decimal, Integer, Boolean, DateTime, Collection
  Schedule

Leave this field blank for immediate delivery. Your scheduled time in Unix time format.

Unix time (also known as Epoch time, Posix time, seconds since the Epoch, or UNIX Epoch time) is a system for describing a point in time. It is the number of seconds that have elapsed since the Unix epoch, minus leap seconds; the Unix epoch is 00:00:00 UTC on 1 January 1970 (an arbitrary date); leap seconds are ignored, with a leap second having the same Unix time as the second before it, and every day is treated as if it contains exactly 86400 seconds. Unix time is widely used in operating systems and file formats.

The following steps present an example of how to get Unix time from a date in a form input:

  1. In a form, create aDate/time picker control called Target Date.

  2. Add a variable that calculates the TotalSeconds between 1970/1/1 00:00:00 and your target date:

    • dateDiff("TotalSecond", date(1970,1,1,0,0,0), Form.Target Date)
      Unix time

  3. Test the form to make sure that the control is working. For example, selecting 12pm on the 9th of June 2021 should result in a Unix time of 1623240000.

 Text, Decimal, Integer, Boolean, DateTime, Collection
  Country The ISO alpha-2 character country code e.g. 'US', This used to format the recipient number if it's not in international format. Text, Decimal, Integer, Boolean, DateTime, Collection
  Custom reply-to email address An email address where the reply should be emailed to. If omitted, the reply will be emailed back to the user who sent the outgoing SMS. Text, Decimal, Integer, Boolean, DateTime, Collection
Output Sent message details

Stores the result of the action as an object. See ClickSend API for more details. The following values are returned:

  • HTTP response code: (Integer)
  • Response Code: (Text)
  • Response message: (Text)
  • Data: (Object)
    • Queued count: (Integer)
    • Total price: (Decimal)
    • Total count: (Integer)
    • Messages: (Collection)
      • Body: (Text)
      • Carrier: (Text)
      • Country: (Text)
      • Your reference: (Text)
      • Date: (Integer)
      • Direction: (Text)
      • From: (Text)
      • Message ID: (Text)
      • Message parts: (Integer)
      • Message price: (Decimal)
      • Schedule: (Decimal)
      • Status: (Text)
      • Sub account ID: (Integer)
      • To: (Text)
      • User ID: (Integer)
    • Currency: (Object)
      • Currency: (Text)
      • Currency name: (Text)
      • Currency prefix c: (Text)
      • Currency prefix d: (Text)
 Object