moona3k/getting-started-samples

Code samples to Get started quickly with Symbl's Voice SDK and APIs.

Getting Started - Samples

Few code samples to get you started quickly with Symbl APIs.

List of Sample Codes

• PSTN Dial-in using Voice SDK
  • Establishes a connection using a phone number through PSTN, to send speaker events, generate insights, and display a summary URL with the output. You can see how to initialize the Voice SDK, connect to the endpoint, push speaker events and get the summary URL. Read More
• Realtime WebSocket using Voice SDK
  • Connect directly using WebSocket API and push audio and get results in real-time. Including Live Transcript and Insights. Read More
• Realtime Output with PSTN Dialin using Voice SDK
  • Get the live transcription and insights events in a Telephone call. Read More
• Intent Detection with PSTN Dial-In using Voice SDK
  • Get the intents, real-time in a Telephone call. Read More
• Passing different Audio Codecs

Install

Clone this repo on your machine and perform npm install.

git clone https://github.com/symblai/getting-started-samples.git
cd getting-started-samples
npm install  # Alternatively, you can also use yarn

Code samples in this repo use dotenv for configurations. Make copy of .env.default file as .env.

cp .env.default .env

Update APP_ID and APP_SECRET with valid values. You can get them by logging into Symbl Platform. Update any additional configuration such as DEFAULT_PHONE_NUMBER may be required for a particular sample to work properly.

Run

Make sure any required configuration is done within the code and/or .env file.

Every sample code has more instructions wherever applicable.

Once you've configured the above, simply run any sample code you would like to try for example:

node ./tutorials/node/live-transcript-phone-call/index.js

node ./examples/voice-sdk/realtime-websocket-single-stream/index.js

node ./examples/voice-sdk/telephony-custom-audio-config/index.js

node ./examples/voice-sdk/telephony-custom-language-and-timezone/index.js

node ./examples/voice-sdk/telephony-real-time-insights-transcription/index.js

node ./examples/voice-sdk/telephony-realtime-intent-detection/index.js

node ./examples/voice-sdk/telephony-speaker-events/index.js

Testing for PSTN

If you're dialing to a regular phone number then you will receive a call. If you've dialed into a meeting platform, you'll see another participant join the meeting. Begin speaking after you see new participant, the call will end and you'll receive an email with the generated insights if you have passed valid email Id in the code.

References

Feel free to fork any of the projects here to use on your own and if you have any code improvements, make a pull request and the request will be reviewed by one of our admins.

For a sample reference implementation using Symbl, take a look at our Platform.

If you have questions, bugs to report or feature suggestions, join our Dev Community.