https://github.com/nexmo/test-vapi-services
Rails application to test various Nexmo VAPI services
https://github.com/nexmo/test-vapi-services
Last synced: 11 months ago
JSON representation
Rails application to test various Nexmo VAPI services
- Host: GitHub
- URL: https://github.com/nexmo/test-vapi-services
- Owner: Nexmo
- License: mit
- Created: 2019-08-02T15:33:31.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2025-06-01T07:28:26.000Z (about 1 year ago)
- Last Synced: 2025-06-20T01:07:48.410Z (about 1 year ago)
- Language: Ruby
- Size: 43 KB
- Stars: 0
- Watchers: 12
- Forks: 0
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Testing Rails Application for Nexmo VAPI services
This Rails app encompasses various actions to test Nexmo VAPI features.
Right now, the following are included:
* VAPI REST Start and Stop Conversation Recording
## VAPI REST Start/Stop Conversation Recording
The actions for testing the REST Start and Stop of an in-progress call are in `/controllers/rest_controller.rb`.
Usage:
1. Create a Nexmo voice application and link a Nexmo provisioned phone number to it
2. Supply your Nexmo credentials to Rails Credentials, namespaced under `nexmo`: `api_key`, `api_secret`, `application_id`, `private_key` (i.e. `Rails.application.credentials.nexmo[:api_key]`)
3. Start the Rails server
4. Start the ngrok server, ensuring that the ngrok subdomain matches the subdomain provided to the Nexmo application
5. Call the Nexmo provisioned phone number
6. Navigate to `http://localhost:3000` and choose `Start` and press `Submit`
7. To stop the recording choose `Stop` and press `Submit`
8. Your Rails server logs will show the output from the Nexmo API including whether the action was successful and the recording URL
*(Note: You can test either named or ephemeral conversations by uncommenting and commenting out the appropriate NCCO action in the `#answer` action in the `RestController`.)*
## LICENSE
This project is licensed under the [MIT LICENSE](LICENSE).