Tạo ứng dụng Google Chat làm webhook

Trang này mô tả cách thiết lập webhook để gửi tin nhắn không đồng bộ đến Phòng Chat sử dụng các điều kiện kích hoạt bên ngoài. 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 trực tiếp về Trò chuyện khi máy chủ ngừng hoạt động. Để gửi một thông báo đồng bộ bằng ứng dụng Chat, hãy xem Gửi tin nhắn.

Với loại kiến trúc này thiết kế của bạn, người dùng không thể tương tác với webhook hoặc webhook được kết nối vì giao tiếp mang tính một chiều. Webhook không mang tính trò chuyện. Họ sẽ không thể trả lời hoặc nhận tin nhắn từ người dùng hoặc Sự kiện tương tác với ứng dụng Chat. Cách trả lời tin nhắn: tạo ứng dụng trong Chat thay vì webhook.

Mặc dù webhook không phải về kỹ thuật ứng dụng Chat – webhook kết nối các ứng dụng bằng Yêu cầu HTTP (trang này gọi đây là một ứng dụng Chat để để đơn giản hoá. Mỗi webhook chỉ hoạt động trong phòng Chat ở đã được đăng ký. Webhook đến hoạt động trong tin nhắn trực tiếp, nhưng chỉ khi tất cả người dùng có Đã bật các ứng dụng trong Chat. Bạn không thể xuất bản webhook lên Google Workspace Marketplace.

Sơ đồ dưới đây cho thấy cấu trúc của một webhook được kết nối với Trò chuyện:

Cấu trúc của các webhook đến để gửi tin nhắn không đồng bộ đến Chat.

Trong sơ đồ trên, ứng dụng Chat có những thành phần sau luồng thông tin:

  1. Logic của ứng dụng Chat sẽ nhận thông tin từ dịch vụ bên ngoài của bên thứ ba, chẳng hạn như hệ thống quản lý dự án hoặc công cụ bán vé.
  2. Logic của ứng dụng Chat được lưu trữ trên đám mây hoặc hệ thống tại chỗ có thể gửi tin nhắn bằng cách sử dụng URL webhook đến phòng Chat cụ thể.
  3. Người dùng có thể nhận tin nhắn từ ứng dụng Chat trong phòng Chat cụ thể đó, nhưng không thể tương tác với Ứng dụng Chat.

Điều kiện tiên quyết

Python

Node.js

Java

Apps Script

Tạo webhook

Để tạo một webhook, hãy đăng ký webhook đó trong phòng Chat mà bạn muốn để nhận thông báo rồi viết một tập lệnh để gửi thông báo.

Đăng ký webhook đến

  1. Trong trình duyệt, hãy mở Trò chuyện. Bạn không thể định cấu hình webhook bằng ứng dụng Chat dành cho thiết bị di động.
  2. Chuyển đến không gian mà bạn muốn thêm webhook.
  3. Bên cạnh tiêu đề không gian, hãy nhấp vào mũi tên mở rộng, sau đó nhấp vào Ứng dụng & tích hợp.

  4. Nhấp vào Thêm webhook.

  5. Trong trường Name (Tên), hãy nhập Quickstart Webhook.

  6. Trong trường URL hình đại diện, nhập https://developers.google.com/chat/images/chat-product-icon.png.

  7. Nhấp vào Lưu.

  8. Để sao chép URL webhook, hãy nhấp vào Lựa chọn khác, rồi nhấp vào Sao chép đường liên kết.

Viết tập lệnh webhook

Tập lệnh webhook mẫu sẽ gửi thông báo đến không gian có webhook đã đăng ký bằng cách gửi yêu cầu POST đến URL webhook. Chiến lược phát hành đĩa đơn API Chat phản hồi bằng một phiên bản của Message.

Chọn một ngôn ngữ để tìm hiểu cách tạo tập lệnh webhook:

Python

  1. Trong thư mục đang làm việc, hãy tạo một tệp có tên quickstart.py.

  2. Trong quickstart.py, hãy dán mã sau:

    python/webhook/quickstart.py
    from json import dumps
from httplib2 import Http

# Copy the webhook URL from the Chat space where the webhook is registered.
# The values for SPACE_ID, KEY, and TOKEN are set by Chat, and are included
# when you copy the webhook URL.

def main():
    """Google Chat incoming webhook quickstart."""
    url = "https://chat.googleapis.com/v1/spaces/SPACE_ID/messages?key=KEY&token=TOKEN"
    app_message = {"text": "Hello from a Python script!"}
    message_headers = {"Content-Type": "application/json; charset=UTF-8"}
    http_obj = Http()
    response = http_obj.request(
        uri=url,
        method="POST",
        headers=message_headers,
        body=dumps(app_message),
    )
    print(response)


if __name__ == "__main__":
    main()

  3. Thay thế giá trị cho biến url bằng URL webhook bạn đã sao chép khi đăng ký webhook.

Node.js

  1. Trong thư mục đang làm việc, hãy tạo một tệp có tên index.js.

  2. Trong index.js, hãy dán mã sau:

    node/webhook/index.js
    /**
 * Sends asynchronous message to Google Chat
 * @return {Object} response
 */
async function webhook() {
  const url = "https://chat.googleapis.com/v1/spaces/SPACE_ID/messages"
  const res = await fetch(url, {
    method: "POST",
    headers: {"Content-Type": "application/json; charset=UTF-8"},
    body: JSON.stringify({text: "Hello from a Node script!"})
  });
  return await res.json();
}

webhook().then(res => console.log(res));

  3. Thay thế giá trị cho biến url bằng URL webhook bạn đã sao chép khi đăng ký webhook.

Java

  1. Trong thư mục đang làm việc, hãy tạo một tệp có tên pom.xml.

  2. Trong pom.xml, hãy sao chép và dán nội dung sau:

    java/webhook/pom.xml
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.google.chat.webhook</groupId>
  <artifactId>java-webhook-app</artifactId>
  <version>0.1.0</version>

  <name>java-webhook-app</name>
  <url>https://github.com/googleworkspace/google-chat-samples/tree/main/java/webhook</url>

  <properties>
    <maven.compiler.target>11</maven.compiler.target>
    <maven.compiler.source>11</maven.compiler.source>
  </properties>

  <dependencies>
    <dependency>
        <groupId>com.google.code.gson</groupId>
        <artifactId>gson</artifactId>
        <version>2.9.1</version>
    </dependency>
  </dependencies>

  <build>
    <pluginManagement>
      <plugins>
        <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.8.0</version>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>
</project>

  3. Trong thư mục đang hoạt động, hãy tạo cấu trúc thư mục sau src/main/java.

  4. Trong thư mục src/main/java, hãy tạo một tệp có tên App.java.

  5. Trong App.java, hãy dán mã sau:

    java/webhook/src/main/java/com/google/chat/webhook/App.java
    import com.google.gson.Gson;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Map;
import java.net.URI;

public class App {
  private static final String URL = "https://chat.googleapis.com/v1/spaces/AAAAGCYeSRY/messages";
  private static final Gson gson = new Gson();
  private static final HttpClient client = HttpClient.newHttpClient();

  public static void main(String[] args) throws Exception {
    String message = gson.toJson(Map.of("text", "Hello from Java!"));

    HttpRequest request = HttpRequest.newBuilder(
        URI.create(URL))
        .header("accept", "application/json; charset=UTF-8")
        .POST(HttpRequest.BodyPublishers.ofString(message))
        .build();

    HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

    System.out.println(response.body());
  }
}

  6. Thay thế giá trị cho biến URL bằng URL webhook mà bạn được sao chép khi bạn đăng ký webhook.

Apps Script

  1. Trong trình duyệt, hãy chuyển đến Apps Script.

  2. Nhấp vào New Project (Dự án mới)

  3. Dán đoạn mã sau:

    apps-script/webhook/webhook.gs
    function webhook() {
  const url = "https://chat.googleapis.com/v1/spaces/SPACE_ID/messages"
  const options = {
    "method": "post",
    "headers": {"Content-Type": "application/json; charset=UTF-8"},
    "payload": JSON.stringify({"text": "Hello from Apps Script!"})
  };
  const response = UrlFetchApp.fetch(url, options);
  console.log(response);
}

  4. Thay thế giá trị cho biến url bằng URL webhook mà bạn được sao chép khi bạn đăng ký webhook.

Chạy tập lệnh webhook

Trong CLI, chạy tập lệnh:

Python

  python3 quickstart.py

Node.js

  node index.js

Java

  mvn compile exec:java -Dexec.mainClass=App

Apps Script

  • Nhấp vào Chạy.

Khi bạn chạy mã, webhook sẽ gửi tin nhắn đến không gian mà bạn đã đăng ký tên miền.

Bắt đầu hoặc trả lời một chuỗi tin nhắn

  1. Nêu rõ spaces.messages.thread.threadKey trong nội dung yêu cầu tin nhắn. Tuỳ thuộc vào việc bạn đang bắt đầu hay trả lời một chuỗi thư, hãy sử dụng các giá trị sau cho threadKey:

    • Nếu bắt đầu một luồng, hãy đặt threadKey thành một chuỗi tuỳ ý, nhưng hãy ghi lại giá trị này để đăng câu trả lời cho chuỗi thư.

    • Nếu trả lời một chuỗi thư, hãy chỉ định threadKey được đặt khi đã bắt đầu chuỗi. Ví dụ: để đăng câu trả lời cho chuỗi cuộc trò chuyện mà thông báo ban đầu được sử dụng MY-THREAD, đặt MY-THREAD.

  2. Xác định hành vi của luồng nếu không tìm thấy threadKey được chỉ định:

    • Trả lời một chuỗi cuộc trò chuyện hoặc bắt đầu một chuỗi cuộc trò chuyện mới. Thêm messageReplyOption=REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD tham số đến URL webhook. Việc chuyển tham số URL này khiến Chat để tìm một luồng hiện có bằng threadKey được chỉ định. Nếu có được tìm thấy, thì tin nhắn sẽ được đăng dưới dạng câu trả lời cho chuỗi tin nhắn đó. Nếu không có thì thông báo sẽ bắt đầu một chuỗi mới tương ứng với threadKey.

    • Trả lời một chuỗi tin nhắn hoặc không làm gì cả. Thêm messageReplyOption=REPLY_MESSAGE_OR_FAIL thông số cho URL webhook. Việc chuyển tham số URL này khiến Chat để tìm một luồng hiện có bằng threadKey được chỉ định. Nếu có được tìm thấy, thì tin nhắn sẽ được đăng dưới dạng câu trả lời cho chuỗi tin nhắn đó. Nếu không có thì tin nhắn sẽ không được gửi.

    Để tìm hiểu thêm, hãy xem messageReplyOption.

Mã mẫu sau đây bắt đầu hoặc trả lời một chuỗi tin nhắn:

Python

python/webhook/thread-reply.py
from json import dumps
from httplib2 import Http

# Copy the webhook URL from the Chat space where the webhook is registered.
# The values for SPACE_ID, KEY, and TOKEN are set by Chat, and are included
# when you copy the webhook URL.
#
# Then, append messageReplyOption=REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD to the
# webhook URL.


def main():
    """Google Chat incoming webhook that starts or replies to a message thread."""
    url = "https://chat.googleapis.com/v1/spaces/SPACE_ID/messages?key=KEY&token=TOKEN&messageReplyOption=REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD"
    app_message = {
        "text": "Hello from a Python script!",
        # To start a thread, set threadKey to an arbitratry string.
        # To reply to a thread, specify that thread's threadKey value.
        "thread": {"threadKey": "THREAD_KEY_VALUE"},
    }
    message_headers = {"Content-Type": "application/json; charset=UTF-8"}
    http_obj = Http()
    response = http_obj.request(
        uri=url,
        method="POST",
        headers=message_headers,
        body=dumps(app_message),
    )
    print(response)


if __name__ == "__main__":
    main()

Node.js

node/webhook/thread-reply.js
/**
 * Sends asynchronous message to Google Chat
 * @return {Object} response
 */
async function webhook() {
  const url = "https://chat.googleapis.com/v1/spaces/SPACE_ID/messages?key=KEY&token=TOKEN&messageReplyOption=REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD"
  const res = await fetch(url, {
    method: "POST",
    headers: {"Content-Type": "application/json; charset=UTF-8"},
    body: JSON.stringify({
      text: "Hello from a Node script!",
      thread: {threadKey: "THREAD_KEY_VALUE"}
    })
  });
  return await res.json();
}

webhook().then(res => console.log(res));

Apps Script

apps-script/webhook/thread-reply.gs
function webhook() {
  const url = "https://chat.googleapis.com/v1/spaces/SPACE_ID/messages?key=KEY&token=TOKEN&messageReplyOption=REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD"
  const options = {
    "method": "post",
    "headers": {"Content-Type": "application/json; charset=UTF-8"},
    "payload": JSON.stringify({
      "text": "Hello from Apps Script!",
      "thread": {"threadKey": "THREAD_KEY_VALUE"}
    })
  };
  const response = UrlFetchApp.fetch(url, options);
  console.log(response);
}