वेबहुक के तौर पर Google Chat ऐप्लिकेशन बनाना

इस पेज में बताया गया है कि बाहरी ट्रिगर का इस्तेमाल करके, चैट स्पेस में एसिंक्रोनस मैसेज भेजने के लिए वेबहुक कैसे सेट अप करें. उदाहरण के लिए, सर्वर बंद होने पर, कॉल पर काम करने वाले लोगों को Chat पर सूचना देने के लिए, मॉनिटरिंग ऐप्लिकेशन को कॉन्फ़िगर किया जा सकता है. Chat ऐप्लिकेशन से सिंक करने वाला मैसेज भेजने के लिए, मैसेज भेजें लेख पढ़ें.

इस तरह के आर्किटेक्चर डिज़ाइन में, उपयोगकर्ता वेबहुक या कनेक्ट किए गए बाहरी ऐप्लिकेशन से इंटरैक्ट नहीं कर सकते. इसकी वजह यह है कि बातचीत एकतरफ़ा होती है. वेबहुक में बातचीत नहीं की जा सकती. वे न तो उपयोगकर्ताओं या Chat ऐप्लिकेशन के साथ हुए इंटरैक्शन से जुड़े इवेंट का जवाब दे सकते हैं और न ही उनके मैसेज पा सकते हैं. मैसेज का जवाब देने के लिए, वेबहुक के बजाय Chat ऐप्लिकेशन बनाएं.

वेबहुक, तकनीकी रूप से चैट ऐप्लिकेशन नहीं है. वेबहुक, स्टैंडर्ड एचटीटीपी अनुरोधों का इस्तेमाल करके ऐप्लिकेशन को कनेक्ट करते हैं. वेबहुक को आसान बनाने के लिए, इसे चैट ऐप्लिकेशन कहा गया है. हर वेबहुक सिर्फ़ उस चैट स्पेस में काम करता है जिसमें उसे रजिस्टर किया गया है. इनकमिंग वेबहुक, डायरेक्ट मैसेज में काम करते हैं. यह सिर्फ़ तब काम करता है, जब सभी उपयोगकर्ताओं ने चैट ऐप्लिकेशन चालू किए हों. Google Workspace Marketplace में वेबहुक पब्लिश नहीं किए जा सकते.

नीचे दिया गया डायग्राम, Chat से जुड़े वेबहुक का आर्किटेक्चर दिखाता है:

Chat में एसिंक्रोनस मैसेज भेजने के लिए इनकमिंग वेबहुक का आर्किटेक्चर.

पिछले डायग्राम में, Chat ऐप्लिकेशन में जानकारी का यह फ़्लो दिखाया गया है:

  1. Chat ऐप्लिकेशन को तीसरे पक्ष की बाहरी सेवाओं से जानकारी मिलती है. जैसे, प्रोजेक्ट मैनेजमेंट सिस्टम या टिकटिंग टूल.
  2. Chat ऐप्लिकेशन का लॉजिक, क्लाउड या कंपनी की इमारत में होस्ट होता है. यह किसी खास चैट स्पेस में वेबहुक यूआरएल का इस्तेमाल करके, मैसेज भेज सकता है.
  3. उपयोगकर्ताओं को उस चैट स्पेस में, Chat ऐप्लिकेशन से मैसेज तो मिलेंगे, लेकिन वे चैट ऐप्लिकेशन से इंटरैक्ट नहीं कर पाएंगे.

ज़रूरी शर्तें

Python

  • आपके पास Google Workspace खाता हो. इसमें Chat को ऐक्सेस करने की सुविधा होती है. आपके Google Workspace संगठन को उपयोगकर्ताओं को इनकमिंग वेबहुक जोड़ने और इस्तेमाल करने की अनुमति देनी होगी.
  • Python 3.10.7 या इसके बाद का वर्शन.

  • httplib2 लाइब्रेरी. अगर ज़रूरी हो, तो pip का इस्तेमाल करके लाइब्रेरी इंस्टॉल करने के लिए, यहां दिया गया कमांड-लाइन इंटरफ़ेस (सीएलआई) कमांड चलाएं:

    pip install httplib2

  • पहले से मौजूद चैट स्पेस.

Node.js

Java

Apps Script

वेबहुक बनाएं

वेबहुक बनाने के लिए, इसे उस चैट स्पेस में रजिस्टर करें जहां आपको मैसेज लेने हैं. इसके बाद, ऐसी स्क्रिप्ट लिखें जो मैसेज भेजे.

इनकमिंग वेबहुक को रजिस्टर करें

  1. ब्राउज़र में, Chat खोलें. Chat के मोबाइल ऐप्लिकेशन से वेबहुक को कॉन्फ़िगर नहीं किया जा सकता.
  2. उस स्पेस पर जाएं जहां आपको वेबहुक जोड़ना है.
  3. स्पेस के टाइटल के बगल में, 'ज़्यादा ऐरो' पर क्लिक करें. इसके बाद, ऐप्लिकेशन और इंटिग्रेशन पर क्लिक करें.

  4. वेबहुक जोड़ें पर क्लिक करें.

  5. नाम फ़ील्ड में, Quickstart Webhook डालें.

  6. अवतार यूआरएल फ़ील्ड में, https://developers.google.com/chat/images/chat-product-icon.png डालें.

  7. सेव करें पर क्लिक करें.

  8. वेबहुक यूआरएल कॉपी करने के लिए, ज़्यादा पर क्लिक करें. इसके बाद, लिंक कॉपी करें पर क्लिक करें.

वेबहुक स्क्रिप्ट लिखें

उदाहरण के तौर पर दी गई वेबहुक स्क्रिप्ट, उस स्पेस में एक मैसेज भेजती है जिसमें वेबहुक को रजिस्टर किया गया है. इसके लिए, वेबहुक यूआरएल को POST अनुरोध भेजा जाएगा. Chat API, Message के इंस्टेंस के साथ जवाब देता है.

वेबहुक स्क्रिप्ट बनाने का तरीका जानने के लिए, कोई भाषा चुनें:

Python

  1. अपनी वर्किंग डायरेक्ट्री में, quickstart.py नाम की फ़ाइल बनाएं.

  2. quickstart.py में, यह कोड चिपकाएं:

    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. url वैरिएबल की वैल्यू को उस वेबहुक यूआरएल से बदल दें जिसे आपने वेबहुक रजिस्टर करते समय कॉपी किया था.

Node.js

  1. अपनी वर्किंग डायरेक्ट्री में, index.js नाम की फ़ाइल बनाएं.

  2. index.js में, यह कोड चिपकाएं:

    नोड/वेबहुक/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. url वैरिएबल की वैल्यू को उस वेबहुक यूआरएल से बदल दें जिसे आपने वेबहुक रजिस्टर करते समय कॉपी किया था.

Java

  1. अपनी वर्किंग डायरेक्ट्री में, pom.xml नाम की फ़ाइल बनाएं.

  2. pom.xml में, इन्हें कॉपी करके चिपकाएं:

    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. अपनी मौजूदा डायरेक्ट्री में, यह डायरेक्ट्री स्ट्रक्चर बनाएं src/main/java.

  4. src/main/java डायरेक्ट्री में, App.java नाम की फ़ाइल बनाएं.

  5. App.java में, यह कोड चिपकाएं:

    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. URL वैरिएबल की वैल्यू को उस वेबहुक यूआरएल से बदल दें जिसे आपने वेबहुक रजिस्टर करते समय कॉपी किया था.

Apps Script

  1. ब्राउज़र में, Apps Script पर जाएं.

  2. नया प्रोजेक्ट पर क्लिक करें

  3. यह कोड चिपकाएं:

    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. url वैरिएबल की वैल्यू को उस वेबहुक यूआरएल से बदल दें जिसे आपने वेबहुक रजिस्टर करते समय कॉपी किया था.

वेबहुक स्क्रिप्ट चलाएं

किसी सीएलआई में, स्क्रिप्ट चलाएं:

Python

  python3 quickstart.py

Node.js

  node index.js

Java

  mvn compile exec:java -Dexec.mainClass=App

Apps Script

  • चलाएं पर क्लिक करें.

जब कोड को चलाया जाता है, तो वेबहुक उस स्पेस को एक मैसेज भेजता है जिसमें आपने उसे रजिस्टर किया था.

मैसेज थ्रेड शुरू करें या उसका जवाब दें

  1. spaces.messages.thread.threadKey को मैसेज के अनुरोध के मुख्य हिस्से के तौर पर बताएं. आप थ्रेड शुरू कर रहे हैं या उसका जवाब दे रहे हैं, इसके आधार पर threadKey के लिए इन वैल्यू का इस्तेमाल करें:

    • अगर थ्रेड शुरू कर रहे हैं, तो threadKey को किसी आर्बिट्रेरी स्ट्रिंग पर सेट करें, लेकिन थ्रेड का जवाब पोस्ट करने के लिए इस वैल्यू को नोट कर लें.

    • किसी थ्रेड का जवाब देते समय, उस threadKey के बारे में बताएं जो थ्रेड शुरू होने के समय सेट किया गया था. उदाहरण के लिए, उस थ्रेड का जवाब पोस्ट करने के लिए जहां शुरुआती मैसेज में MY-THREAD का इस्तेमाल किया गया था, MY-THREAD सेट करें.

  2. अगर बताया गया threadKey नहीं मिलता है, तो थ्रेड के काम करने का तरीका तय करें:

    • थ्रेड का जवाब दें या नई थ्रेड शुरू करें. वेबहुक यूआरएल में messageReplyOption=REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD पैरामीटर जोड़ें. इस यूआरएल पैरामीटर को पास करने से Chat, बताए गए threadKey का इस्तेमाल करके मौजूदा थ्रेड खोजेगा. अगर कोई मैसेज मिल जाता है, तो मैसेज उस थ्रेड के जवाब के तौर पर पोस्ट हो जाता है. अगर कोई थ्रेड नहीं मिलता है, तो मैसेज उस threadKey से जुड़ा नया थ्रेड शुरू करता है.

    • किसी थ्रेड का जवाब दें या कुछ न करें. वेबहुक यूआरएल में messageReplyOption=REPLY_MESSAGE_OR_FAIL पैरामीटर जोड़ें. इस यूआरएल पैरामीटर को पास करने से Chat, बताए गए threadKey का इस्तेमाल करके मौजूदा थ्रेड खोजेगा. अगर कोई मैसेज मिल जाता है, तो मैसेज उस थ्रेड के जवाब के तौर पर पोस्ट हो जाता है. अगर कुछ नहीं मिलता है, तो मैसेज नहीं भेजा जाता है.

    ज़्यादा जानने के लिए, messageReplyOption देखें.

नीचे दिया गया कोड सैंपल, किसी मैसेज थ्रेड को शुरू करता है या उस पर जवाब देता है:

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);
}