Skip to content

Latest commit

 

History

History
45 lines (33 loc) · 2.3 KB

README.md

File metadata and controls

45 lines (33 loc) · 2.3 KB

MessageMedia Chameleon SMS

MessageMedia Chameleon SMS allows you to have masked communication between two parties using metadata. You will need to set up atleast one dedicated number for your account in order to get this application working as expected. To do so, you can send an email to MessageMedia's support team (support@messagemedia.com).

📕 Prerequisites

  1. Node
  2. ngrok
  3. Postman

🎬 Get Started

  1. Start ngrok - you can do this opening up the command line and running the command ngrok http 3000

  2. A successful execution will show you a screen similar to the one below

  3. Clone this repository

  4. Open the cloned repository and create a .env file

  5. Copy and paste the environmental variables below and update them accordingly:
    MM_API_API_KEY=[API Key from MessageMedia]
    MM_API_SECRET_KEY=[API Secret Key from MessageMedia]
    PORT=[Any, we recommend port 3000]
    CALLBACK_URL=[ngrok url]/incoming
    LINES=[dedicated number(s), separated by comma.]

Your ngrok url will show up on the command line after you run ngrok http 3000. You can choose any one of the 'Forwarding URLs'. This is what it typically looks like - http://f34bba6f.ngrok.io

  1. Fire up the command line from the root of this cloned repository and run npm install to install all dependencies

  2. Run npm start from the same location to start the express server

  3. You should see the following on your command line - Chameleon listening on port 3000!

  4. Click on the following button -
    Run in Postman

  5. This will import the request into your Postman application

  6. You should see something similar on your app

  7. Update your authentication details

  8. Update the url with your [ngrok url]/chameleon. Eg: http://f34bba6f.ngrok.io/chameleon

  9. Update the mobile numbers in the request. You can change the names and the expiry time as well.

  10. Hit send!

😕 Need help?

Please contact developer support at developers@messagemedia.com or check out the developer portal at developers.messagemedia.com

📃 License

Apache License. See the LICENSE file.