為亞馬遜鐘聲創建網絡掛鉤 - Amazon Chime
疑難排解網路掛接錯

您必須是 Amazon Chime 系統管理員，才能完成本指南中的步驟。如果您需要 Amazon Chime 桌面用戶端、Web 應用程式或行動應用程式的相關協助，請參閱《Amazon Chime 使用者指南》中的取得支援。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

為亞馬遜鐘聲創建網絡掛鉤

Webhook 允許 Web 應用程序相互實時間進行通信。通常，Webhook 會在動作發生時傳送通知。例如，假設您經營一個在線購物網站。Webhook 可以在客戶將商品添加到購物車，支付訂單或發送評論時通知您。Webhook 不需要像傳統應用程序那樣多的編程，並且它們不會使用盡可能多的處理能力。如果沒有 webhook，程序必須經常輪詢數據才能實時獲取數據。使用 webhook，發送應用程序立即發布數據。

您建立的內送網路掛鉤可以透過程式設計方式將訊息傳送到 Amazon Chime 聊天室。例如，Webhook 可以通知客戶服務團隊有關創建新的高優先級票證的信息，並在聊天室中向票證添加鏈接。

您可以使用 Markdown 來設定 Webhooks 訊息格式，而且可包括表情符號。HTTP 連結和電子郵件地址會呈現為作用中連結。訊息也可以包含 @All 和 @Present 註釋，以分別提醒所有成員，以及呈現聊天室的成員。若要用 @ 提及聊天室參與者，可以使用他們的別名或整的電子郵件地址。例如，@alias 或 @alias@domain.com。

Webhook 只能是聊天室的一部分，無法共享。Amazon Chime 聊天室管理員可為每個聊天室新增最多 10 個網路掛鉤。

建立 Webhook 之後，您可以將其與 Amazon Chime 聊天室整合，如下列程序所示。

將網絡掛鉤與聊天室集成

  1. 從聊天室管理員那裡獲取網絡掛鉤 URL。如需詳細資訊，請參閱將網絡掛鉤添加到聊天室在亞馬遜鐘聲使用者指南。

  2. 使用您建立的指令碼或應用程式中的 webhook URL，將訊息傳送至聊天室：

    1. URL 接受 HTTP POST 要求。

    2. 亞馬遜 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"}'

      以下是一個示例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"}'

外部程式將 HTTP POST 傳送到 Webhook URL 之後，伺服器會驗證 Webhook 有效且具有指派的聊天室。這個 Webhook 會出現在聊天室名單中，且名稱旁會出現 Webhook 圖示。經 Webhook 傳送的聊天室訊息，將會列在名稱後面接著 (Webhook) 之 Webhook 其下的聊天室中。

注意

Webhook 目前並未啟用 CORS。

疑難排解網路掛接錯

以下是 Webhook 的相關錯誤清單：

  • 每個 Webhook 的傳入 Webhook 速率限制為每個聊天室各 1 TPS。調節會導致 HTTP 429 錯誤。

  • Webhook 張貼的訊息不得超過 4 KB。過大的訊息承載會導致 HTTP 413 錯誤。

  • Webhook 張貼的訊息若具有 @ 和 @ Present 註釋，只適用於 50 名成員以下的聊天室。50 名成員以上會導致 HTTP 400 錯誤。

  • 如果已重新產生 Webhook URL，使用舊的 URL 就會導致 HTTP 404 錯誤。

  • 如果聊天室中的 Webhook 已刪除，使用舊的 URL 就會導致 HTTP 404 錯誤。

  • 無效的 Webhook URL 會導致 HTTP 403 錯誤。

  • 如果服務無法使用，使用者會在回應中收到 HTTP 503 錯誤。