Request Access to the Broadcastify Calls Client API
Request Access
Broadcastify Calls Client API Overview

Overview

Broadcastify Calls is a high capacity service that ingests individual radio system calls. Calls are sent to the platform using the Broadcastify Calls Ingest API from software applications that capture the calls.

Calls Client API Endpoint Methods

Live Calls Returns live calls specified by entity and time position
Get Playlist Returns the details of a playlist specified by uuid
County Playlists Returns all public playlists in a specific county specified by ctid
User Playlists Returns all playlists owned by the authenticated user
Create Playlist Creates a playlist for the authenticated user
Edit Playlist Edits the attributes of a playlist
Delete Playlist Deletes a playlist
Add Group to Playlist Adds a group to a playlist
Delete Group from Playlist Deletes a group from a playlist
County Groups Returns all groups captured in a county specified by ctid
Get Group Returns the details of a group specified by groupId
Get Source Returns the details of a source/user specified by srcId
Get Node Returns the details of a capturing node specified by nodeId
Get Call Returns the details of a specific call specified by groupId and ts
Get Group Archives Returns all calls for a group specified by groupId and start and end timestamps.


Entities

Entity Attribute Description
Call groupId and ts A call is an audio file, encoded in MP3 or MP4 format, of an individual radio transmission conducted on a group. A call is represented by a Group ID (groupId) and unix timestamp when the call started (ts).
Node nodeId A node is an entity that captures calls and sends to the Broadcastify Calls platform. A node can be classified as trunking node, which captures calls from Trunked Radio Systems, or a conventional node, which captures calls from conventional radio channels (individual radio frequencies). A node is provided by a volunteer who has submitted an application to host a node and configured the necessary hardware and software to capture calls and send them to the calls platform.

See: Broadcastify Calls Application
Group groupId

A group can represent the following:

Trunked Radio System Talkgroup

A trunked radio system group represents talkgroup that is captured by a node monitoring a trunked radio system site. A trunked radio system group is represented in the following format:

{sid}-{talkgroup}

  • sid - The trunked radio system unique system identifier in the RadioReference Database
  • talkgroupId - Trunked Radio System talkgroup ID in decimal format

Example: Talkgroup 3416(A1 Regional Law Enforcement 1) on the Greater Austin/Travis Regional Radio System (unique sid of 2) is represented as a Broadcastify Calls Group as:

  • 2-3416
Conventional Channel

A conventional channel group is an individual radio frequency that is captured by a node. A conventional radio system group is represented in the following format:

c-{fid}

  • fid - The conventional frequency unique identifier in the RadioReference Database

Example: Conventional Frequency 155.160 MHz XX Police Dispatch (unique fid of 223312) is represented as a Broadcastify Calls Group as:

  • c-223312
Tag tagId

Service tags are assigned to groups and specify what content a group is carrying. They are documented here: https://wiki.radioreference.com/index.php/Service_Tags

A service tag has a allowedListen attribute which determines whether or not the general public is permitted access to group calls assigned that tag. Broadcastify Calls ingests all calls a node provider sends to the platform, but restricts access to certain service tags to only the node providers who provided the calls.

The general public is generally not permitted to access Law Tactical and other "sensitive" service tags.
Source srcId

A source ID represents a unique source identifier of a call. Source IDs are typically only available from trunked radio system groups calls and not conventional groups.

A trunked radio system source ID is represented in the following format:

  • sid - The trunked radio system unique system identifier in the RadioReference Database
  • rid - Source individual radio ID

Example: Source individual radio ID 6040271 on the Alamo Area Regional Radio System (unique sid of 7017) is represented as a Broadcastify Calls Source ID as:

  • 7017-6040271
Playlist uuid

A playlist is a collection of groups defined by a user for the purpose of listening to calls from those groups. A playlist can consist of both conventional and trunked groups. A playlist has a limit of 30 entries.

Public Playlists

A public playlist is a playlist defined by a user and made available for others to listen to. Public playlists are assigned to a specific county location entity on Broadcastify so others can locate it.
System sid

A system is an entity that represents a Trunked Radio System in the RadioReference database. A trunked radio system consists of sites and talkgroups.

Example: Greater Austin/Travis Regional Radio System
Site siteId

A site is an entity that represents a specific broadcast site for a Trunked Radio System. A Broadcastify Calls node can capture talkgroups from a site.

Example: Greater Austin/Travis Regional Radio System - Austin Travis Site