InteractiveCanvas (Dialogflow)

شی interactiveCanvas رابطی برای کنش مکالمه شما است که در برنامه وب شما در دسترس است.

روش ها

آماده

ready(callbacks) returns undefined

برنامه وب Interactive Canvas پس از بارگیری برای ثبت تماس‌های برگشتی، با آن تماس گرفته می‌شود.

پارامترها
callbacks InteractiveCanvasCallbacks

یک شی که حاوی فراخوانی متد است.

sendTextQuery

sendTextQuery(textQuery) returns Promise<state>

یک درخواست متنی به عمل مکالمه ارسال می کند.

پارامترها
textQuery string

پرس و جو برای ارسال به کنش مکالمه.

state string

یکی از موارد زیر:

READY: درخواست ها می توانند توسط پلت فرم پذیرفته شوند.

BLOCKED: یک پرس و جو در حال پرواز است و درخواست جدید حذف خواهد شد.

UNKNOWN: وضعیت درخواست فعلی را نمی توان تعیین کرد.

getHeaderHeightPx

getHeaderHeightPx() returns Promise<height>

ارتفاع هدر بالای صفحه نمایش را تعیین می کند.

پارامترها
height number

ارتفاع بر حسب پیکسل

InteractiveCanvasCallbacks

این تماس‌های برگشتی راهی را برای شما فراهم می‌کنند تا به اطلاعات یا درخواست‌های مربوط به کنش مکالمه‌تان پاسخ دهید، در حالی که روش‌ها راهی برای ارسال اطلاعات یا درخواست‌ها به کنش مکالمه‌تان ارائه می‌کنند.

در به روز رسانی

onUpdate(data) returns undefined

هنگامی که یک HtmlResponse از کنش مکالمه ارسال می شود، فراخوانی می شود. پس از پایان فراخوانی تابع، TTS بلافاصله شروع می شود.

پارامترها
data Object

داده های به روز شده ارسال شده توسط وب هوک.

onTtsMark

onTtsMark(markName) returns undefined

پاسخ به تماس که در حین پخش TTS فراخوانی می شود.

علائم ویژه ای که همیشه فعال می شوند:

  • START شروع TTS را نشان می دهد.
  • END پایان TTS را نشان می دهد.
  • ERROR نشان دهنده خطا در پخش TTS است.

همچنین می‌توانید علامت‌های سفارشی را با استفاده از SSML و تگ <mark> ، مانند <mark name="custom"/> تعریف کنید.

پارامترها
markName string

علامت گذاری نام در حین پخش TTS.