8000 GitHub - isaachamid/roastmyivr: Test an IVR number with roastmyivr.com APIs
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

isaachamid/roastmyivr

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

roastmyivr

Test an IVR number with roastmyivr.com APIs

How to run

1. Clone repository:

git clone https://github.com/isaachamid/roastmyivr.git
cd roastmyivr

2. Register as a developer, create application in dashboard and get credentials

https://developer.roastmyivr.com/

3. Environment Variables

rename .env.example file to .env file and put your ROST IVR credentials

4. Install Packages

npm install

5. Run App

npm start

Requests

Start Roasting IVR

HTTP Method URL
POST http://localhost:3000/ivr/start
Body (application/json):
{
  "telephoneNumber": "61XXXXXXXXX",
  "findHiddenMenus": true,
  "webhookUrl": "string"
}

Get IVR roasting report

HTTP Method URL
GET http://localhost:3000/ivr/:ivrId

Terminate roasting process

HTTP Method URL
PATCH http://localhost:3000/ivr/:ivrId/terminate
Body (application/json):
{
  "task": "FailProcess"
}

OR

Body (application/json):
{
  "task": "GenerateReportImmediately"
}

OR

Body (application/json):
{
  "task": "GenerateReportAsSoonAsPossible"
}

Cancel retry roasting process

HTTP Method URL
PATCH http://localhost:3000/ivr/:ivrId/cancel-retry

About

Test an IVR number with roastmyivr.com APIs

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published
0