Method: spaces.setup

Tạo 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àm thành viên trong yêu cầu.

Để chỉ định thành viên là người sẽ thêm, hãy thêm tư cách thành viên bằng member.name thích hợp trong SetUpSpaceRequest. Để thêm người dùng là con người, hãy sử dụng users/{user}, trong đó {user} là {person_id} cho người từ API Mọi người hoặc id cho người dùng trong API Thư mục SDK dành cho quản trị viên. Ví dụ: nếu API Mọi người Person resourceName là people/123456789, bạn có thể thêm người dùng vào không gian bằng cách thêm gói thành viên có users/123456789 làm member.name.

Đối với không gian hoặc cuộc trò chuyện nhóm, nếu người gọi bị chặn hoặc bị một số thành viên chặ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 gọi và người dùng khác, hãy chỉ định chính xác một thành viên để đại diện cho người dùng. Nếu một người dùng chặn người kia, thì yêu cầu sẽ không thành công và tin nhắn trực tiếp 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 (đúng) 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 để thêm các thành viên ứng dụng vào Tin nhắn trực tiếp. Để thêm ứng dụng gọi điện làm thành viên của các loại không gian khác, hãy sử dụng tính năng tạo gói thành viên

Nếu đã có một DM giữa hai người dùng, ngay cả khi một người dùng chặn người đó tại thời điểm yêu cầu, thì DM hiện có sẽ được trả về.

Các không gian có câu trả lời theo chuỗi hoặc quyền truy cập của khách không được hỗ trợ.

Yêu cầu xác thực người dùng và phạm vi chat.spaces.create hoặc chat.spaces.

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

Phần nội dung yêu cầu chứa dữ liệu có cấu trúc như sau:

Biểu diễn dưới dạng JSON 
{
  "space": {
    object (Space)
  },
  "requestId": string,
  "memberships": [
    {
      object (Membership)
    }
  ]
}
Các trường
space

object (Space)

Bắt buộc. Trường Space.spaceType là trường bắt buộc.

Để tạo không gian, hãy đặt Space.spaceType thành SPACE, sau đó đặt Space.displayName.

Để tạo một cuộc trò chuyện nhóm, hãy đặt Space.spaceType thành GROUP_CHAT. Không đặt Space.displayName.

Để tạo cuộc trò chuyện 1:1 giữa con người, hãy đặt Space.spaceType thành DIRECT_MESSAGE và đặt Space.singleUserBotDm thành false. Không đặt Space.displayName hoặc Space.spaceDetails.

Để tạo cuộc trò chuyện 1:1 giữa một người và ứng dụng Chat gọi điện, hãy đặt Space.spaceType thành DIRECT_MESSAGE và Space.singleUserBotDm thành true. Không đặt Space.displayName hoặc Space.spaceDetails.
requestId

string

Không bắt buộc. Giá trị nhận dạng duy nhất của yêu cầu này. Bạn nên sử dụng UUID ngẫu nhiên. Yêu cầu này chỉ có giá trị nếu requestId đã được cung cấp hoặc nếu DM đã tồn tại. Việc chỉ định giá trị hiện có cho requestId từ cùng một ứng dụng nhắn tin với một người dùng đã xác thực khác sẽ trả về lỗi.
memberships[]

object (Membership)

Không bắt buộc. Nhóm người dùng hoặc nhóm trong miền ban đầu được mời tham gia không gian.

Nhóm này hiện cho phép tối đa 20 thành viên.

Trường Membership.member phải chứa người dùng có name được điền sẵn và User.Type.HUMAN. Tất cả các trường khác sẽ bị bỏ qua.

Bắt buộc khi đặt Space.spaceType thành SPACE, cùng với ít nhất một gói thành viên.

Bắt buộc khi đặt Space.spaceType thành GROUP_CHAT, cùng với ít nhất hai gói hội viên.

Bắt buộc khi đặt Space.spaceType thành DIRECT_MESSAGE với người dùng là con người, cùng với đúng một gói thành viên.

Phải để trống khi tạo cuộc trò chuyện 1:1 giữa một người và ứng dụng Chat gọi điện (khi đặt Space.spaceType thành DIRECT_MESSAGE và Space.singleUserBotDm thành true).

Không được hỗ trợ: Mời người dùng khách hoặc thêm các ứng dụng trò chuyện khác.

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 cấp phép

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.