The Broadcastify Calls Upload API is how approved Calls providers send individual radio calls to Broadcastify Calls from their recorder (Trunk Recorder, SDRTrunk, Trunking Recorder, VoxCall, or their own software).
The full specification, examples and test scripts are on GitHub: github.com/blantonl/bcfy-calls-upload. This article is a summary.
Who this is for
Operators and developers of call recorders who send calls to an approved Broadcastify Calls node. It isn't a listening API: for playing calls, see the Broadcastify Calls Client API.
Getting set up
- Install and configure your recorder, and make sure it is receiving calls.
- Apply at broadcastify.com/apply/calls, telling us which recorder you use and which system or channels the calls come from.
- When approved, you receive an email with your node's system ID and API key. Your node is set up for your recorder and, for conventional channels, with its slots.
- Configure your recorder with the endpoint below, your system ID and your API key, and start sending calls.
Credentials work in production straight away. There is no separate development endpoint.
Sending a call
For each call, as soon as it ends:
-
POST https://api.broadcastify.com/call-uploadasmultipart/form-data, withsystemId,apiKeyand the call's details (talkgroup or slot, frequency, start time, length, source radio). Trunk Recorder sends its call JSON file instead. - An answer of
0 <url>means the call was accepted:PUTthe audio to that URL within 180 seconds, withContent-Type: audio/aacfor M4A oraudio/mpegfor MP3. - An answer starting with
1means the call wasn't taken, and says why.1 SKIPPED---ALREADY-RECEIVED-THIS-CALLis normal: we already have that call, so don't upload it. Every answer, and what to do about it, is listed in the specification.
Things that matter
-
Clock: keep your recorder's clock synchronized with NTP. A call more than 15 seconds off is refused (
REJECTED-CALL-SKEW-TOO-LONG). See broadcastify.com/skew. -
Call times: a call whose start time, end time or length is missing or isn't a number is refused (
REJECTED-INVALID-CALL-TIMESTAMP). -
Node setup:
Unsupported-Node-Type-Encoder-<n>-CallType-<n>means your node is set up with a recorder and system type we can't take together. It also shows up on a credentials test. Contact support to have the node corrected. - Audio: M4A (AAC) at about 32 kb/s is preferred. MP3 is accepted: mono, 22,050 Hz, constant 32 or 16 kb/s.
-
Testing credentials: send
test=1with yoursystemIdandapiKey. Good credentials answerOK, and nothing is recorded. - Patches: send every talkgroup in the patch, the main one first.
- Conventional channels: send the slot number for the channel, as listed on your node's page, not the frequency.
Managing your node
- Your nodes: broadcastify.com/calls/manage
- Service status: broadcastify.com/calls/status
- We email you when your node stops sending calls. A node that sends no calls for 15 days is removed; contact us to restore it.
Help
For questions, more nodes or changes to a node, write to support@broadcastify.com.
Comments
0 comments
Article is closed for comments.