إنشاء تطبيق Google Chat كردّ تلقائي على الويب

توضّح هذه الصفحة كيفية إعداد ردّ تلقائي على الويب لإرسال الرسائل غير المتزامنة إلى مساحة Chat باستخدام عوامل تشغيل خارجية. على سبيل المثال، يمكنك ضبط تطبيق مراقبة لإبلاغ الموظفين عند الطلب في Chat عند تعطل أحد الخوادم. لإرسال رسالة متزامنة باستخدام تطبيق Chat، يُرجى الاطّلاع على مقالة إرسال رسالة.

مع هذا النوع من التصميم الهندسي، لا يمكن للمستخدمين التفاعل مع الرد التلقائي على الويب أو التطبيق الخارجي المتصل لأن الاتصال أحادي الاتجاه. الردود التلقائية على الويب ليست محادثة. لا يمكنهم الردّ على الرسائل أو تلقّيها من المستخدمين أو أحداث التفاعل مع تطبيقات Chat. للرد على الرسائل، عليك إنشاء تطبيق في Chat بدلاً من ردّ تلقائي على الويب.

الردّ التلقائي على الويب ليس تطبيقًا في Chat من الناحية الفنية، ولكن الردّ التلقائي على الويب يربط التطبيقات باستخدام طلبات HTTP العادية. تشير هذه الصفحة إلى التطبيق على أنّه تطبيق Chat للتبسيط. لا يعمل كل ردّ تلقائي على الويب إلا في مساحة Chat التي تم تسجيلها فيها. تعمل الردود التلقائية الواردة على الويب في الرسائل المباشرة، ولكن فقط عند تفعيل تطبيقات Chat لجميع المستخدمين. لا يمكنك نشر الردود التلقائية على الويب في Google Workspace Marketplace.

يوضّح المخطّط التالي بنية ردّ تلقائي على الويب متصل بـ Chat:

بنية الردود التلقائية الواردة على الويب لإرسال رسائل غير متزامنة إلى Chat.

في المخطّط السابق، يحتوي تطبيق Chat على تدفق المعلومات التالي:

  1. يتلقّى منطق تطبيق Chat المعلومات من خدمات تابعة لجهات خارجية، مثل نظام إدارة المشاريع أو أداة إصدار التذاكر.
  2. تتم استضافة منطق تطبيق Chat في سحابة إلكترونية أو نظام داخل الشركة يمكنه إرسال الرسائل باستخدام عنوان URL للردّ التلقائي على الويب إلى مساحة Chat محدَّدة.
  3. يمكن للمستخدمين تلقّي الرسائل من تطبيق Chat في "مساحة Chat" المحدّدة، ولكن لا يمكنهم التفاعل مع تطبيق Chat.

المتطلّبات الأساسية

Python

Node.js

Java

Apps Script

إنشاء ردّ تلقائي على الويب

لإنشاء ردّ تلقائي على الويب، سجِّله في مساحة Chat التي تريد تلقّي الرسائل فيها، ثم اكتب نصًا برمجيًا يرسل الرسائل.

تسجيل الرد التلقائي الوارد على الويب

  1. في المتصفّح، افتح Chat. لا يمكن ضبط الردود التلقائية على الويب من تطبيق Chat المتوافق مع الأجهزة الجوّالة.
  2. انتقِل إلى المساحة التي تريد إضافة ردّ تلقائي على الويب فيها.
  3. بجانب عنوان المساحة، انقر على سهم توسيع المزيد في ، ثم انقر على التطبيقات وعمليات الدمج.
  4. انقر على إضافة ردود تلقائية على الويب.

  5. في حقل الاسم، أدخِل Quickstart Webhook.

  6. في حقل عنوان URL للصورة الرمزية، أدخِل https://developers.google.com/chat/images/chat-product-icon.png.

  7. انقر على حفظ.

  8. لنسخ عنوان URL للردّ التلقائي على الويب، انقر على المزيد، ثم انقر على نسخ الرابط.

كتابة نص الردّ التلقائي على الويب

يرسل نموذج النص البرمجي للردّ التلقائي على الويب رسالة إلى المساحة التي تم فيها تسجيل الردّ التلقائي على الويب من خلال إرسال طلب POST إلى عنوان URL للردّ التلقائي على الويب. تستجيب 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 بعنوان URL للردّ التلقائي على الويب الذي نسخته عند تسجيل الردّ التلقائي على الويب.

Node.js

  1. في دليل العمل، أنشِئ ملفًا باسم "index.js".

  2. في index.js، الصق الرمز التالي:

    العقدة/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 بعنوان 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 بعنوان URL للردّ التلقائي على الويب الذي نسخته عند تسجيل الردّ التلقائي على الويب.

Apps Script

  1. في المتصفِّح، انتقِل إلى برمجة التطبيقات.

  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 بعنوان 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 إلى عنوان URL للردّ التلقائي على الويب. يؤدي تمرير مَعلمة عنوان URL هذه إلى بحث Chat عن سلسلة محادثات حالية باستخدام علامة threadKey المحدّدة. فإذا تم العثور على واحدة، فإن منشورات الرسالة كرد على سلسلة المحادثات تلك. إذا لم يتم العثور على أي منها، ستبدأ الرسالة سلسلة محادثات جديدة تتوافق مع threadKey.

    • الرد على سلسلة محادثات أو عدم اتخاذ أي إجراء أضِف مَعلمة messageReplyOption=REPLY_MESSAGE_OR_FAIL إلى عنوان URL للردّ التلقائي على الويب. يؤدي تمرير مَعلمة عنوان URL هذه إلى بحث 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);
}