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",
"created_by": "user@company.com",

"send_scheduled_date": "2013-11-06T17:30:00Z",
"send_schedule": {
   "method": "by_timezone",
   "field_name": "vibes_timezone",
   "send_date": "2013-11-06",
   "send_time": "17:30"
},

"targeting" : {
   "message_template": "Test Broadcast SAT 2 {{ list_name }} Reply HELP for help, STOP to cancel-Msg&data rates may apply",
   "shorten_urls": true,
   "short_url_base": "http://vbs.cm/",
   "source_short_code": "54321",
   "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" },
      { "name" : "subscription_date", "transform": "year", "selector": "before", "value" : [ "2013" ] },
      { "name" : "birthdate", "transform": "year", "selector": "before", "value" : [ "2013" ] }
    ]
  }
}

"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

Any, All, None

Starts With

Ends With

Contains

On

Before

After

Between

On or Before

On or After

Country

x

 

 

 

 

 

 

 

 

 

Recipient List

x

 

 

 

 

 

 

 

 

 

MultiSelect

x

 

 

 

 

 

 

 

 

 

Select

x

x

x

x

 

 

 

 

 

 

String

x

x

x

x

 

 

 

 

 

 

Date

 

 

 

 

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

Country

Recipient List

MultiSelect

Select

String

Date

any

x

x

x

x

x

x

all

 

x

x

 

 

 

none

x

x

x

x

x

x

starts_with

x

 

x

x

x

x

starts_with_none

x

 

x

x

x

x

ends_with

x

 

x

x

x

x

ends_with_none

x

 

x

x

x

x

contains

x

x

x

x

x

x

contains_all

 

x

x

 

 

contains_none

x

x

x

x

x

x

on

 

 

 

 

 

x

before

 

 

 

 

 

x

after

 

 

 

 

 

x

between

 

 

 

 

 

x

on_or_before

 

 

 

 

 

x

on_or_after

 

 

 

 

 

x