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.

Contents 

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", "value" : [ "football", "baseball" ] },
      { "name" : "first_name", "selector" : "starts_with", "value" : "Steve" },
      { "name" : "recipient_list", "selector" : "any", "value" : [ "TEXT_FILE_20130101.txt" ] },
      { "name" : "country", "selector" : "equals", "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

Available Filter Selectors

in progress : brainstorming

Filter Type

Equals

Starts With

Ends With

Contains

In

On

Before

After

Between

Country

x

x

x

x

x

 

 

 

 

Recipient List

x

 

 

x

x

 

 

 

 

MultiSelect

x

x

x

x

x

 

 

 

 

Select

x

x

x

x

x

 

 

 

 

String

x

x

x

x

x

 

 

 

 

Date

x

x

x

x

x

x

x

x

x

Filter Selector Matrix

in progress : brainstorming

equals, starts_with, ends_with, contains, on, before, after, between
is, not, any, all, none

Selector

Alternatives?

Country

Recipient List

MultiSelect

Select

String

Date

any

equals, is, equals_any, is_any

x

x

x

x

x

x

all

equals_all, is_all

 

x

x

 

 

 

none

equals_none, is_none, is_not

x

x

x

x

x

x

starts_with

starts_with_any, begins_with, begins_with_any

x

 

x

x

x

x

starts_with_none

begins_with_none

x

 

x

x

x

x

ends_with

ends_with_any

x

 

x

x

x

x

ends_with_none

 

x

 

x

x

x

x

contains

contains_any

x

x

x

x

x

x

contains_all

 

 

x

x

 

 

contains_none

 

x

x

x

x

x

x

on

is_on

 

 

 

 

 

x

before

is_before

 

 

 

 

 

x

after

is_after

 

 

 

 

 

x

not_on

is_not_on

 

 

 

 

 

x

not_before

is_not_before

 

 

 

 

 

x

not_after

is_not_after

 

 

 

 

 

x

between

is_between

 

 

 

 

 

x

not_between

is_not_between

 

 

 

 

 

x

on_or_before

is_on_or_before

 

 

 

 

 

x

on_or_after

is_on_or_after

 

 

 

 

 

x