Skip to content

FreeClimbAPI/Node-Pay-By-Phone-How-To-Guide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Node Pay By Phone How-To Guide

code style: prettier JavaScript Style Guide License: MIT Pay By Phone CI Coverage Status

This project serves as a guide to help you build a pay by phone IVR application with FreeClimb.

Specifically, the project will:

  • Receive an incoming call via a FreeClimb application
  • Route users via DTMF (e.g. keypad) input
  • Collect and process credit card payment information using privacymode
  • Use PerCL to send an SMS payment confirmation message to user

How-To Guide

We offer a Pay by Phone with Voice Calling how-to guide for more detailed set-up instructions and explanation of how the code in this sample app works.

Requirements

A FreeClimb account

A registered application with a named alias

A configured FreeClimb number assigned to your application

Trial accounts: a verified number

Tools:

Setting up the Sample App

  1. Install the required packages

    yarn install
  2. Create a .env file and configure the following environment variables within it:

    ENV VARIABLE DESCRIPTION
    ACCOUNT_ID Account ID which can be found under API credentials in dashboard.
    API_KEY API key which can be found under API credentials in dashboard.
    HOST The hostname as defined in your FC application. We recommend ngrok as an option to get up and running quickly.
    PORT Specifies the port on which the app will run (e.g. PORT=3000 means you would direct your browser to http://localhost:3000).
    FC_NUMBER The FreeClimb phone number associated with your application.

Running the Sample App

yarn start

Feedback & Issues

If you would like to give the team feedback or you encounter a problem, please contact support or submit a ticket in the dashboard.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published