Broadcast APIs

Overview

A Broadcast entity is a message that has been scheduled and/or delivered to subscribers within the Mobile Database. There are three main sections to a Broadcast, the Meta data information, the Targeting information and the Delivery information. The Metadata information is all the fields about the broadcast, the ID, URL, created date, etc. The targeting information are the fields used to identify recipients and craft the message and the Delivery information is the metadata about the actual message delivery.

Broadcast Entity

This is the JSON representation of a Broadcast entity within the APIs.

{
"id": "328AFX343",
"status": "scheduled",
"url": "/api/companies/1/broadcasts/328AFX343",
"name": "Test Broadcast SAT 2",
"send_scheduled_date": "2013-11-06T07:30:00Z",

"targeting" : [
   "message_template": "Test Broadcast SAT 2 {{ list_name }} Reply HELP for help, STOP to cancel-Msg&data rates may apply",
   "shorten_urls": true,
   "source_lists": ["AB1234Z4","LIST12345"],
   "filters": [
      { "name" : "favorite_sport", "selector" : "any", "selections" : [ "football", "baseball" ] },
      { "name" : "first_name", "selector" : "starts_with", "value" : "Steve" },
      { "name" : "recipient_list", "selector" : "any", "selections" : [ "TEXT_FILE_20130101.txt" ] },
      { "name" : "country", "selector" : "is", "value" : "US" }
    ]
  ]
}

"delivery" : [
  "send_start_date": "2013-11-02T18:54:43Z",
  "enqueue_completed_date": "2013-11-02T18:54:43Z",
  "recipient_count": 50,
],

"created_at": "2013-11-02T18:58:53Z",
"updated_at": "2013-11-02T18:58:53Z"
}

Elements

Data Element	Type	Description

Filters and Types

Standard Filterable Fields

Standard Name	Data type
Recipient List	Multi-Select
Country	Single-Select
<custom_field>	The <custom_field> Value

Filter Selectors by Data Type

Data Type	Selector	Description
Multi-Select	none	None
	any	Any one of
	all	All specified
Single-Select	any	Any one of
	none	No value
String	starts_with	":value%"
	equals	":value"
	contains	"%:value%"