Skip to content

Latest commit

 

History

History
91 lines (52 loc) · 4.24 KB

README.md

File metadata and controls

91 lines (52 loc) · 4.24 KB
Raw

Nextjs-symblai-demo

Introduction

Symbl is a comprehensive suite of APIs for analyzing natural human conversations - both for your team’s internal conversations and of course the conversations you are having with your customers. Built on our Contextual Conversation Intelligence (C2I) technology, the APIs enable you to rapidly incorporate human-level understanding that goes beyond simple natural language processing of voice and text conversations.

This app is using ReactJS, Typescript and NextJS. Let's take a look at folder structure

  • pages In Next.js, a page is a React Component exported from a .js, .jsx, .ts, or .tsx file in the pages directory. Each page is associated with a route based on its file name. You can read more about how NextJS works with pages here

  • pages/api here reside NextJS API routes. Here we have call and subscribeToPhoneEvents routes that will be translated to /api/call and /api/subscribeToPhoneEvents paths in the browser. In this routes we showcase how you can use Symbl Node SDK to get realtime data from API. You can read more about NodeSDK here or read a how to guide here

Index page

On the first page of the app we showcase how you can call to your phone number (or meeting number) by providing the phone and multiple parameters. You will get conversational insights, transcriptions, messages, which Symbl.ai gets from this call. Architecture looks similar to this:

REST API

Symbl has REST API to do majority of things like getting insights, processing audio, video and text, get conversation data and much more. Rest of the pages of the app are focused on this API and showcase different use cases of Symbl from getting tasks and questions from existing conversation to uploading and processing video and audio files. You can even get transcriptions from the video and by clicking on these transcriptions, navigate to specific parts of the video. You can see this behavior on /video page.

Pre-requisites

To get started, you’ll need your account credentials and Node.js installed (> v8.x) on your machine.Your credentials include your appId and appSecret. You can find them on the home page of the Symbl.ai platform.

App ID

Environment variables

After you sign up on the Symbl.ai platform you copy your APP_ID and APP_SECRET, you need to set them up under .env file in this repo

APP_ID=
APP_SECRET=

Deploying

To run app locally , add credentials to next-config.js file filling in APP_ID and APP_SECRET variables.

module.exports = {
  env: {
    APP_ID: '',
    APP_SECRET: '',
  },
}

run yarn or npm install. To run the app, use yarn dev

App will start running at http://localhost:3000

Conclusion

In this app we have represented the following capabilities of Symbl.ai

  • Symbl Node SDK (Check out api/call file)
  • REST Telephony API (/phone page)
  • Conversational API (/conversations page)
  • Async Audio API (/audio page)
  • Async Video API (/video page)
  • Async Text API (/text page) - Coming soon
  • Symbl react elements package available here

Relevant docs section:

How Tos are available here

Community

If you liked our integration guide, please star our repo!

If you have any questions, feel free to reach out to us at [email protected] or through our Community Slack at https://developer.symbl.ai/community/slack

This library is released under the [MIT License][license]

Signup for free