Voice API with new interface

[iAmmar7]

Description

New interface for Voice API.

ref: https://github.com/signalwire/cloud-product/issues/7684

Type of change

• Internal refactoring
• Bug fix (bugfix - non-breaking)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

Code snippets

import { SignalWire } from '@signalwire/realtime-api'

(async () => {
  const client = await SignalWire({
    host: process.env.HOST,
    project: process.env.PROJECT,
    token: process.env.TOKEN,
  })

const unsubVoiceOffice = await client.voice.listen({
  topics: ['office'],
  onCallReceived: async (call) => {
    try {
      await call.answer()

      const unsubCall = await call.listen({
        onStateChanged: (call) => {},
        onPlaybackUpdated: (playback) => {},
        onRecordingStarted: (recording) => {},
        onCollectInputStarted: (collect) => {},
        onDetectStarted: (detect) => {},
        onTapStarted: (tap) => {},
        onPromptEnded: (prompt) => {},
        // ... more call listeners can be attached here
      })
      // ...
      await unsubCall()
    } catch (error) {
      console.error('Error answering inbound call', error)
    }
  },
})

const call = await client.voice.dialPhone({
  to: process.env.VOICE_DIAL_TO_NUMBER as string,
  from: process.env.VOICE_DIAL_FROM_NUMBER as string,
  timeout: 30,
  listen: {
    onStateChanged: async (call) => {
      // When call ends; unsubscribe all listeners and disconnect the client
      if (call.state === 'ended') {
        await unsubVoiceOffice()

        await unsubVoiceHome()
 
        await unsubPlay()

        client.disconnect()
      }
    },
    onPlaybackStarted: (playback) => {},
  },
})

const unsubCall = await call.listen({
  onPlaybackStarted: (playback) => {},
  onPlaybackEnded: (playback) => {
    // This will never run since we unsubscribe this listener before the playback stops
  },
})

// Play an audio
const play = await call.playAudio({
  url: 'https://cdn.signalwire.com/default-music/welcome.mp3',
  listen: {
    onStarted: async (playback) => {
       await unsubCall()

       await play.stop()
    },
  },
})

const unsubPlay = await play.listen({
  onStarted: (playback) => {
    // This will never run since this listener is attached after the call.play has started
  },
  onEnded: async (playback) => {
    await call.hangup()
  },
})

[changeset-bot]

🦋 Changeset detected

Latest commit: 802f5a2

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages

Name	Type
@signalwire/realtime-api	Major
@signalwire/core	Major
@signalwire/node	Patch
@signalwire/js	Patch
@signalwire/web-api	Patch
@signalwire/webrtc	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[edolix]

Wondering if we can merge/include this event into onCollectUpdated ?

[iAmmar7]

I think we could do that.

Instead of this

case 'start_of_input': {
        if (eventPrefix === 'prompt') return false
        callInstance.emit(`${eventPrefix}.startOfInput`, actionInstance)
        actionInstance.emit(
          `${eventPrefix}.startOfInput` as never,
          actionInstance
        )
        return false
      }

We can simply change the event name here

case 'start_of_input': {
        if (eventPrefix === 'prompt') return false
        callInstance.emit(`${eventPrefix}.updated`, actionInstance)
        actionInstance.emit(`${eventPrefix}.updated` as never, actionInstance)
        return false
      }

[edolix]

Discussed: since start_of_input is a specific event we should have the handler. Let's discuss the name onCollectInputStarted w/ Product.

[edolix]

🥇 🥇