RESTful API

Template Configuration

JSON file to configure the template, chasers and timeout.

Main Parameters

Parameter Name Description Valid Values
to_address User mobile number who will receive this messages String
channel_id Desired Channel to deliver the information Any of: sms, push, email, simmo or mms
from_address Source short/long code from where the message will be delivered Allows multiple short/long codes separated by comma (,)
randomly selected
scheduled_delivery_time Time to send the main alert A formatted date string: yyyy-MM-dd'T'HH:mm:ssZZ
For more information please review the pattern letters quick reference
post_message_body Holds the message information JSON Object
post_message_body.template_name Template Name to use
OPTIONAL if template_id is present 		String
post_message_body.template_id Template Id to use
OPTIONAL if template_name is present 		Number
post_message_body.ignoreoptout Forces the system to ignore if the user is currently OPT OUT Boolean
post_message_body.place_holders Holds all placeholders values JSON Object with KEY & VALUES pairs.
Ex: “key1”: “value1”, “key2”: “value2”, …

Chaser Parameters

You can set up chaser messages to be sended in the future if the user don't reply the first ones, remember that to cancel this future messages you need to call Delete Broadcast method.

Please note that you need to use this parameters grouped with proper numeration (X). The numeration start with 1 and must be increment by 1 for each additional chaser.

Parameter Name Description Valid Values
chaser_delivery_time.X Time to send the main alert A formatted date string: yyyy-MM-dd'T'HH:mm:ssZZ
For more information please review the pattern letters quick reference

Users using the workspace parameter chaser_delays_in_minutes can set this value to auto and the system will calculate automatically this delay for you by adding it to the initial scheduled_delivery_time
channel_id.X Desired Channel to deliver the information Any of: sms, push, email, simmo or mms
post_message_body.X Holds the message information JSON Object
post_message_body.X.template_name Template Name to use
OPTIONAL if template_id is present 		String
post_message_body.X.template_id Template Id to use
OPTIONAL if template_name is present 		Number
post_message_body.X.place_holders Holds all placeholders values JSON Object with KEY & VALUES pairs.
Ex: “key1”: “value1”, “key2”: “value2”, …

Timeout Parameters

The timeout parameter is optional and very useful if you need to trigger an additional event when a user didn't reply any of the messages already sended.

Parameter Name Description Valid Values
chaser_delivery_time.X Time to send the main alert A formatted date string: yyyy-MM-dd'T'HH:mm:ssZZ
For more information please review the pattern letters quick reference

Users using the workspace parameter chaser_delays_in_minutes can set this value to auto and the system will calculate automatically this delay for you by adding it to the initial scheduled_delivery_time
channel_id.X Desired Channel to deliver the information Any of: sms, push, email, simmo or mms
post_message_body.X Holds the message information JSON Object
post_message_body.X.text Text to send. String

JSON Sample

{
  "to_address": "13055468310",
  "channel_id": "sms",
  "from_address": "CODE1,CODE2,CODE3",
  "scheduled_delivery_time": "2016-09-01T10:03:05-04:00",
  "post_message_body": {
    "template_name": "Transaction Alert",
    "ignoreoptout": "true",
    "place_holders": {
      "amount" : "500",
      "id" : "4122",
      "location" : "Location Name"
    }
  },
 
  "chaser_delivery_time.1": "2016-09-01T10:04:35-04:00",
  "channel_id.1": "sms",
  "post_message_body.1": {
    "template_name": "Chaser 1",
    "place_holders": {
      "amount" : "500",
      "id" : "4122"
    }
  },
 
  "chaser_delivery_time.2": "2016-09-01T10:06:00-04:00",
  "channel_id.2": "sms",
  "post_message_body.2": {
    "template_name": "Chaser 2",
    "place_holders": {
      "amount" : "500",
      "location" : "Location Name"
    }
  },
 
  "chaser_delivery_time.3": "2016-09-01T11:00:00-04:00",
  "channel_id.3": "simmo",
  "post_message_body.3": {
    "text": "TIMEOUT"
    }
  }
 
}