채팅 API 플랫폼용 웹훅

웹훅을 사용하면 채팅 세션 중에 관련 이벤트가 발생할 때마다(예: 채팅이 생성되거나, 메시지가 수신되거나, 채팅이 트랜스퍼되거나 에스컬레이션되는 경우) 앱 API가 애플리케이션에 실시간 알림을 전송합니다. API를 폴링하는 대신 웹훅을 사용하여 채팅 활동이 발생할 때 이에 반응합니다.

웹훅은 앱 API의 채팅 세션으로 범위가 지정됩니다. Contact Center AI Platform은 지원되는 모든 앱 API 채팅 웹훅 이벤트를 구성한 단일 웹훅 URL에 HTTP POST 요청으로 전송합니다. 이벤트별 구독이 없습니다.

시작하기 전에

  • 웹훅을 구성하려면 관리자이거나 개발자 설정을 수정할 수 있는 권한이 있는 역할이 있어야 합니다.
  • HTTP POST 요청을 수신할 수 있는 엔드포인트를 준비합니다. 웹훅 URL은 HTTPS를 사용해야 합니다.

웹훅 사용 설정

웹훅을 사용 설정하면 Contact Center AI Platform에서 구성된 URL로 웹훅 이벤트를 전송하고 URL 및 비밀 필드가 표시됩니다. 웹훅이 사용 중지되면 이벤트가 전송되지 않습니다.

웹훅을 사용 설정하려면 다음 단계를 따르세요.

  1. CCAI Platform 포털에서 설정 > 개발자 설정을 클릭합니다. 설정 메뉴가 표시되지 않으면 메뉴를 클릭합니다.
  2. 웹훅 창으로 이동한 다음 웹훅 전환 버튼을 사용 설정으로 클릭합니다.

웹훅 URL 구성

  1. URL에 웹훅 엔드포인트를 입력합니다.
  2. 엔드포인트가 HTTPS를 사용하고 POST 요청을 수신할 수 있는지 확인합니다. Contact Center AI Platform은 지원되는 모든 이벤트를 이 단일 URL로 전송합니다.

서명 보안 비밀 생성

Contact Center AI Platform은 모든 웹훅 요청에 서명하므로 애플리케이션에서 요청이 Contact Center AI Platform에서 전송되었는지 확인할 수 있습니다. 서명은 X-Signature 요청 헤더로 전송되고 서명 타임스탬프는 X-Signature-Timestamp로 전송됩니다. 최대 2개의 서명 보안 비밀을 구성할 수 있습니다.

  • 기본 보안 비밀: 웹훅 요청에 서명하는 데 사용되는 기본 토큰입니다.
  • 보조 보안 비밀: 선택사항인 두 번째 토큰입니다. 보조 비밀번호가 설정되면 Contact Center AI Platform은 두 비밀번호로 각 요청에 서명하므로 이벤트를 놓치지 않고 비밀번호를 순환할 수 있습니다.

각 보안 비밀을 별도로 생성합니다. 보안 비밀을 생성하려면 다음 단계를 따르세요.

  1. CCAI Platform 포털에서 설정 > 개발자 설정을 클릭합니다. 설정 메뉴가 표시되지 않으면 메뉴를 클릭합니다.
  2. 웹훅 창으로 이동합니다.
  3. 기본 보안 비밀 섹션에서 생성을 클릭합니다. 복사를 클릭하여 보안 비밀을 복사하고 안전하게 저장합니다. 전체 보안 비밀은 생성 직후에만 표시됩니다. 이후에는 마스킹됩니다.
  4. 선택사항: 보조 보안 비밀 섹션에서 생성을 클릭합니다. 복사를 클릭하여 보안 비밀을 복사하고 안전하게 저장합니다.
  5. 경고 대화상자에서 확인합니다. 새 보안 비밀은 즉시 적용되므로 대체된 보안 비밀을 계속 사용하는 항목은 실패합니다.

서명 보안 비밀 순환

기본 보안 비밀이 있으면 보안 비밀 순환 작업을 사용할 수 있습니다. 보안 비밀을 주기적으로 순환하는 것이 보안 권장사항입니다. Contact Center AI Platform은 기본 및 보조 비밀번호로 각 요청에 서명하므로 전송을 중단하지 않고도 순환할 수 있습니다.

  1. CCAI Platform 포털에서 설정 > 개발자 설정을 클릭합니다. 설정 메뉴가 표시되지 않으면 메뉴를 클릭합니다.
  2. 기본 보안 비밀과 보조 보안 비밀이 모두 설정되어 있는지 확인합니다.
  3. Rotate Secrets(시크릿 순환)을 클릭하여 기본 시크릿과 보조 시크릿을 바꿉니다.
  4. 새 활성 보안 비밀에 대해 서명을 확인하도록 애플리케이션을 업데이트합니다. 중복 기간 동안 Contact Center AI Platform은 구성된 두 비밀번호로 각 요청에 서명하므로 둘 중 하나를 수락하면 전송이 중단되지 않습니다.

구성 저장

저장을 선택하여 웹훅의 사용 설정 상태와 URL을 적용합니다. 보안 비밀을 생성하거나 순환하면 즉시 적용되며 저장 작업이 필요하지 않습니다. 웹훅이 사용 설정되고 웹훅 URL과 기본 비밀이 설정되면 Contact Center AI Platform에서 이벤트 전송을 시작합니다.

애플리케이션에서 수신하는 항목

웹훅을 사용 설정하면 Contact Center AI Platform에서 수명 주기 변경, 참여자 활동, 메시지, 트랜스퍼, 에스컬레이션, 웹 양식, 해고 경고와 같은 지원되는 각 채팅 이벤트에 대해 HTTP POST 요청을 보냅니다. 각 요청 본문은 event_type, timestamp, chat_id, 이벤트별 body이 포함된 JSON 봉투입니다.