도움말 위젯 API를 사용한 고급 구성

수정일 일요일, 9 3월 시간: 2:28 PM

위젯 API를 사용하여 헬프 위젯의 기능을 수정할 수 있습니다. 이 문서에서는 유용할 수 있는 구체적인 사용 사례에 대해 설명합니다.

이 문서는 Freshdesk 도움말 위젯에 대한 3편 중 2부입니다:

이 문서에는 다음이 포함되어 있습니다:

위젯 가시성 제어
폼 제어

가능한 전체 범위를 탐색하려면 위젯 API 문서를 참조하세요.

도움 위젯을 숨기고 특정 상황에서만 표시하는 사용 사례를 생각해 보세요. 예를 들어 사용자가 버튼이나 링크를 클릭하면 위젯이 특정 솔루션 문서나 문의 양식을 표시합니다. 설정하려면 다음과 같이 하세요.

Hide API를 사용하여 모든 페이지에서 위젯 런처를 숨깁니다.
특정 페이지에 버튼을 만들고 JavaScript 함수를 매핑합니다.
자바스크립트 함수에서 Open API 를 사용하여 문의 양식 또는 솔루션 문서를 엽니다.

런처 매개변수와 함께 Hide API 를 사용하여 위젯 런처를 숨길 수 있습니다. 이 예에서는 페이지의 HTML 본문이 로드될 때 API 호출이 이루어집니다.

<body onload="FreshworksWidget('hide', 'launcher');">

위젯을 숨기든 숨기지 않든, Open API>를 사용하여 문의 양식이나 솔루션 문서를 표시할 수 있습니다. 위젯 임베드 코드 위에 함수를 배치해야 합니다.

<button onclick="openWidget()" type="button"<위젯 열기</button>
<button onclick="openWidgetForm()" type="button"<양식 열기</button<
<button onclick="openWidgetArticle()" type="button"<기사 열기</button>

<스크립트>
   /* 이 함수는 위젯을 기본 상태로 엽니다. */
   function openWidget() {
      FreshworksWidget('open');
   }

   /* 이 함수는 문의 양식을 바로 엽니다. */
   function openWidgetForm() {
      FreshworksWidget('open', 'ticketForm');
   }

   /* 이 함수는 ID가 123인 솔루션 문서를 바로 엽니다. */
   함수 openWidgetArticle() {
      FreshworksWidget('open', 'article', { id: 123 });
   }

   /* 위젯 임베드 코드를 마지막에 넣으세요. */
   ...
</script>

양식 제어

문의 양식에 많은 필드가 있는 경우 웹사이트 경험에 따라 이를 큐레이션하고 싶을 때가 있습니다. 예를 들어 일부 필드를 숨기거나 비활성화하고 다른 필드를 미리 채울 수 있습니다.

고객이 이미 웹사이트에 로그인한 경우 Identify API>는 고객의 이름과 이메일 주소를 가져와 문의 양식을 채웁니다. 이름과 이메일을 저장하는 데 사용하는 변수를 사용하세요.

Prefill API 를 사용하면 모든 필드를 채울 수 있습니다. 양식의 필드를 회색으로 표시하거나 고객에게 표시하지 않으려면 티켓 필드 비활성화 API와 함께 사용하거나 티켓 필드 숨기기 API와 함께 사용할 수 있습니다. 필수 필드를 비활성화하거나 숨기면 반드시 미리 채워야 합니다.

/* 식별 API는 문의 양식에 고객에 대한 세부 정보를 미리 채웁니다 */
FreshworksWidget('identify', 'ticketForm', {
    이름: 변수 이름,
    email: VariableEmail,
});

/* 프리필 API를 사용하면 양식의 모든 필드에 값을 설정할 수 있습니다 */
FreshworksWidget('prefill', 'ticketForm', {
    subject: '백설공주 티셔츠 문의'
});

/* 티켓 필드 숨기기 API는 문의 양식의 필드를 제거합니다 */
FreshworksWidget('hide', 'ticketForm', ['subject'])

/* 티켓 필드 비활성화 API는 문의 양식의 필드를 편집하지 못하도록 합니다 */
FreshworksWidget('disable', 'ticketForm', ['subject'])

추가 도움말은 위젯 API 문서를 참조하거나 [email protected]로 문의하세요.

도움말 위젯 API를 사용한 고급 구성

위젯 가시성 제어

양식 제어