ThunderPhone v3 je tu.Začnite sami, už od 2 ¢/min.Prečítať oznámenie

Widget

Komponent React

Vložte hlasový widget ThunderPhone do aplikácie React

Komponent ThunderPhoneWidget vykresľuje sklenený panel hovoru so vstavanými ovládacími prvkami na stlmenie, ukončenie hovoru a zobrazenie stavu pripojenia. Je to najrýchlejší spôsob, ako pridať hlasovú AI do aplikácie React.

Inštalácia

npm install @thunderphone/widget

Základné použitie

import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'
 
function App() {
  return (
    <ThunderPhoneWidget
      publishableKey="pk_live_your_publishable_key"
    />
  )
}

Vlastnosti

Komponent prijíma nasledujúce vlastnosti prostredníctvom ThunderPhoneWidgetProps:

VlastnosťTypPovinnéPredvolenéPopis
publishableKeystringÁno--Publikovateľný kľúč API (pk_live_...) zo sekcie Webové widgety na paneli. Agent sa automaticky určí z konfigurácie widgetu daného kľúča.
theme'light' | 'dark'Nie'light'Farebná schéma. Na koreňový prvok widgetu použije triedu tp--light alebo tp--dark.
primaryColorstringNie'#000000' (svetlá) / '#ffffff' (tmavá)Reťazec farby CSS použitý ako farba akcentu (tlačidlo volania, priebeh zvukovej vlny, aktívne indikátory).
titlestringNie'Voice assistant'Text zobrazený v lište widgetu.
position'bottom-right' | 'bottom-left' | 'top-right' | 'top-left'Nie'bottom-right'Pevná pozícia widgetu v zobrazení.
apiBasestringNie'https://api.thunderphone.com/v1'Prepísanie základnej adresy URL API.
languagestringNie--Prepísanie jazyka pre reláciu – kód jazyka alebo miestne nastavenie, napríklad en, es alebo fr-FR. Ak nie je nastavené, použije sa nakonfigurovaný jazyk agenta. Vyžaduje language v sekcii prepísania prehliadača daného kľúča.
voicestringNie--Prepísanie hlasu pre reláciu – názov hlasu, napríklad maria. Ak nie je nastavené, použije sa nakonfigurovaný hlas agenta. Vyžaduje voice v sekcii prepísania prehliadača daného kľúča.
contextstringNie--Faktický kontext stránky alebo webu pre reláciu odovzdaný agentovi (napríklad podrobnosti o stránke, ktorú návštevník zobrazuje). Na serveri sa skráti na 12 000 znakov. Vyžaduje context v sekcii prepísania prehliadača daného kľúča.
onConnect() => voidNie--Zavolá sa po úspešnom pripojení hlasovej relácie.
onDisconnect() => voidNie--Zavolá sa po skončení relácie.
onError(error) => voidNie--Zavolá sa pri chybách. Objekt error obsahuje polia error (kód) a message.
classNamestringNie--Ďalší názov triedy CSS použitý na kontajner widgetu.
ringtoneboolean | stringNiefalsePočas pripájania prehrá vyzváňací tón. true pre predvolený vyzváňací tón alebo reťazec URL pre vlastný zvuk.

Príklady

Tmavá téma s vlastnou farbou

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"
    />
  )
}

Vlastná pozícia

import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'
 
function App() {
  return (
    <ThunderPhoneWidget
      publishableKey="pk_live_your_publishable_key"
      position="bottom-left"
    />
  )
}

Jazyk, hlas a kontext pre jednotlivé relácie

Vlastnosti language, voice a context sa pri začatí hovoru odovzdajú do požiadavky relácie (POST /widget/session) a pre danú reláciu prepíšu nakonfigurované predvolené hodnoty agenta. Každú používanú vlastnosť povoľte v časti Prepisovania v prehliadači pre widget na paneli (alebo v allowed_overrides kľúča). Nové widgety nepovoľujú žiadne z nich a požiadavka relácie obsahujúca nepovolenú vlastnosť zlyhá s 400 override_not_allowed; pozrite si Prepisovania v prehliadači.

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%."
    />
  )
}

Pomocou context poskytnite agentovi faktické informácie o stránke, na ktorej sa návštevník nachádza – podrobnosti o produkte, ceny alebo časté otázky špecifické pre danú stránku. Agent ho považuje za obsah stránky, nie za pokyny. Na strane servera sa skracuje na 12 000 znakov.

S obslužnými funkciami udalostí

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}`)
      }}
    />
  )
}

S vlastným štýlom

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;
}

Všetky dostupné triedy CSS a vlastné vlastnosti nájdete v príručke štýlovania.

S vyzváňacím tónom

Počas vytvárania spojenia prehrávajte zvuk zvonenia telefónu:

import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'
 
function PhoneWidget() {
  return (
    <ThunderPhoneWidget
      publishableKey="pk_live_your_publishable_key"
      ringtone={true}
    />
  )
}

Vlastný vyzváňací tón použite odovzdaním adresy URL zvukového súboru:

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

Vyzváňací tón sa opakuje, kým je widget v stave connecting, a po pripojení agenta plynulo stíchne.

S vlastnou základnou adresou API

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

Spracovanie chýb

Keď sa spustí spätné volanie onError, prijme objekt chyby s dvoma poľami:

PoleTypPopis
errorstringStrojovo čitateľný kód chyby
messagestringPoužívateľsky čitateľný popis chyby

Medzi bežné kódy chýb patria nepovolená doména, nenájdený agent a neplatný kľúč API.


Ďalšie kroky