Komponent React - ThunderPhone

Komponent ThunderPhoneWidget renderuje szklany pasek połączenia z wbudowanymi elementami sterującymi do wyciszania, kończenia połączenia i wyświetlania stanu połączenia. To najszybszy sposób na dodanie głosowej AI do aplikacji React.

Instalacja

npm install @thunderphone/widget

Podstawowe użycie

import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'

function App() {
  return (
    <ThunderPhoneWidget
      publishableKey="pk_live_your_publishable_key"
    />
  )
}

Aby widżet renderował się poprawnie, musisz zaimportować plik CSS. Bez niego widżet nie będzie miał stylów.

Właściwości

Komponent przyjmuje następujące właściwości przez ThunderPhoneWidgetProps:

Właściwość	Typ	Wymagane	Domyślna	Opis
`publishableKey`	`string`	Tak	—	Publikowalny klucz API (`pk_live_...`) z ustawień Deweloperzy. Agent jest rozpoznawany automatycznie na podstawie konfiguracji widżetu przypisanej do klucza.
`theme`	`'light' \| 'dark'`	Nie	`'light'`	Schemat kolorów. Stosuje klasę `tp--light` lub `tp--dark` do głównego elementu widżetu.
`primaryColor`	`string`	Nie	`'#000000'` (jasny) / `'#ffffff'` (ciemny)	Ciąg koloru CSS używany jako kolor akcentujący (przycisk połączenia, fala dźwiękowa, aktywne wskaźniki).
`title`	`string`	Nie	`'Voice assistant'`	Tekst wyświetlany na pasku widżetu.
`position`	`'bottom-right' \| 'bottom-left' \| 'top-right' \| 'top-left'`	Nie	`'bottom-right'`	Stała pozycja widżetu w obszarze widoku.
`apiBase`	`string`	Nie	`'https://api.thunderphone.com/v1'`	Zastąpienie bazowego adresu URL API.
`language`	`string`	Nie	—	Zastąpienie języka dla sesji — kod języka lub ustawienia regionalne, takie jak `en`, `es` lub `fr-FR`. Jeśli nie ustawiono, używany jest skonfigurowany język agenta.
`voice`	`string`	Nie	—	Zastąpienie głosu dla sesji — nazwa głosu, taka jak `maria`. Jeśli nie ustawiono, używany jest skonfigurowany głos agenta.
`context`	`string`	Nie	—	Kontekst faktyczny strony lub witryny przekazywany agentowi dla danej sesji (na przykład szczegóły strony oglądanej przez odwiedzającego). Skracany po stronie serwera do 12 000 znaków.
`onConnect`	`() => void`	Nie	—	Wywoływane po pomyślnym połączeniu sesji głosowej.
`onDisconnect`	`() => void`	Nie	—	Wywoływane po zakończeniu sesji.
`onError`	`(error) => void`	Nie	—	Wywoływane w przypadku błędów. Obiekt `error` zawiera pola `error` (kod) i `message`.
`className`	`string`	Nie	—	Dodatkowa nazwa klasy CSS zastosowana do kontenera widżetu.
`ringtone`	`boolean \| string`	Nie	`false`	Odtwarzaj dzwonek podczas łączenia. `true` oznacza domyślny dzwonek, a ciąg URL — niestandardowy dźwięk.

Przykłady

Ciemny motyw z niestandardowym kolorem

import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'

function App() {
  return (
    <ThunderPhoneWidget
      publishableKey="pk_live_your_publishable_key"
      theme="dark"
      primaryColor="#8b5cf6"
      title="Talk to our AI"
    />
  )
}

Niestandardowa pozycja

import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'

function App() {
  return (
    <ThunderPhoneWidget
      publishableKey="pk_live_your_publishable_key"
      position="bottom-left"
    />
  )
}

Język, głos i kontekst dla sesji

Właściwości language, voice i context są przekazywane do żądania sesji (POST /widget/session) po rozpoczęciu połączenia, zastępując skonfigurowane domyślne ustawienia agenta dla tej sesji:

import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'

function PricingPageWidget() {
  return (
    <ThunderPhoneWidget
      publishableKey="pk_live_your_publishable_key"
      language="es"
      voice="maria"
      context="Page: Pricing. Plans: Starter $29/mo, Pro $99/mo. Annual billing saves 20%."
    />
  )
}

Użyj context, aby przekazać agentowi faktyczną wiedzę o stronie, na której znajduje się odwiedzający — szczegóły produktu, ceny lub często zadawane pytania dotyczące danej strony. Po stronie serwera jest ona skracana do 12 000 znaków.

Z wywołaniami zwrotnymi zdarzeń

import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'

function SupportWidget() {
  return (
    <ThunderPhoneWidget
      publishableKey="pk_live_your_publishable_key"
      onConnect={() => {
        console.log('Voice session connected')
        analytics.track('widget_call_started')
      }}
      onDisconnect={() => {
        console.log('Voice session ended')
        analytics.track('widget_call_ended')
      }}
      onError={(error) => {
        console.error(`Widget error: ${error.error} - ${error.message}`)
      }}
    />
  )
}

Z niestandardowym stylem

import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'

function BrandedWidget() {
  return (
    <ThunderPhoneWidget
      publishableKey="pk_live_your_publishable_key"
      primaryColor="#4a90d9"
      className="my-custom-widget"
    />
  )
}

.my-custom-widget .tp-button--end {
  background-color: #e74c3c;
}

Zobacz przewodnik po stylach, aby poznać wszystkie dostępne klasy CSS i niestandardowe właściwości.

Z dzwonkiem

Odtwarzaj dźwięk dzwoniącego telefonu podczas nawiązywania połączenia:

import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'

function PhoneWidget() {
  return (
    <ThunderPhoneWidget
      publishableKey="pk_live_your_publishable_key"
      ringtone={true}
    />
  )
}

Użyj niestandardowego dzwonka, przekazując adres URL pliku audio:

<ThunderPhoneWidget
  publishableKey="pk_live_your_publishable_key"
  ringtone="https://example.com/my-ringtone.mp3"
/>

Dzwonek jest odtwarzany w pętli, gdy widżet jest w stanie connecting, i płynnie cichnie, gdy agent się połączy.

Z niestandardową bazą API

Właściwość apiBase musisz ustawić tylko wtedy, gdy używasz samodzielnie hostowanego lub pośredniczącego punktu końcowego API. Domyślnie wskazuje ona na https://api.thunderphone.com/v1.

<ThunderPhoneWidget
  publishableKey="pk_live_your_publishable_key"
  apiBase="https://your-proxy.example.com/v1"
/>

Obsługa błędów

Gdy wywołanie zwrotne onError zostanie uruchomione, otrzymuje obiekt błędu z dwoma polami:

Pole	Typ	Opis
`error`	`string`	Kod błędu czytelny dla maszyny
`message`	`string`	Opis błędu czytelny dla człowieka

Typowe kody błędów obejmują niedozwoloną domenę, nieznalezionego agenta i nieprawidłowy klucz API.

Kolejne kroki

Hook bez interfejsu

Potrzebujesz pełnej kontroli nad interfejsem użytkownika? Zamiast tego użyj hooka useThunderPhone.

Stylizacja

Dostosuj kolory, rozmiary i układ za pomocą niestandardowych właściwości CSS.

​Instalacja

​Podstawowe użycie

​Właściwości

​Przykłady

​Ciemny motyw z niestandardowym kolorem

​Niestandardowa pozycja

​Język, głos i kontekst dla sesji

​Z wywołaniami zwrotnymi zdarzeń

​Z niestandardowym stylem

​Z dzwonkiem

​Z niestandardową bazą API

​Obsługa błędów

​Kolejne kroki

Hook bez interfejsu

Stylizacja

Instalacja

Podstawowe użycie

Właściwości

Przykłady

Ciemny motyw z niestandardowym kolorem

Niestandardowa pozycja

Język, głos i kontekst dla sesji

Z wywołaniami zwrotnymi zdarzeń

Z niestandardowym stylem

Z dzwonkiem

Z niestandardową bazą API

Obsługa błędów

Kolejne kroki