Broadcast APIs

A Broadcast entity is a message template that has been scheduled and/or delivered to Subscribers within the Mobile Database.

The following are the three main sections to a Broadcast:

The Metadata Information
The Targeting Information
The Delivery Information

The Metadata information includes the fields about the broadcast, such as the ID, URL, created date, and so on.

The targeting information includes the fields used to identify recipients and craft the message.

The Delivery information is the metadata about the actual message delivery.

Broadcast Entity

The following 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",
   "created_by_application":"api",
   "send_scheduled_date":"2017-02-16T17:30:00Z",
   "send_schedule":{
      "method":"by_time_zone",
      "field_name":"vibes_timezone",
      "send_date":"2017-02-16",
      "send_time":"17:30",
      "default_time_zone":"US/Central"
   },
   "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"
      ],
	  "channel": "push",
      "push": {
   		"subject": "The message subject",
        "content_subject": "The content subject",
   		"content_url": "http://www.vibes.com",
   		"inbox_only": true,
   		"metadata": "deep-linking metadata"
 	  },
      "filters":[
         {
            "name":"favorite_sport",
            "selector":"any",
            "value":[
               "football",
               "baseball"
            ]
         },
         {
            "name":"first_name",
            "selector":"starts_with",
            "value":"Steve"
         },
         {
            "name":"recipient_list",
            "selector":"any",
            "value":["1"]
         },
		 {
            "name":"participant_list",
            "selector":"any",
            "value":["1"]
         },
         {
            "name":"country",
            "selector":"equals",
            "value":"US"
         },
         {
            "name":"subscription_date",
            "transform":"year",
            "selector":"before",
            "value":[
               "2017"
            ]
         },
         {
            "name":"birthdate",
            "transform":"year",
            "selector":"before",
            "value":[
               "2017"
            ]
         }
      ]
   }
}

"delivery" : {
  "send_start_date": "2017-02-11T18:54:43Z",
  "enqueue_completed_date": "2017-02-11T18:54:43Z",
  "recipient_count": 50,
},

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