{"id":15091457,"url":"https://github.com/calemroelofs/swagger-ivr","last_synced_at":"2026-01-04T17:08:20.778Z","repository":{"id":191675483,"uuid":"532904611","full_name":"CalemRoelofs/swagger-ivr","owner":"CalemRoelofs","description":"Convert your OpenAPI definition into a Twilio IVR menu!","archived":false,"fork":false,"pushed_at":"2022-09-05T13:23:57.000Z","size":50,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-22T10:48:31.404Z","etag":null,"topics":["oas","openapi","swagger","twilio","twiml","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CalemRoelofs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2022-09-05T13:05:40.000Z","updated_at":"2022-09-05T19:39:56.000Z","dependencies_parsed_at":"2023-08-31T04:10:55.926Z","dependency_job_id":null,"html_url":"https://github.com/CalemRoelofs/swagger-ivr","commit_stats":null,"previous_names":["calemroelofs/swagger-ivr"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CalemRoelofs%2Fswagger-ivr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CalemRoelofs%2Fswagger-ivr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CalemRoelofs%2Fswagger-ivr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CalemRoelofs%2Fswagger-ivr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CalemRoelofs","download_url":"https://codeload.github.com/CalemRoelofs/swagger-ivr/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244945590,"owners_count":20536296,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["oas","openapi","swagger","twilio","twiml","typescript"],"created_at":"2024-09-25T10:41:12.687Z","updated_at":"2026-01-04T17:08:20.743Z","avatar_url":"https://github.com/CalemRoelofs.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Swagger IVR  \nFinding yourself reading a API definitions and thinking _\"This is too easy, there has to be a harder way!\"_? 🤔  \nSick of the bright colours and utility of [Swagger UI](https://github.com/swagger-api/swagger-ui) and [Redoc](https://github.com/Redocly/redoc)? 🎨  \nWish you could review documentation with nothing but a screenless telephone? ☎️  \nThen look no further, your prayers have been answered! 🙌🏼  \n\nSwagger IVR will convert your OpenAPI definition into a [TwiML](https://www.twilio.com/docs/voice/twiml) \n[IVR (Interactive Voice Response)](https://www.twilio.com/docs/interactive-voice-response) webhook server \nto build a phone tree that can be dialled into and listened to by anyone!  \n\nFor a quick demo, call [+44 7401 195003](tel:+44-740-1195003), which will be up for as long as there is credit remaining on that Twilio account.\n\n## Installation  \nTo run the application locally:  \n```bash\n$ npm ci\n$ npm run build\n$ npm run start\n```\n\nTo build and run with Docker:  \n```bash\n$ npm ci\n$ npm run docker\n```\n\n## Usage \n### Before you start:  \n- Swagger IVR uses [Twilio's Programmable Voice](https://www.twilio.com/docs/voice) offering to power the IVR functionality, and as such most of the setup is done over there.  \n- When Swagger IVR runs, currently it will parse whatever API definition is saved in `./openapi.yaml` in the root of the project.  \n- OpenAPI definitions are not resolved or dereferenced currently, so for the best experience use a fully dereferenced OpenAPI definition.  \n- Twilio does charge 1c per minute (or per part of a minute, meaning 1 minute and 1 second is still billed at 2 minutes) on incoming calls, so there is some cost to running this yourself.  \n\n### Setup: \n1. Run Swagger IVR and make it accessible to the internet using something like [ngrok](https://ngrok.com/).  \n2. [Buy a voice-enabled phone number](https://www.twilio.com/console/phone-numbers/incoming) from Twilio and [configure it to send webhook requests](https://www.twilio.com/docs/voice/tutorials/how-to-respond-to-incoming-phone-calls/node#buy-and-configure-a-phone-number) to your URL when a call comes in.  \n3. Dial the phone number you have purchased in Step 2.  \n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcalemroelofs%2Fswagger-ivr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcalemroelofs%2Fswagger-ivr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcalemroelofs%2Fswagger-ivr/lists"}