Open in
React komponentas
Įterpkite ThunderPhone balso valdiklį į React programą
Komponentas ThunderPhoneWidget pateikia stiklo efekto skambučių juostą su integruotais nutildymo, skambučio baigimo ir ryšio būsenos rodymo valdikliais. Tai greičiausias būdas pridėti balso DI prie React programos.
Diegimas
npm install @thunderphone/widgetPagrindinis naudojimas
import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'
function App() {
return (
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
/>
)
}Savybės
Komponentas priima šias savybes per ThunderPhoneWidgetProps:
| Rekvizitas | Tipas | Privalomas | Numatytoji reikšmė | Aprašymas |
|---|---|---|---|---|
publishableKey | string | Taip | -- | Viešinamas API raktas (pk_live_...) iš valdymo skydelio skilties Žiniatinklio valdikliai. Agentas automatiškai nustatomas pagal rakto valdiklio konfigūraciją. |
theme | 'light' | 'dark' | Ne | 'light' | Spalvų schema. Valdiklio šakniniam elementui pritaiko tp--light arba tp--dark klasę. |
primaryColor | string | Ne | '#000000' (šviesi) / '#ffffff' (tamsi) | CSS spalvos eilutė, naudojama kaip akcento spalva (skambinimo mygtukui, bangos formai, aktyviems indikatoriams). |
title | string | Ne | 'Voice assistant' | Valdiklio juostoje rodomas tekstas. |
position | 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left' | Ne | 'bottom-right' | Fiksuota valdiklio padėtis peržiūros srityje. |
apiBase | string | Ne | 'https://api.thunderphone.com/v1' | API bazinio URL nepaisymo reikšmė. |
language | string | Ne | -- | Kalbos nepaisymo reikšmė vienai sesijai – kalbos kodas arba lokalė, pvz., en, es arba fr-FR. Jei nenustatyta, taikoma sukonfigūruota agento kalba. Reikia language rakto naršyklės nepaisymo nustatymuose. |
voice | string | Ne | -- | Balso nepaisymo reikšmė vienai sesijai – balso pavadinimas, pvz., maria. Jei nenustatyta, taikomas sukonfigūruotas agento balsas. Reikia voice rakto naršyklės nepaisymo nustatymuose. |
context | string | Ne | -- | Agentui perduodamas faktinis puslapio arba svetainės kontekstas vienai sesijai (pvz., puslapio, kurį lankytojas peržiūri, informacija). Serverio pusėje sutrumpinamas iki 12 000 simbolių. Reikia context rakto naršyklės nepaisymo nustatymuose. |
onConnect | () => void | Ne | -- | Iškviečiama, kai balso sesija sėkmingai prisijungia. |
onDisconnect | () => void | Ne | -- | Iškviečiama, kai sesija baigiasi. |
onError | (error) => void | Ne | -- | Iškviečiama įvykus klaidoms. Objekte error yra laukai error (kodas) ir message. |
className | string | Ne | -- | Papildomas CSS klasės pavadinimas, pritaikomas valdiklio konteineriui. |
ringtone | boolean | string | Ne | false | Prisijungiant groti skambėjimo toną. true – numatytajam skambėjimo tonui, arba URL eilutė pasirinktiniam garsui. |
Pavyzdžiai
Tamsi tema su pasirinkta spalva
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"
/>
)
}Pasirinkta pozicija
import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'
function App() {
return (
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
position="bottom-left"
/>
)
}Kalba, balsas ir kontekstas kiekvienai sesijai
language, voice ir context rekvizitai, prasidėjus skambučiui, perduodami į sesijos užklausą (POST /widget/session) ir tai sesijai pakeičia sukonfigūruotus agento numatytuosius nustatymus. Valdymo skydelyje įjunkite kiekvieną naudojamą rekvizitą valdiklio skiltyje Naršyklės pakeitimai (arba rakto allowed_overrides). Nauji valdikliai nepriima nė vieno, o sesijos užklausa, kurioje perduodamas išjungtas rekvizitas, nepavyksta su 400 override_not_allowed; žr. Naršyklės pakeitimai.
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%."
/>
)
}Naudokite context, kad suteiktumėte agentui faktinių žinių apie puslapį, kuriame lankosi lankytojas – informaciją apie produktą, kainodarą arba konkretaus puslapio DUK. Agentas tai laiko puslapio turiniu, o ne instrukcijomis. Serverio pusėje jis sutrumpinamas iki 12 000 simbolių.
Su įvykių atgaliniais iškvietimais
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}`)
}}
/>
)
}Su pasirinktu stiliumi
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;
}Visas galimas CSS klases ir tinkintas savybes rasite stiliaus vadove.
Su skambėjimo tonu
Kol nustatomas ryšys, leiskite telefono skambėjimo garsą:
import { ThunderPhoneWidget } from '@thunderphone/widget'
import '@thunderphone/widget/style.css'
function PhoneWidget() {
return (
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
ringtone={true}
/>
)
}Naudokite pasirinktą skambėjimo toną, perduodami garso failo URL:
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
ringtone="https://example.com/my-ringtone.mp3"
/>Skambėjimo tonas kartojamas, kol valdiklio būsena yra connecting, ir sklandžiai nutyla, kai prisijungia agentas.
Su pasirinkta API baze
<ThunderPhoneWidget
publishableKey="pk_live_your_publishable_key"
apiBase="https://your-proxy.example.com/v1"
/>Klaidų tvarkymas
Suveikus onError atgaliniam iškvietimui, jis gauna klaidos objektą su dviem laukais:
| Laukas | Tipas | Aprašas |
|---|---|---|
error | string | Kompiuterio skaitomas klaidos kodas |
message | string | Žmogui suprantamas klaidos aprašas |
Dažniausi klaidų kodai apima neleidžiamą domeną, nerastą agentą ir netinkamą API raktą.