Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shivamp-vg authored Apr 22, 2024
1 parent fd0c402 commit 31ce172
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion telephony-bot-api/type-callback/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,21 @@
# Callback Type Telephony Bot API #
# Callback Type Telephony Bot API #

HOW TO RUN A BOT:

1) Install the python packages installed : flask, requests and json

2) Run the python script that starts a flask server on port 80.
Run: python <script-name>.py

3) You can have a service like ngrok to a web url that create a tunnel and provides a weburl that redirects APIs the locally running server.
Run the ngrok server by the command: ngrok http 80

4) You can add the weburl provided by ngrok in the telephony bot, as the Inbound speech callback url. Make sure the connect method is set to callback which is the POST API endpoint.

5) You can now call the bot and it should work.



NOTE:

The above steps is an easy way to test the bot script. Ideally you have to create a server and host it, that way the POST which invokes the bot session will be available on web.

0 comments on commit 31ce172

Please sign in to comment.