Amazon Chime 用のウェブフックの作成 - Amazon Chime
ウェブフックに関連するエラーのトラブルシューティング

このガイドのステップを完了するには、Amazon Chime システム管理者である必要があります。Amazon Chime デスクトップクライアント、ウェブアプリケーション、またはモバイルアプリに関するヘルプが必要な場合は、「Amazon Chime ユーザーガイド」の「Getting support」を参照してください。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Amazon Chime 用のウェブフックの作成

ウェブフックを使用すると、ウェブアプリケーションはリアルタイムで相互に通信できます。通常、ウェブフックはアクションが発生すると通知を送信します。例えば、オンラインショッピングサイトを運営しているとします。ウェブフックは、顧客がショッピングカートに商品を追加したり、注文の支払いをしたり、コメントを送信したりしたときに通知を送信できます。ウェブフックは従来のアプリケーションほどプログラミングを必要とせず、処理能力もそれほど消費しません。ウェブフックを使用しない場合、プログラムはデータをリアルタイムで取得するために頻繁にデータをポーリングする必要があります。ウェブフックを使用する場合は、送信側アプリケーションがデータを即座に送信します。

着信ウェブフックは、プログラムによって Amazon Chime チャットルームにメッセージを送信できます。例えば、ウェブフックは新しい高優先度チケットの作成についてカスタマーサービスチームに通知を送信し、チケットへのリンクをチャットルームに追加できます。

ウェブフックメッセージは、マークダウンを使用してフォーマットすることができます。また、絵文字を含めることもできます。HTTP リンクや E メールアドレスは、アクティブなリンクとしてレンダリングされます。メッセージに @All や @Present と注釈を入れ、チャットルームのすべてのメンバーや現在のメンバーにそれぞれアラートを出すこともできます。チャットルーム参加者を直接 @mention するには、エイリアスまたは完全な電子メールアドレスを使用します。たとえば、@alias や @alias@domain.com などです。

ウェブフックはチャットルームの一部であり、共有することはできません。Amazon Chime のチャットルーム管理者は、チャットルームに最大 10 個のウェブフックを追加することができます。

ウェブフックを作成したら、次に示す手順に従って Amazon Chime チャットルームと統合できます。

ウェブフックとチャットルームを統合するには

  1. チャットルーム管理者からウェブフック URL を入手します。詳細については、「Amazon Chime ユーザーガイド」の「Adding webhooks to a chat room」を参照してください。

  2. 作成したスクリプトまたはアプリケーションのウェブフック URL を使用して、チャットルームにメッセージを送信します。

    1. この URL を使用して、HTTP POST リクエストを受け取ります。

    2. 単一キーの [コンテンツ] を含む JSON ペイロードが Amazon Chime ウェブフックに送信されます。以下は、サンプルペイロードを含むサンプル 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 ごとの Incoming Webhook のレート制限は、1 TPS です。スロットリングの場合は、HTTP 429 エラーが返ります。

  • webhook で投稿されるメッセージは、4 KB 以下である必要があります。メッセージのペイロードサイズがこのサイズを超えると、HTTP 413 エラーが返ります。

  • @All や @Present と注釈を入れた webhook で投稿されたメッセージは、メンバーが 50 人以下のチャットルームに対してのみ有効です。メンバーが 50 人を超える場合、HTTP 400 エラーが返ります。

  • webhook URL が再生成されている場合は、古い URL を使用すると、HTTP 404 エラーが返ります。

  • ルームの webhook が削除されている場合は、古い URL を使用すると、HTTP 404 エラーが返ります。

  • webhook URL が無効な場合は、HTTP 403 エラーが返ります。

  • サービスが利用できない場合は、レスポンスとして HTTP 503 エラーが送信されます。