Developer cookbook

Ieguliet tīmekļa logrīku

Pievienojiet balss aģentu savai mārketinga vai atbalsta vietnei ar vienu skripta tagu — apmeklētāji var ar to sarunāties tieši pārlūkprogrammā, un tālruņa numurs nav nepieciešams.

Tīmekļa logrīks nodrošina jūsu vietnes apmeklētājiem sarunu ar balss aģentu, kurai var sākt ar klikšķi, izmantojot pārlūkprogrammas mikrofonu. Tā ir atsevišķa JavaScript / React SDK ar savu SDK atsauci — šajā ceļvedī galvenā uzmanība pievērsta ThunderPhone puses iestatīšanai, kas logrīkam ir nepieciešama.

Priekšnosacījumi#

1. Izveidojiet aģentu

   Aģents, kura uzvedne un balss darbosies logrīka sesijā. Iestatiet widget_enabled: true (noklusējuma vērtība).

2. Izvēlieties maršrutēšanas režīmu
   • mode="agent" — viens statisks aģents katrai atslēgai. Vienkāršākais variants.
   • mode="webhook" — jūsu serveris izvēlas aģentu katram apmeklētājam, izmantojot web.incoming tīmekļa aizķeri. Izmantojiet to pieteikušamies lietotājiem, A/B testiem vai maršrutēšanai katrai lapai.
3. Norādiet atļautos domēnus

   Publicējamās atslēgas ir piesaistītas izcelsmei. Jānorāda katrs resursdatora nosaukums, kurā tiks iegults logrīks. Vietējās izstrādes laikā localhost / 127.0.0.1 vienmēr ir atļauti.

Izveidojiet publicējamu atslēgu#

curl -X POST https://api.thunderphone.com/v1/publishable-key \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name":            "Marketing site (prod)",
    "mode":            "agent",
    "agent_id":        12,
    "allowed_domains": ["example.com", "*.example.com"]
  }'

curl -X POST https://api.thunderphone.com/v1/publishable-key \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name":            "Support (dynamic)",
    "mode":            "webhook",
    "webhook_url":     "https://example.com/thunderphone/widget-hook",
    "allowed_domains": ["support.example.com"]
  }'

Atbildē ir iekļauta key, kas sākas ar pk_live_.... Publicējamās atslēgas pēc būtības ir publiskas — tās var droši iekļaut jūsu priekšgala komplektā. Visu lauku aprakstu skatiet publicējamo atslēgu atsaucē.

Pievienojiet logrīku savai vietnei#

Trīs integrācijas iespējas ir aprakstītas logrīka SDK dokumentācijā:

Visas trīs iespējas pieņem vienu un to pašu publishableKey un atveido mikrofona pogu kopā ar audio elementu zvana laikā.

Logrīka context tiek saīsināts līdz 12 000 rakstzīmēm (aptuveni 3 400 parasta angļu teksta tokeniem) un tiek ieskaitīts uzcenojumā par uzvednes lielumu.

Logrīka režīma tīmekļa aizķeres#

Ja mode="webhook", ThunderPhone katras sesijas sākumā izsauc jūsu webhook_url ar web.incoming kravumu. Atgrieziet balss aģenta konfigurāciju, kuru vēlaties palaist konkrētajam apmeklētājam — tā izmanto to pašu atbildes shēmu kā tālruņa zvani:

{
  "prompt":  "You are a VIP concierge for Jane Doe.",
  "voice":   "john",
  "product": "storm-base",
  "tools":   [ /* per-customer tools */ ]
}

Uzvednē varat iekļaut kontekstu no savas sesijas (kuru klientu lietotājs apskata, kurā lapā viņš atrodas) un mainīt aģentus katrai ieviešanai.

Pārraugiet sesijas#

Logrīka sesijas tiek rādītas GET /v1/calls ar direction="widget" — ar tādu pašu transkriptu, ierakstu, vērtēšanu un norēķiniem kā tālruņa zvaniem. Filtrējiet pēc direction, lai izveidotu tikai logrīka informācijas paneli.

Nākamās darbības#