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

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

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

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

इस डायग्राम में, Chat से कनेक्ट किए गए वेबहुक का आर्किटेक्चर दिखाया गया है:

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

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

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

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

PythonNode.jsJavaApps Script
  • आपके पास Google Chat का ऐक्सेस हो और आपके पास Google Workspace का Business या Enterprise वर्शन वाला खाता हो. आपके Google Workspace संगठन को उपयोगकर्ताओं को इनकमिंग वेबहुक जोड़ने और इस्तेमाल करने की अनुमति देनी होगी.
  • Python 3.6 या इसके बाद का वर्शन
  • pip पैकेज मैनेजमेंट टूल

  • httplib2 लाइब्रेरी. लाइब्रेरी इंस्टॉल करने के लिए, अपने कमांड-लाइन इंटरफ़ेस में यह कमांड चलाएं:

    pip install httplib2

  • Google Chat में मौजूद कोई स्पेस. Google Chat API का इस्तेमाल करके स्पेस बनाने के लिए, स्पेस बनाना लेख पढ़ें. Chat में कोई दस्तावेज़ बनाने के लिए, सहायता केंद्र के दस्तावेज़ पर जाएं.

वेबहुक बनाना

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

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

  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 के किसी इंस्टेंस के साथ जवाब देता है.

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

PythonNode.jsJavaApps Script

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

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

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

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

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

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

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

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

PythonNode.jsJavaApps Script
  python3 quickstart.py
  node index.js
  mvn compile exec:java -Dexec.mainClass=App
  • चलाएं पर क्लिक करें.

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

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

  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 देखें.

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

PythonNode.jsApps Script
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/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/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);
}

गड़बड़ियां ठीक करना

कई वजहों से वेबहुक अनुरोध पूरा नहीं हो पाते. इनमें ये वजहें शामिल हैं:

  • अनुरोध अमान्य है.
  • वेबहुक या वेबहुक को होस्ट करने वाले स्पेस को मिटा दिया जाता है.
  • नेटवर्क कनेक्टिविटी या कोटा की सीमाओं जैसी समस्याएं, जो कभी-कभी आती हैं.

वेबहुक बनाते समय, आपको गड़बड़ियों को सही तरीके से मैनेज करना चाहिए. इसके लिए:

Google Chat API, गड़बड़ियों को google.rpc.Status के तौर पर दिखाता है. इसमें एचटीटीपी गड़बड़ी code शामिल होती है, जो बताती है कि किस तरह की गड़बड़ी हुई है: क्लाइंट गड़बड़ी (400 सीरीज़) या सर्वर गड़बड़ी (500 सीरीज़). सभी एचटीटीपी मैपिंग की समीक्षा करने के लिए, google.rpc.Code देखें.

{
    "code": 503,
    "message": "The service is currently unavailable.",
    "status": "UNAVAILABLE"
}

एचटीटीपी स्टेटस कोड को समझने और गड़बड़ियों को हैंडल करने का तरीका जानने के लिए, गड़बड़ियां देखें.

सीमाएं और ध्यान देने वाली बातें

  • Google Chat API में वेबहुक की मदद से मैसेज बनाते समय, रिस्पॉन्स में पूरा मैसेज शामिल नहीं होता. जवाब में सिर्फ़ name और thread.name फ़ील्ड अपने-आप भर जाते हैं.
  • spaces.messages.create के लिए, हर स्पेस के लिए कोटा लागू होता है: हर 60 सेकंड में 60 अनुरोध, जो स्पेस में मौजूद सभी वेबहुक के बीच शेयर किए जाते हैं. Chat, एक ही स्पेस में एक सेकंड में एक से ज़्यादा क्वेरी वाले वेबहुक अनुरोधों को भी अस्वीकार कर सकता है. Chat API के कोटे के बारे में ज़्यादा जानकारी के लिए, इस्तेमाल की सीमाएं देखें.