- 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 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 với 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ỉ dành cho không gian ở chế độ nhập)
Chat ghi nhận người gửi tin nhắn theo cách khác nhau tuỳ thuộc vào loại phương thức 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 một tin nhắn khi bạn sử dụng phương thức 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 tin nhắn có thể chứa văn bản (text), thẻ (cardsV2) và tiện ích phụ trợ (accessoryWidgets).
Hình ảnh sau đây cho thấy cách Chat ghi nhận tác giả của một tin nhắn khi bạn sử dụng phương thức 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 cho 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 tin nhắn, bao gồm cả nội dung tin nhắn, 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 vào 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 để 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: Hãy sử dụng |
requestId |
Không bắt buộc. Mã nhận dạng duy nhất cho yêu cầu này. Bạn nên sử dụng UUID ngẫu nhiên. Việc chỉ định mã yêu cầu sẽ giúp yêu cầu có tính chất bất biến, đảm bảo rằng nhiều yêu cầu giống hệt nhau có cùng mã yêu cầu chỉ tạo ra một thông báo duy nhất. Các yêu cầu tiếp theo có cùng mã yêu cầu sẽ trả về thông báo hiện có và không cập nhật thông báo, ngay cả khi thông tin chi tiết được yêu cầu khác với trạng thái hiện tại. Cách sử dụng trường này một cách hiệu quả:
|
messageReplyOption |
Không bắt buộc. Chỉ định xem một tin nhắn 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, câu trả lời sẽ được tạo trong cùng một chuỗi. Nếu không, thư trả lời sẽ được tạo dưới dạng một chuỗi thư mới. |
messageId |
Không bắt buộc. Mã tùy chỉnh cho một thông báo. Cho phép ứng dụng Chat nhận, cập nhật hoặc xoá 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 thông báo. |
createMessageNotificationOptions |
Không bắt buộc. Kiểm soát hành vi thông báo khi tin nhắn được đăng. Để tìm hiểu thêm, hãy xem bài viết 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ể thêm 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 mới. Khi sử dụng tuỳ chọn này, mọi thread ID hoặc có trong đó đều bị bỏ qua. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
Tạo tin nhắn dưới dạng thư trả lời cho chuỗi tin nhắn được chỉ định bằng thread ID hoặc . Nếu không thành cô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 thư trả lời cho chuỗi tin nhắn được chỉ định bằng thread ID hoặc . Nếu sử dụng threadKey mới, thì một chuỗi mới sẽ được tạo. Nếu không tạo được thông báo, thì lỗi NOT_FOUND sẽ được trả về. |
CreateMessageNotificationOptions
Các lựa chọn về hành vi thông báo khi tin nhắn được đăng.
| Biểu diễn dưới dạng JSON |
|---|
{
"notificationType": enum ( |
| Trường | |
|---|---|
notificationType |
Loại thông báo cho tin nhắn. |
NotificationType
Các lựa chọn loại thông báo cho tin nhắn.
| Enum | |
|---|---|
NOTIFICATION_TYPE_NONE |
Hành vi mặc định. Hành vi thông báo tương tự như khi người dùng gửi tin nhắn bằng giao diện người dùng Chat: không có thông báo nào được gửi đến người gửi là con người. |
NOTIFICATION_TYPE_INCLUDE_HUMAN_CREATOR |
Một thông báo (thông báo đẩy, thông báo qua email, v.v.) sẽ được gửi đến người dùng tạo tin nhắn (ví dụ: người dùng có thông tin xác thực được dùng để tạo tin nhắn) và tin nhắn đó sẽ được đánh dấu là chưa đọc. Thao tác này sẽ không ghi đè chế độ cài đặt thông báo hiện tại của người dùng cho không gian. Ví dụ: nếu người dùng đã chọn không nhận thông báo cho một không gian, thì họ sẽ không nhận được thông báo ngay cả khi bạn đặt tuỳ chọn này. Yêu cầu Xác thực người dùng. |
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 của người dùng trong không gian và chế độ cài đặt 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 |
Không thông báo cho người nhận và không đánh dấu thư là chưa đọc. Tính năng này hoạt động tương tự như khi người dùng tắt tiếng cuộc trò chuyện hoặc bật chế độ Không làm phiền trong Chat. Yêu cầu xác thực ứng dụng. |