Skip to content
This repository has been archived by the owner on Apr 1, 2024. It is now read-only.

NotifiUs/wctp-gateway

Repository files navigation

WCTP Gateaway

GitHub license GitHub Tag Codacy Badge

About WCTP Gateway

WCTP Gateway is a web application that implements the Carrier Gateway WCTP Actor roles needed to interface with the Amtelco WCTP Intelligent Series SMS Aggregator interface.

Ardently crafted for the Amtelco and NAEO community, you can use this application to run an Amtelco-compatible primary or backup SMS aggregator service using your own Twilio and ThinQ accounts — just bring your API keys!

The modern WCTP engine brings the following features and more:

  • Create and manage Enterprise Host credentials
  • Bring your own Twilio, ThinQ/Commio, or Sunwire accounts
  • Support for using Twilio Messaging Services or Phone Numbers
  • Carrier priority
  • TLS/SSL required by default
  • Email login notifications
  • Work's out of the box with Twilio's WhatsApp integration
  • A generic webhook API provider

Coming Soon

  • Improved fail-over and priorities between carrier
  • More telecom API providers (Bandwidth.com)
  • MergeComm scripting integration for Amtelco ecosystems

Status

The WCTP Gateway is operational for interacting with WCTP Enterprise Hosts and Transient Clients of all ecosystems.

The latest tagged version is:

GitHub Release (latest by date)

Commercial installation and support is available through NotifiUs, LLC

Requirements

We use application, language, and OS features that require the following tools and technologies:

  • Ubuntu Server x64 linux 18.04 LTS or higher
  • php 8.1+ for web application scripting
  • nginx with php-fpm for web server
  • redis-server for caching/queue
  • mysql for storage
  • supervisord to watch queue processes

We utilize linux specific methods of obtaining data about the hardware/server (such as memory, disk space, CPU, etc.) Because of this, we require the use of a linux host. We generally recommend Ubuntu for most users.

Technologies

WCTP Gateway is a Laravel web-application that implements a WCTP endpoint and administrative portal. This system cannot send SMS messages without a supported carrier (Telecom API provider) like Twilio or ThinQ.

Front End

The web portal UI is built on Bootstrap with some TailwindCSS sprinkled in. We use Font Awesome free for icons throughout the application. For various splash pages (errors, etc), we use open source illustrations from UnDraw.

Laravel Application

You can run Laravel in a wide-variety of environments, including Digital Ocean, Amazon, Azure, and just about any modern PHP web environment. Start from a single-server appliance setup and grow into a full-blown load balancing and clustering setup.

Contributing

Thank you for considering contributing to WCTP Gateway! Please email Patrick Labbett or submit a PR!

Security Vulnerabilities

Please see SECURITY.md

License

WCTP Gateway is open-sourced software licensed under the MIT license.

Tested compatability list

  • Amtelco WCTP 2-Way Messaging API
  • InfoRad Messaging Gateway
  • NotePage PageGate / PageGate Platinum

Carrier Drivers

Please see our guide to creating a driver for more information on creating a driver.

I recognize this is not the cleanest way to use drivers - a refactor is planned for the planned 2.x series.