Telephony_API

Telephony Example

telephonyLiveCall.js

• Captures a live phone call via a phone number and a specification of what you'd like to collect.

  const connection = await sdk.startEndpoint({
      endpoint: {
          type: 'pstn',
          phoneNumber: PHONE_NUMBER,
      },
      insightTypes: ['action_item', 'question'],
      actions: [{
          invokeOn: 'stop',
          name: 'sendSummaryEmail',
          parameters: {
              emails: [
                  EMAIL
              ], // Add valid email addresses to received email
          },
      }, ],
      data: {
          session: {
              name: 'My Test Meeting',
          },
      },
  });

• Uses the subscribeToConnection from the SDK to access the data that is being collected live.

  // Subscribe to connection using connectionId.
  await sdk.subscribeToConnection(connection.connectionId, (data) => {
      const { type } = data;
      if (type === 'transcript_response') {
          const { payload } = data;
  
          // You get live transcription here
          console.log(`Live: ${payload && payload.content}`);
  
      } else if (type === 'message_response') {
          const { messages } = data;
  
          // You get processed messages in the transcript here. Real-time but not live.
          messages.forEach(message => {
              console.log(`Message: ${message.payload.content}`);
          });
      } else if (type === 'insight_response') {
          const { insights } = data;
          // You get any insights here!!!
          insights.forEach(insight => {
              console.log(`Insight: ${insight.type} - ${insight.text}`);
          });
      }
  });

connectToZoom.js

You can read more about this integration here.

const {sdk, SpeakerEvent} = require("@symblai/symbl-js");

const appId = "";
const appSecret = "";
const phoneNumber = ""; // US Zoom Numbers are "+16465588656", or "+14086380968".
const meetingName = "Zoom Test Meeting";
const emailAddress = "[email protected]";

const ZOOM_MEETING_ID = "ZOOM_MEETING_ID";
const ZOOM_PARTICIPANT_ID = "";
const ZOOM_MEETING_PASSCODE = "";

let dtmfSequence = `${ZOOM_MEETING_ID}#`;

if (ZOOM_PARTICIPANT_ID) {
  dtmfSequence += `,,${ZOOM_PARTICIPANT_ID}#`;
} else {
  dtmfSequence += `,,#`;
}

if (ZOOM_MEETING_PASSCODE) {
  dtmfSequence += `,,${ZOOM_MEETING_PASSCODE}#`;
}


sdk.init({
  appId: appId,
  appSecret: appSecret,
  basePath: "https://api.symbl.ai",
}).then(async() => {
  console.log('SDK initialized.');
  try {

    sdk.startEndpoint({
      endpoint: {
        type: "pstn",
        phoneNumber: phoneNumber,
        dtmf: dtmfSequence,
      },
      actions: [
        {
          invokeOn: "stop",
          name: "sendSummaryEmail",
          parameters: {
            emails: [
              emailAddress
            ],
          },
        },
      ],
      data: {
        session: {
          name: meetingName,
        },
      },
    }).then((connection) => {
      const connectionId = connection.connectionId;
      console.log("Successfully connected.", connectionId);
      console.log('Conversation ID', connection.conversationId);
      console.log('Full Conection Object', connection);
      console.log("Calling into Zoom now, please wait about 30-60 seconds.");
    })
    .catch((err) => {
       console.error("Error while starting the connection", err);
    });
  } catch (e) {
    console.error(e);
  }
}).catch(err => console.error('Error in SDK initialization.', err));

pushingEvents.js

• An event can be defined as a single occurrence of a process. Currently the only supported event type is speaker. The speaker event is associated with different individual attendees in a conference. An example of speaker event is shown below

  const speakerEvent = new SpeakerEvent({
      type: SpeakerEvent.types.startedSpeaking,
      user: {
          userId: '[email protected]',
          name: 'John'
      }
  });

  In the above example the user needs to have userId key-value pair to uniquely identify the user. It has the following types:

  • started_speaking

    This event contains the details of the user who started speaking with the timestamp of when he started speaking.

    Example:

    const speakerEvent = new SpeakerEvent({
        type: SpeakerEvent.types.startedSpeaking,
        user: {
            userId: '[email protected]',
            name: 'John'
        }
    });        

  • stopped_speaking

    This event contains the details of the user who stopped speaking with the timestamp of when he stopped speaking.

    Example:

    const speakerEvent = new SpeakerEvent({
        type: SpeakerEvent.types.stoppedSpeaking,
        user: {
            userId: '[email protected]',
            name: 'John'
        }
    }); 

  • joined

    This event contains the details of user who just joined the conference call with the timestamp at which they joined.

    Example:

    const speakerEvent = new SpeakerEvent({
        type: SpeakerEvent.types.joined,
        user: {
            userId: '[email protected]',
            name: 'John'
        }
    });

  • left

    This event contains the details of user who just left the conference call with the timestamp at which they left.

    Example:

    const speakerEvent = new SpeakerEvent({
        type: SpeakerEvent.types.left,
        user: {
            userId: '[email protected]',
            name: 'John'
        }
    });