Amazon Chime에 사용할 웹후크 생성 - Amazon Chime

Amazon Chime 시스템 관리자만 이 안내서의 단계를 완료할 수 있습니다. Amazon Chime 데스크톱 클라이언트, 웹 앱 또는 모바일 앱과 관련하여 도움이 필요한 경우 Amazon Chime 사용 설명서지원 받기를 참조하세요.

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

Amazon Chime에 사용할 웹후크 생성

웹후크를 사용하면 웹 애플리케이션이 서로 실시간으로 통신할 수 있습니다. 일반적으로 웹후크는 작업이 발생할 때 알림을 보냅니다. 예를 들어, 온라인 쇼핑 사이트를 운영한다고 가정해 보겠습니다. 웹후크는 고객이 장바구니에 품목을 추가하거나, 주문 상품을 결제하거나, 의견을 전송할 경우 알림을 보낼 수 있습니다. 웹후크는 기존 애플리케이션만큼 많은 프로그래밍이 필요하지 않으며 처리 능력도 많이 사용하지 않습니다. 웹후크가 없으면 프로그램에서 데이터를 실시간으로 가져오기 위해 데이터를 자주 폴링해야 합니다. 웹후크가 있으면 전송 애플리케이션이 데이터를 즉시 게시합니다.

수신되는 웹후크는 프로그래밍 방식으로 Amazon Chime 채팅룸에 메시지를 전송합니다. 예를 들어 웹후크는 고객 서비스 팀에 우선순위가 높은 새로운 티켓이 생성된 것을 알리고 채팅룸에 해당 티켓에 대한 링크를 추가할 수 있습니다.

Webhook 메시지는 마크다운으로 서식 지정할 수 있으며 이모티콘을 포함할 수 있습니다. HTTP 링크와 이메일 주소는 활성 링크로 표시됩니다. 또한 메시지에 @All 및 @Present 주석을 포함시켜 모든 구성원과 현재 채팅룸 구성원에게 알림을 보낼 수 있습니다. 채팅룸 참가자를 직접 @mention하려면 별칭 또는 전체 이메일 주소를 사용하십시오. 예: @alias 또는 @alias@domain.com.

웹후크는 채팅룸에서만 사용할 수 있으며 공유할 수 없습니다. Amazon Chime 채팅룸 관리자는 각 채팅룸에 최대 10개의 웹후크를 추가할 수 있습니다.

웹후크를 생성한 후에는 다음 절차에 나온 것처럼 Amazon Chime 채팅룸에 웹후크를 통합할 수 있습니다.

웹후크를 채팅룸에 통합하려면
  1. 채팅룸 관리자에게서 웹후크 URL을 얻습니다. 자세한 내용은 Amazon Chime 사용 설명서채팅룸에 웹후크 추가를 참조하세요.

  2. 생성한 스크립트 또는 애플리케이션의 웹후크 URL을 사용하여 채팅룸에 메시지를 전송합니다.

    1. URL은 HTTP POST 요청을 수락합니다.

    2. Amazon Chime 웹후크는 JSON 페이로드와 단일 키 콘텐츠를 수락합니다. 다음은 curl 명령과 페이로드의 예입니다.

      curl -X POST "<Insert your webhook URL here>" -H "Content-Type:application/json" --data '{"Content":"Message Body emoji test: :) :+1: link test: http://sample.com email test: marymajor@example.com All member callout: @All All Present member callout: @Present"}'

      다음은 Windows 사용자를 위한 예제 PowerShell 명령입니다.

      Invoke-WebRequest -Uri '<Insert your webhook URL here>' -Method 'Post' -ContentType 'application/JSON' -Body '{"Content":"Message Body emoji test: :) :+1: link test: http://sample.com email test: marymajor@example.com All member callout: @All All Present member callout: @Present"}'

외부 프로그램이 Webhook URL로 HTTP POST를 보내면 서버는 Webhook이 유효하며 할당된 채팅룸이 있는지 확인합니다. Webhook은 webhook 명단에 이름 옆에 있는 webhook 아이콘으로 표시됩니다. Webhook에 전송된 채팅룸 메시지는 (Webhook)라는 이름으로 채팅룸에 표시됩니다.

참고

CORS는 현재 Webhook에 대해 활성화되어 있지 않습니다.

웹후크 오류 해결

다음은 Webhook 관련 오류 목록입니다.

  • 각 Webhook의 수신 Webhook 속도 한도는 채팅룸당 1TPS입니다. 조절(throttling)을 수행하면 HTTP 429 오류가 발생합니다.

  • Webhook이 게시하는 메시지는 4KB 미만이어야 합니다. 메시지 페이로드가 이보다 크면 HTTP 413 오류가 발생합니다.

  • @All and @Present 주석을 포함하는 Webhook에 의해 게시된 메시지는 멤버가 50명 이하인 채팅룸에서만 작동합니다. 멤버가 50명을 초과하면 HTTP 400 오류가 발생합니다.

  • Webhook URL이 다시 생성된 경우 이전 URL을 사용하면 HTTP 404 오류가 발생합니다.

  • 채팅룸의 Webhook URL이 삭제된 경우 이전 URL을 사용하면 HTTP 404 오류가 발생합니다.

  • Webhook URL이 유효하지 않으면 HTTP 403 오류가 발생합니다.

  • 서비스를 사용할 수 없는 경우 사용자는 응답에 HTTP 503 오류를 받습니다.