Tạo một không gian và thêm người dùng được chỉ định vào không gian đó. Người dùng gọi sẽ tự động được thêm vào không gian và không được chỉ định là thành viên trong yêu cầu. Để biết ví dụ, hãy xem bài viết Thiết lập không gian có các thành viên ban đầu.
Để chỉ định những thành viên là con người cần thêm, hãy thêm gói thành viên có membership.member.name
phù hợp. Để thêm người dùng là con người, hãy sử dụng users/{user}
, trong đó {user}
có thể là địa chỉ email của người dùng. Đối với người dùng trong cùng một tổ chức Workspace, {user}
cũng có thể là id
đối với người dùng trong API Mọi người hoặc id
đối với người dùng trong API Thư mục. Ví dụ: nếu mã hồ sơ người dùng của API People cho user@example.com
là 123456789
, thì bạn có thể thêm người dùng vào không gian bằng cách đặt membership.member.name
thành users/user@example.com
hoặc users/123456789
.
Để chỉ định các nhóm Google cần thêm, hãy thêm các thành viên bằng membership.group_member.name
thích hợp. Để thêm hoặc mời một nhóm trên Google Groups, hãy sử dụng groups/{group}
, trong đó {group}
là id
cho nhóm từ API Cloud Identity Groups. Ví dụ: bạn có thể sử dụng API tra cứu nhóm trên Cloud Identity để truy xuất mã 123456789
cho email nhóm group@example.com
, sau đó thêm nhóm vào không gian bằng cách đặt membership.group_member.name
thành groups/123456789
. Email nhóm không được hỗ trợ và bạn chỉ có thể thêm nhóm trên Google Groups làm thành viên trong các không gian được đặt tên.
Đối với không gian hoặc cuộc trò chuyện nhóm có tên, nếu người gọi chặn hoặc bị một số thành viên chặn hoặc không có quyền thêm một số thành viên, thì những thành viên đó sẽ không được thêm vào không gian đã tạo.
Để tạo tin nhắn trực tiếp (DM) giữa người dùng đang gọi và một người dùng khác, hãy chỉ định chính xác một gói thành viên để đại diện cho người dùng đó. Nếu một người dùng chặn người dùng khác, thì yêu cầu sẽ không thành công và tin nhắn trực tiếp sẽ không được tạo.
Để tạo tin nhắn trực tiếp giữa người dùng gọi và ứng dụng gọi, hãy đặt Space.singleUserBotDm
thành true
và không chỉ định bất kỳ gói thành viên nào. Bạn chỉ có thể sử dụng phương thức này để thiết lập tin nhắn trực tiếp bằng ứng dụng gọi. Để thêm ứng dụng gọi làm thành viên của không gian hoặc tin nhắn trực tiếp hiện có giữa 2 người dùng, hãy xem phần Mời hoặc thêm người dùng/ứng dụng vào không gian.
Nếu một tin nhắn trực tiếp đã tồn tại giữa hai người dùng, ngay cả khi một người dùng chặn người dùng còn lại vào thời điểm có yêu cầu, thì tin nhắn trực tiếp hiện có sẽ được trả về.
Không hỗ trợ không gian có câu trả lời theo chuỗi. Nếu bạn nhận được thông báo lỗi ALREADY_EXISTS
khi thiết lập không gian, hãy thử một displayName
khác. Một không gian hiện có trong tổ chức Google Workspace có thể đã sử dụng tên hiển thị này.
Yêu cầu xác thực người dùng.
Yêu cầu HTTP
POST https://chat.googleapis.com/v1/spaces:setup
URL sử dụng cú pháp Chuyển mã gRPC.
Nội dung yêu cầu
Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:
Biểu diễn dưới dạng JSON |
---|
{ "space": { object ( |
Trường | |
---|---|
space |
Bắt buộc. Trường Để tạo không gian, hãy đặt Để tạo cuộc trò chuyện nhóm, hãy đặt Để tạo cuộc trò chuyện 1:1 giữa con người, hãy đặt Để tạo cuộc trò chuyện 1:1 giữa người dùng và ứng dụng Chat đang gọi, hãy đặt Nếu không gian |
request |
Không bắt buộc. Giá trị nhận dạng duy nhất cho yêu cầu này. Bạn nên dùng mã nhận dạng duy nhất (UUID) ngẫu nhiên. Việc chỉ định mã nhận dạng yêu cầu hiện có sẽ trả về không gian được tạo bằng mã nhận dạng đó thay vì tạo không gian mới. Việc chỉ định mã yêu cầu hiện có từ cùng một ứng dụng Chat với một người dùng đã xác thực khác sẽ trả về lỗi. |
memberships[] |
Không bắt buộc. Người dùng hoặc nhóm Google Chat mà bạn muốn mời tham gia không gian. Bỏ qua người dùng gọi vì họ được thêm tự động. Chế độ này hiện cho phép sử dụng tối đa 20 thành viên (ngoài người gọi). Đối với gói thành viên dành cho con người, trường Đối với tư cách thành viên nhóm trên Google, trường Không bắt buộc khi đặt Bắt buộc khi đặt Bắt buộc khi đặt Phải để trống khi tạo cuộc trò chuyện 1:1 giữa người dùng và ứng dụng Chat gọi (khi đặt |
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 phiên bản của Space
.
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.spaces
https://www.googleapis.com/auth/chat.spaces.create
Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.