webhook đến cho phép bạn gửi tin nhắn không đồng bộ đến Google Chat từ các ứng dụng không phải là ứng dụng Chat. Ví dụ: bạn có thể định cấu hình ứng dụng giám sát để thông báo cho nhân viên gọi điện trên Google Chat khi máy chủ bị lỗi.
Để gửi, cập nhật hoặc xoá tin nhắn trong phòng Chat một cách không đồng bộ bằng ứng dụng Chat, hãy xem phần Tạo, đọc, cập nhật, xoá tin nhắn.
Điều kiện tiên quyết
Để chạy ví dụ trong hướng dẫn này, bạn cần:
Python
- Python 3.10.7 trở lên.
- Quyền truy cập vào Internet và trình duyệt web.
- Tài khoản Google Workspace có quyền truy cập vào Google Chat.
- Một phòng Google Chat hiện có.
Thư viện
httplib2
. Nếu cần, hãy chạy lệnh giao diện dòng lệnh (CLI) sau để cài đặt thư viện bằng pip:pip install httplib2
Node.js
- Đã cài đặt Node.js và npm.
- Quyền truy cập vào Internet và trình duyệt web.
- Tài khoản Google Workspace có quyền truy cập vào Google Chat.
- Một phòng Google Chat hiện có.
Apps Script
- Quyền truy cập vào Internet và trình duyệt web.
- Tài khoản Google Workspace có quyền truy cập vào Google Chat.
- Một phòng Google Chat hiện có.
Java
- Java 11 trở lên.
- Apache Maven
- Quyền truy cập vào Internet và trình duyệt web.
- Tài khoản Google Workspace có quyền truy cập vào Google Chat.
- Một phòng Google Chat hiện có.
Tạo webhook
Để tạo webhook, hãy đăng ký không gian đó trong phòng Google Chat mà bạn muốn nhận tin nhắn, sau đó viết tập lệnh gửi tin nhắn.
Bước 1: Đăng ký webhook đến
- Mở Google Chat trong trình duyệt web.
- Chuyển đến không gian mà bạn muốn thêm webhook.
- Ở trên cùng, bên cạnh tiêu đề không gian, hãy nhấp vào biểu tượng Mũi tên xuống
Quản lý webhook.
> - Nếu không gian này đã có webhook khác, hãy nhấp vào Thêm webhook khác. Nếu không, hãy bỏ qua bước này.
- Đối với Tên, hãy nhập "Quickstart Webhook".
- Đối với URL hình đại diện, hãy nhập
https://developers.google.com/chat/images/chat-product-icon.png
. - Nhấp vào LƯU.
- Nhấp vào Sao chép để sao chép URL webhook đầy đủ.
- Nhấp vào bên ngoài hộp để đóng hộp thoại webhook đến.
Bước 2: Viết tập lệnh webhook
Tập lệnh webhook mẫu sẽ đăng một thông báo lên không gian mà webhook đăng ký bằng cách POST yêu cầu tạo thông báo cho URL webhook đó. API Google Chat phản hồi bằng một phiên bản của Message
.
Chọn một ngôn ngữ dưới đây để biết hướng dẫn cụ thể về cách tạo tập lệnh webhook:
Python
Trong thư mục đang hoạt động, hãy tạo một tệp có tên là
quickstart.py
.Trong
quickstart.py
, hãy sao chép và dán mã sau:Thay thế giá trị cho biến
url
bằng URL webhook bạn đã sao chép ở Bước 1: Đăng ký webhook đến.
Node.js
Trong thư mục đang hoạt động, hãy tạo một tệp có tên là
index.js
.Trong
index.js
, hãy sao chép và dán mã sau:Thay thế giá trị cho biến
webhookURL
bằng URL webhook bạn đã sao chép ở Bước 1: Đăng ký webhook đến.
Apps Script
Truy cập vào trang Apps Script.
Nhấp vào Dự án mới.
Sao chép và dán mã sau:
Thay thế giá trị cho biến
url
bằng URL webhook bạn đã sao chép ở Bước 1: Đăng ký webhook đến.
Java
Trong thư mục đang hoạt động, hãy tạo một tệp có tên là
pom.xml
.Trong
pom.xml
, hãy sao chép và dán nội dung sau:Trong thư mục đang hoạt động, hãy tạo cấu trúc thư mục sau
src/main/java
.Trong thư mục
src/main/java
, hãy tạo một tệp có tên làApp.java
.Trong
App.java
, hãy sao chép và dán mã sau:Thay thế giá trị cho biến
URL
bằng URL webhook bạn đã sao chép ở Bước 1: Đăng ký webhook đến.
Bước 3: Chạy tập lệnh webhook
Chạy mẫu bằng cách chạy lệnh sau trong thư mục làm việc trong CLI:
Python
python3 quickstart.py
Node.js
node index.js
Apps Script
- Nhấp vào Chạy
Java
mvn compile exec:java -Dexec.mainClass=App
Khi bạn chạy mã mẫu, webhook sẽ gửi thông báo đến không gian mà bạn đã đăng ký.
Bắt đầu hoặc trả lời chuỗi tin nhắn
Bạn có thể bắt đầu chuỗi tin nhắn hoặc trả lời một chuỗi tin nhắn bằng cách thêm thông số threadKey
vào URL webhook. Mỗi threadKey
là duy nhất đối với ứng dụng đặt giá trị này. Nếu hai ứng dụng Chat hoặc webhook khác nhau đặt cùng một threadKey
, thì 2 luồng khác nhau sẽ bắt đầu.
Bắt đầu chuỗi tin nhắn
Để đăng thông báo đầu tiên của một chuỗi có webhook, hãy thêm tham số threadKey
vào URL webhook. Đặt threadKey
thành một chuỗi tuỳ ý, nhưng hãy nhớ nội dung của chuỗi đó; bạn sẽ cần chỉ định lại chuỗi đó để đăng câu trả lời cho chuỗi.
https://chat.googleapis.com/v1/spaces/SPACE_ID/messages?threadKey=ARBITRARY_STRING
Trả lời chuỗi tin nhắn
Để gửi tin nhắn đến một chuỗi tin nhắn hiện có, hãy thêm tham số threadKey
vào URL webhook đã đặt thành giá trị dùng để bắt đầu chuỗi. Ví dụ: gửi một tin nhắn đến URL theo dõi sẽ đăng câu trả lời lên chuỗi trong đó threadKey
là MY-THREAD
:
https://chat.googleapis.com/v1/spaces/SPACE_ID/messages?threadKey=MY-THREAD
Các giới hạn và yếu tố cần cân nhắc
Khi bạn định cấu hình webhook, hãy lưu ý các giới hạn và lưu ý sau:
Mỗi webhook chỉ hoạt động trong phòng Chat mà bạn đã đăng ký.
Bạn không thể xuất bản webhook trên Google Workspace Marketplace.
Webhook không trò chuyện được. Họ không thể trả lời hoặc nhận tin nhắn từ người dùng hoặc sự kiện từ Google Chat.
Nếu chỉ chọn đơn vị tổ chức (OU) trong miền của bạn đã bật các ứng dụng Chat, các webhook sẽ xuất hiện trong kết quả sau:
{ "error": { "code": 403, "message": "The caller does not have permission", "status": "PERMISSION_DENIED" } }
Webhook đến chỉ hoạt động trong tin nhắn trực tiếp, nhưng chỉ khi tất cả người dùng đã bật ứng dụng Chat.
Vì
Quản lý webhook chỉ có trên trình duyệt web, nên bạn phải thiết lập webhook từ ứng dụng web Chat. Webhook không thể định cấu hình trong ứng dụng Chat dành cho thiết bị di động.