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

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

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

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

नीचे दिया गया डायग्राम, वेबहुक के आर्किटेक्चर को दिखाता है. चैट करें

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

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

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

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

Python

Node.js

Java

Apps Script

वेबहुक बनाएं

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

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

  1. किसी ब्राउज़र में, खोलें चैट. 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 में, यह कोड चिपकाएं:

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

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