An HTTP API for managing text-based messaging channels such as SMS, USSD, XMPP, Twitter, IRC.
Any design goals marked in italics are goals that are not yet implemented in the code base.
Junebug is a system for managing text messaging transports via a RESTful HTTP interface that supports:
- Creating, introspecting, updating and deleting transports
- Sending and receiving text messages
- Receiving status updates on text messages sent
- Monitoring transport health and performance
- Retrieving recent transport logs for debugging transport issues.
Junebug aims to satisfy the following broad criteria:
- Avoid replication of work to integrate with aggregators and MNOs (and to maintain these connections).
- Maximum simplicity (narrow scope, minimal useful feature set).
- Provide a common interface to diverse connection protocols.
- Handle buffering of messages and events in both inbound and outbound directions.
- Minimum dependencies.
- Easy to install.
Outbound message sending¶
- Simple universal HTTP API for sending.
- Each channel is independent and cannot block or cause others to fail.
- Does not handle routing. Channel to send to is specified when making the HTTP API request.
- Configurable rate-limiting on each connection.
- Queues for each connection.
- Multiple priority levels supported for each connection. We need at least two priority levels: “bulk” and “realtime”.
Delivery and status reports for outbound messages¶
- Can specify an HTTP URL with each outgoing request, as the callback for delivery status reports for that message.
- Callback URL supports template variables (like Kannel does).
Channel creation and management¶
- CRUD operations on channels.
- Possible to list channels.
- Possible to query the queue length.
- Possible to query the message sending, delivery and failure rates.
- Possible to cancel the sending of all queued messages.
- Able to specify a URL, per channel
- Inbound message URL supports configurable (substituted) parameters.
- Retries delivery on failures
Accessing detailed log messages is a vital requirement for debugging issues with connections to third parties.
- Be able to access PDUs or similar detailed channel message logs for recent messages.
- Logs should be retrievable by associated channel id.
- Logs should be retrievable by associated message id.
Relevant prior works¶
Other systems that have acted as inspirations or components of Junebug:
|channel:||a single connection to a provider|
|channel type:||connections are instances of channel types. Example: Twilio, SMPP 3.4, etc.|
Junebug relies on Redis for temporary storage, RabbitMQ for message queueing, and files on disc for logs. This setup was chosen so that Junebug would be easy to setup and start using, and not require a large, complicated, multi-system setup.
There are downsides to this approach, however, Junebug is currently restricted to a single threaded process.