創作者中心
後台
學習
探索
商店
論壇
登入
建立
概覽
體驗
虛擬人偶
素材
開放式雲端
Roblox Studio 的最低規格要求已提升。
了解更多
建立
/
開放式雲端
/
Legacy APIs
中文(繁體)
回饋
Groups v1
*
此內容是使用 AI（Beta 測試版）翻譯，可能含有錯誤。若要以英文檢視此頁面，請按一下
這裡
。
基本網址
https://groups.roblox.com
JSON
下載
FeaturedContent
DELETE
/v1
/featured-content
/event
刪除群組的特色事件
GET
/v1
/featured-content
/event
取得群組的特色事件
POST
/v1
/featured-content
/event
為群組設置特色事件
Groups
GET
/v1
/groups
/{groupId}
取得群組資訊
GET
/v1
/groups
/{groupId}
/audit-log
取得群組的審計記錄
GET
/v1
/groups
/{groupId}
/name-history
取得群組的名稱變更歷史。
GET
/v1
/groups
/{groupId}
/settings
取得群組的設定
PATCH
/v1
/groups
/{groupId}
/settings
更新群組的設定
GET
/v1
/groups
/configuration
/metadata
取得群組配置上下文資訊
GET
/v1
/groups
/metadata
獲得群組上下文資訊：  使用者可以屬於的最大群組數量。  使用者目前是成員的群組數量。  是否基於裝置類型顯示/隱藏特定功能。
POST
/v1
/groups
/create
建立新的群組。
POST
/v1
/groups
/policies
獲取用於遵守的群組政策資訊。
PATCH
/v1
/groups
/{groupId}
/description
更新群組說明
PATCH
/v1
/groups
/{groupId}
/name
更新群組名稱。
PATCH
/v1
/groups
/{groupId}
/notification-preference
更新群組的設定
PATCH
/v1
/groups
/{groupId}
/status
設置群組狀態
PATCH
/v1
/groups
/icon
更新群組圖示。
Membership
DELETE
/v1
/groups
/{groupId}
/join-requests
批量拒絕群組加入請求
GET
/v1
/groups
/{groupId}
/join-requests
獲得群組的加入請求頁面。
POST
/v1
/groups
/{groupId}
/join-requests
批量接受群組加入請求
DELETE
/v1
/groups
/{groupId}
/join-requests
/users
/{userId}
拒絕/取消群組加入請求。
GET
/v1
/groups
/{groupId}
/join-requests
/users
/{userId}
獲得使用者ID的群組加入請求。
POST
/v1
/groups
/{groupId}
/join-requests
/users
/{userId}
接受群組加入請求。
GET
/v1
/groups
/{groupId}
/membership
在認証使用者的上下文中取得群組會員資訊
GET
/v1
/groups
/{groupId}
/roles
取得群組中的角色設置列表。
GET
/v1
/groups
/{groupId}
/roles
/{roleSetId}
/users
獲得特定角色集中的群組用戶列表。
GET
/v1
/groups
/{groupId}
/users
取得群組中的使用者列表。
POST
/v1
/groups
/{groupId}
/users
加入群組
GET
/v1
/user
/groups
/pending
獲得已驗證使用者要求加入的群組
GET
/v1
/users
/{userId}
/friends
/groups
/roles
獲得指定使用者朋友所屬的所有群組列表。
GET
/v1
/users
/{userId}
/groups
/roles
獲得指定使用者所屬群組的所有群組角色清單。
POST
/v1
/groups
/{groupId}
/change-owner
將群組所有者變更為另一位使用者。
POST
/v1
/groups
/{groupId}
/claim-ownership
以身份驗證的使用者擁有群組所有權
DELETE
/v1
/groups
/{groupId}
/users
/{userId}
從群組中移除使用者
PATCH
/v1
/groups
/{groupId}
/users
/{userId}
在群組中更新使用者角色。
Revenue
GET
/v1
/groups
/{groupId}
/payout-restriction
獲得指示是否可以使用付款功能的值
GET
/v1
/groups
/{groupId}
/payouts
獲得群組付款百分比的列表
POST
/v1
/groups
/{groupId}
/payouts
向使用者支付 Robux。
POST
/v1
/groups
/{groupId}
/payouts
/recurring
更新定期付款。
Relationships
GET
/v1
/groups
/{groupId}
/relationships
/{groupRelationshipType}
取得群組的關係
DELETE
/v1
/groups
/{groupId}
/relationships
/{groupRelationshipType}
/requests
批量拒絕群組會員請求
GET
/v1
/groups
/{groupId}
/relationships
/{groupRelationshipType}
/requests
獲得群組的關係請求
POST
/v1
/groups
/{groupId}
/relationships
/{groupRelationshipType}
/requests
批量接受群組附屬請求
DELETE
/v1
/groups
/{groupId}
/relationships
/{groupRelationshipType}
/{relatedGroupId}
刪除群組關係。
POST
/v1
/groups
/{groupId}
/relationships
/{groupRelationshipType}
/{relatedGroupId}
創建一個群關係。
DELETE
/v1
/groups
/{groupId}
/relationships
/{groupRelationshipType}
/requests
/{relatedGroupId}
拒絕群組關係請求。
POST
/v1
/groups
/{groupId}
/relationships
/{groupRelationshipType}
/requests
/{relatedGroupId}
接受群關係請求。
Permissions
GET
/v1
/groups
/{groupId}
/roles
/{roleSetId}
/permissions
獲得群組角色集的許可。授權用戶必須是群組所有者或要求的角色集，除了訪客角色，所有人(會員和訪客)都可以查看。
PATCH
/v1
/groups
/{groupId}
/roles
/{roleSetId}
/permissions
更新群組角色集的權限。授權用戶必須是群組所有者。
GET
/v1
/groups
/{groupId}
/roles
/guest
/permissions
獲得群組的訪客角色集的許可。這些可以由所有 (會員和訪客) 用戶查看。
GET
/v1
/groups
/{groupId}
/roles
/permissions
獲得每個角色的所有權限
GET
/v1
/groups
/{groupId}
/users
/{userId}
/permissions
獲得使用者在群組中的許可。只適用於群組所有者和 RCC
SocialLinks
GET
/v1
/groups
/{groupId}
/social-links
取得與群組相關的社交鏈接數據
POST
/v1
/groups
/{groupId}
/social-links
發布社交鏈接
DELETE
/v1
/groups
/{groupId}
/social-links
/{socialLinkId}
刪除社交鏈接
PATCH
/v1
/groups
/{groupId}
/social-links
/{socialLinkId}
更新社交鏈接
Wall
GET
/v1
/groups
/{groupId}
/wall
/posts
獲得群組牆貼的列表。
POST
/v1
/groups
/{groupId}
/wall
/posts
在群組牆上創建一個貼文
POST
/v1
/groups
/{groupId}
/wall
/subscribe
訂閱認證用戶接收群牆事件的通知。
DELETE
/v1
/groups
/{groupId}
/wall
/posts
/{postId}
刪除群組牆貼。
DELETE
/v1
/groups
/{groupId}
/wall
/users
/{userId}
/posts
刪除特定使用者所做的所有群牆文章。
GroupSearch
GET
/v1
/groups
/search
按關鍵字搜尋群組。
GET
/v1
/groups
/search
/lookup
按名稱查找群組。以準確匹配為第一個結果進行排序。
GET
/v1
/groups
/search
/metadata
獲得建議的群組和其他各種信息，需要用於群組/加入頁面的旗幟
Roles
GET
/v1
/roles
取得角色的ID。
PrimaryGroup
GET
/v1
/users
/{userId}
/groups
/primary
/role
取得使用者的主要群組。
DELETE
/v1
/user
/groups
/primary
移除認証使用者的主要群組
POST
/v1
/user
/groups
/primary
設定認証使用者的主要群組
RoleSets
POST
/v1
/groups
/{groupId}
/rolesets
/create
創建新的群組角色集。
DELETE
/v1
/groups
/{groupId}
/rolesets
/{rolesetId}
刪除現有群組角色集。
PATCH
/v1
/groups
/{groupId}
/rolesets
/{rolesetId}
更新現有群組角色集。
Models
Roblox.Groups.Api.ChangeOwnerRequest
Roblox.Groups.Api.CreateWallPostRequest
Roblox.Groups.Api.GroupAllRolesResponse
Roblox.Groups.Api.GroupAuditLogPageResponse[Roblox.Groups.Api.Models.Response.GroupAuditLogResponseItem]
Roblox.Groups.Api.GroupConfigurationDisplayOptionsResponse
Roblox.Groups.Api.GroupConfigurationResponse
Roblox.Groups.Api.GroupDescriptionResponse
Roblox.Groups.Api.GroupDetailResponse
Roblox.Groups.Api.GroupEconomyPermissionsModel
Roblox.Groups.Api.GroupForumsPermissionsModel
Roblox.Groups.Api.GroupJoinRequestResponse
Roblox.Groups.Api.GroupManagementPermissionsModel
Roblox.Groups.Api.GroupMembershipDetailResponse
Roblox.Groups.Api.GroupMembershipMetadataResponse
Roblox.Groups.Api.GroupMembershipPermissionsModel
Roblox.Groups.Api.GroupNameChangeConfigurationResponse
Roblox.Groups.Api.GroupNotificationPreferenceData
Roblox.Groups.Api.GroupOpenCloudPermissionsModel
Roblox.Groups.Api.GroupPayoutResponse
Roblox.Groups.Api.GroupPayoutRestrictionResponse
Roblox.Groups.Api.GroupPermissionsModel
Roblox.Groups.Api.GroupPermissionsResponse
Roblox.Groups.Api.GroupPoliciesResponse
Roblox.Groups.Api.GroupPolicyRequest
Roblox.Groups.Api.GroupPolicyResponse
Roblox.Groups.Api.GroupPostsPermissionsModel
Roblox.Groups.Api.GroupRelationshipsResponse
Roblox.Groups.Api.GroupRoleDetailResponse
Roblox.Groups.Api.GroupRoleResponse
Roblox.Groups.Api.GroupSearchMetadataResponse
Roblox.Groups.Api.GroupSearchPageResponse
Roblox.Groups.Api.GroupSearchResponseItem
Roblox.Groups.Api.GroupSettingsResponse
Roblox.Groups.Api.GroupsDisplayOptionsResponse
Roblox.Groups.Api.JoinGroupRequest
Roblox.Groups.Api.MembersRequest
Roblox.Groups.Api.Models.Request.CreateRoleSetRequest
Roblox.Groups.Api.Models.Request.UpdateRoleSetRequest
Roblox.Groups.Api.Models.Response.GroupAuditLogResponseItem
Roblox.Groups.Api.Models.Response.GroupNameHistoryResponseItem
Roblox.Groups.Api.Models.Response.GroupWallPostModel
Roblox.Groups.Api.Models.Response.UserModel
Roblox.Groups.Api.PayoutRecipientRequest
Roblox.Groups.Api.PayoutRequest
Roblox.Groups.Api.PostGroupStatusRequest
Roblox.Groups.Api.PrimaryGroupRequest
Roblox.Groups.Api.RecurringPayoutsConfigurationResponse
Roblox.Groups.Api.RelationshipsRequest
Roblox.Groups.Api.RoleConfigurationResponse
Roblox.Groups.Api.ShoutResponse
Roblox.Groups.Api.SocialLinkRequest
Roblox.Groups.Api.SocialLinkResponse
Roblox.Groups.Api.UpdateGroupDescriptionRequest
Roblox.Groups.Api.UpdateGroupNameRequest
Roblox.Groups.Api.UpdateGroupNameResponse
Roblox.Groups.Api.UpdateGroupNotificationPreferenceRequest
Roblox.Groups.Api.UpdateGroupSettingsRequest
Roblox.Groups.Api.UpdatePermissionsRequest
Roblox.Groups.Api.UpdateUserRoleRequest
Roblox.Groups.Api.UserGroupMembershipResponse
Roblox.Groups.Api.UserGroupRoleResponse
Roblox.Groups.Client.GroupFeaturedContentResponse
Roblox.Paging.ExclusiveStartKeyCursor[System.String]
Roblox.Paging.StartIndexCursor
Roblox.Platform.Core.ExclusiveStartPaging.IExclusiveStartKeyInfo[System.Int32]
Roblox.Platform.Core.ExclusiveStartPaging.IExclusiveStartKeyInfo[System.Int64]
Roblox.Web.Responses.Groups.GroupBasicResponse
Roblox.Web.Responses.Groups.GroupResponseV2
Roblox.Web.Responses.RelatedEntityTypeResponse[Roblox.Web.Responses.Groups.GroupOwnerType]
Roblox.Web.WebAPI.ApiEmptyResponseModel
Roblox.Web.WebAPI.ExclusiveStartRequest[System.Int32]
Roblox.Web.WebAPI.ExclusiveStartRequest[System.Int64]
Roblox.Web.WebAPI.Models.ApiArrayResponse[Roblox.Groups.Api.GroupDetailResponse]
Roblox.Web.WebAPI.Models.ApiArrayResponse[Roblox.Groups.Api.GroupMembershipDetailResponse]
Roblox.Web.WebAPI.Models.ApiArrayResponse[Roblox.Groups.Api.GroupPayoutResponse]
Roblox.Web.WebAPI.Models.ApiArrayResponse[Roblox.Groups.Api.GroupPermissionsResponse]
Roblox.Web.WebAPI.Models.ApiArrayResponse[Roblox.Groups.Api.GroupRoleDetailResponse]
Roblox.Web.WebAPI.Models.ApiArrayResponse[Roblox.Groups.Api.SocialLinkResponse]
Roblox.Web.WebAPI.Models.ApiArrayResponse[Roblox.Groups.Api.UserGroupMembershipResponse]
Roblox.Web.WebAPI.Models.ApiArrayResponse[Roblox.Web.Responses.Groups.GroupBasicResponse]
Roblox.Web.WebAPI.Models.ApiPageResponse[Roblox.Groups.Api.GroupJoinRequestResponse]
Roblox.Web.WebAPI.Models.ApiPageResponse[Roblox.Groups.Api.Models.Response.GroupNameHistoryResponseItem]
Roblox.Web.WebAPI.Models.ApiPageResponse[Roblox.Groups.Api.Models.Response.GroupWallPostModel]
Roblox.Web.WebAPI.Models.ApiPageResponse[Roblox.Groups.Api.Models.Response.UserModel]
Roblox.Web.WebAPI.Models.ApiPageResponse[Roblox.Groups.Api.UserGroupRoleResponse]
Roblox.Web.WebApi.FormData.IUploadedFile
System.IO.Stream
System.ValueTuple[Roblox.Web.WebAPI.ExclusiveStartRequest[System.Int64],Roblox.Paging.ExclusiveStartKeyCursor[System.String]]