neoms

README

NeoMs

The open-source alternative to Twilio.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Project NeoMs is open-source alternative to twilio voice api. It helps software developer or enterprises to build CPaaS like twilio with their infrastructure.

(back to top)

Built With

• FreeSWITCH
• GoLang
• Redis

(back to top)

Getting Started

Prerequisites

NeoMs required local redis on each server where you setup NeoMs. Redis is used for live call stats.

• Redis

  sudo apt install redis-server
  

• FreeSWITCH (You may install your desired version)

  sudo apt-get update && apt-get install -y gnupg2 wget lsb-release
  wget -O - https://files.freeswitch.org/repo/deb/debian-release/fsstretch-archive-keyring.asc | apt-key add -
  echo "deb http://files.freeswitch.org/repo/deb/debian-release/ `lsb_release -sc` main" > /etc/apt/sources.list.d/freeswitch.list
  echo "deb-src http://files.freeswitch.org/repo/deb/debian-release/ `lsb_release -sc` main" >> /etc/apt/sources.list.d/freeswitch.list
  # you may want to populate /etc/freeswitch at this point.
  # if /etc/freeswitch does not exist, the standard vanilla configuration is deployed
  # apt-get update && apt-get install -y freeswitch-meta-all
  

Installation

1. Clone the repo

   git clone https://github.com/tiniyo/neoms.git
   

2. Install the neoms package dependency using go mod.

   cd neoms
   go mod download
   

3. Please enter your api configurations using environment variable.

   EXPORT REGION=ALL
   EXPORT SER_USER=API_BASIC_AUTH_USER
   EXPORT SER_SECRET=API_BASIC_AUTH_SECRET
   EXPORT SIP_SERVICE=SIP_SERVICE_URL
   EXPORT KAMGO_SERVICE=LOCATION_SERVICE_URL
   EXPORT NUMBER_SERVICE=NUMBER_SERVICE_URL
   EXPORT HEARTBEAT_SERVICE=HEARTBEAT_SERVICE_URL
   EXPORT RATING_ROUTING_SERVICE=RATING_ROUTING_SERVICE_URL
   EXPORT CDR_SERVICE=CDR_SERVICE_URL
   EXPORT RECORDING_SERVICE=RECORDING_SERVICE_URL
   

4. build the neoms and run the n

go build -o neoms main.go
./neoms

(back to top)

Usage

For more examples, please refer to the Documentation

(back to top)

Roadmap

• XML Parser
• Play, Say, Dial, Sip, Number, Record, Hangup, Reject, Pause, Gather , Redirect Twilio elements support
• [] Conference
  • [] Conference API
  • [] Inbound XML Support
  • [] Outbound XML Support
• HeartBeat Event for billing
• CDR Post to api
• Initiated, Ringing, In-Progress, Hangup, Record Start, Record Stop Event for Twilio based callback for customer Url
• HeartBeat Event for billing
• Text2Speech Support
• [] Speech2Text Support
• DTMF Support
• [] Speech Detection

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @twitter_handle - support@tiniyo.com

Project Link: https://github.com/tiniyo/neoms

(back to top)

Acknowledgments

(back to top)