- Yêu cầu HTTP
- Tham số đường dẫn
- Tham số truy vấn
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi uỷ quyền
- MessageReplyOption
- CreateMessageNotificationOptions
- NotificationType
- Hãy làm thử!
Tạo một tin nhắn trong phòng Chat của Google Chat. Để biết ví dụ, hãy xem phần Gửi tin nhắn.
Hỗ trợ các loại xác thực sau:
- Xác thực ứng dụng bằng phạm vi uỷ quyền:
https://www.googleapis.com/auth/chat.bot
- Xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:
https://www.googleapis.com/auth/chat.messages.createhttps://www.googleapis.com/auth/chat.messageshttps://www.googleapis.com/auth/chat.import(chỉ có dấu cách trong chế độ nhập)
Chat sẽ phân bổ người gửi tin nhắn theo cách khác nhau tuỳ thuộc vào loại xác thực mà bạn sử dụng trong yêu cầu.
Hình ảnh sau đây cho thấy cách Chat ghi nhận thông báo khi bạn sử dụng tính năng xác thực ứng dụng. Chat hiển thị ứng dụng Chat là người gửi tin nhắn. Nội dung của thông báo có thể chứa văn bản (text), thẻ (cardsV2) và tiện ích bổ sung (accessoryWidgets).
Hình ảnh sau đây cho thấy cách Chat gán thông tin cho một tin nhắn khi bạn sử dụng tính năng xác thực người dùng. Chat hiển thị người dùng là người gửi tin nhắn và ghi nhận ứng dụng Chat là nguồn gốc của tin nhắn bằng cách hiển thị tên của ứng dụng. Nội dung của tin nhắn chỉ có thể chứa văn bản (text).
Kích thước tối đa của thư, bao gồm cả nội dung thư, là 32.000 byte.
Đối với các yêu cầu webhook, phản hồi không chứa toàn bộ thông báo. Phản hồi chỉ điền sẵn các trường name và thread.name ngoài thông tin có trong yêu cầu.
Yêu cầu HTTP
POST https://chat.googleapis.com/v1/{parent=spaces/*}/messages
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số đường dẫn
| Tham số | |
|---|---|
parent |
Bắt buộc. Tên tài nguyên của không gian mà bạn muốn tạo tin nhắn. Định dạng |
Tham số truy vấn
| Thông số | |
|---|---|
threadKey |
Không bắt buộc. Không dùng nữa: Thay vào đó, hãy sử dụng |
requestId |
Không bắt buộc. Mã yêu cầu duy nhất cho thông báo này. Việc chỉ định một mã yêu cầu hiện có sẽ trả về thông báo được tạo bằng mã đó thay vì tạo một thông báo mới. |
messageReplyOption |
Không bắt buộc. Chỉ định xem một tin nhắn có bắt đầu một chuỗi tin nhắn hay trả lời một chuỗi tin nhắn. Chỉ được hỗ trợ trong không gian có tên. Khi phản hồi các hoạt động tương tác của người dùng, trường này sẽ bị bỏ qua. Đối với các lượt tương tác trong một chuỗi tin nhắn, câu trả lời sẽ được tạo trong cùng chuỗi đó. Nếu không, câu trả lời sẽ được tạo thành một chuỗi tin nhắn mới. |
messageId |
Không bắt buộc. Mã nhận dạng tuỳ chỉnh cho một thông báo. Cho phép các ứng dụng Chat nhận, cập nhật hoặc xoá một tin nhắn mà không cần lưu trữ mã nhận dạng do hệ thống chỉ định trong tên tài nguyên của tin nhắn (được biểu thị trong trường Giá trị của trường này phải đáp ứng các yêu cầu sau:
Để biết thông tin chi tiết, hãy xem bài viết Đặt tên cho tin nhắn. |
createMessageNotificationOptions |
Không bắt buộc. Kiểm soát hành vi thông báo khi thông báo được đăng. Để tìm hiểu thêm, hãy xem phần Buộc thông báo hoặc gửi tin nhắn im lặng. |
Nội dung yêu cầu
Nội dung yêu cầu chứa một bản sao của Message.
Nội dung phản hồi
Nếu thành công, nội dung phản hồi sẽ chứa một thực thể mới tạo của Message.
Phạm vi uỷ quyền
Yêu cầu một trong các phạm vi OAuth sau:
https://www.googleapis.com/auth/chat.bothttps://www.googleapis.com/auth/chat.importhttps://www.googleapis.com/auth/chat.messageshttps://www.googleapis.com/auth/chat.messages.create
Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.
MessageReplyOption
Chỉ định cách trả lời tin nhắn. Chúng tôi có thể sẽ bổ sung các tiểu bang khác trong tương lai.
| Enum | |
|---|---|
MESSAGE_REPLY_OPTION_UNSPECIFIED |
Mặc định. Bắt đầu một chuỗi trò chuyện mới. Khi sử dụng lựa chọn này, mọi thread ID hoặc có trong đó sẽ bị bỏ qua. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
Tạo tin nhắn dưới dạng câu trả lời cho chuỗi tin nhắn do thread ID hoặc chỉ định. Nếu không, tin nhắn sẽ bắt đầu một chuỗi mới. |
REPLY_MESSAGE_OR_FAIL |
Tạo tin nhắn dưới dạng câu trả lời cho chuỗi tin nhắn do thread ID hoặc chỉ định. Nếu một threadKey mới được dùng, một luồng mới sẽ được tạo. Nếu không tạo được thông báo, thì thay vào đó, một lỗi NOT_FOUND sẽ được trả về. |
CreateMessageNotificationOptions
Các lựa chọn về hành vi thông báo khi thông báo được đăng.
| Biểu diễn dưới dạng JSON |
|---|
{
"notificationType": enum ( |
| Trường | |
|---|---|
notificationType |
Loại thông báo cho thông báo. |
NotificationType
Các lựa chọn về loại thông báo cho tin nhắn.
| Enum | |
|---|---|
NOTIFICATION_TYPE_NONE |
Hành động mặc định. Hành vi thông báo tương tự như khi người dùng là con người gửi tin nhắn bằng giao diện người dùng Chat: người gửi là con người sẽ không nhận được thông báo. |
NOTIFICATION_TYPE_FORCE_NOTIFY |
Bắt buộc thông báo cho người nhận. Thao tác này sẽ bỏ qua chế độ cài đặt thông báo về không gian và chế độ Không làm phiền của Chat. Lựa chọn này không bỏ qua chế độ Không làm phiền ở cấp thiết bị. Yêu cầu xác thực ứng dụng. |
NOTIFICATION_TYPE_SILENT |
Tắt thông báo như thể người nhận đã bật chế độ Không làm phiền trong Chat hoặc đã tắt tiếng không gian. Yêu cầu xác thực ứng dụng. |