使用Javascript SDK管理分組和成員-網盤與相簿服務-阿里雲

以下所有方法中的 options 參數是額外請求配置，詳見 AxiosRequestConfig。

createGroup 方法

重要

需要Admin許可權，或者分組管理員。

建立分組。

const result = await client.createGroup(params, options)

舉例

await client.createGroup({
  group_name: 'test',
  description: '',
  is_root: true
})

參數

欄位	類型	必選	說明
params	ICreatGroupReq	是	團隊名
options	AxiosRequestConfig		請求參數

ICreatGroupReq

欄位	類型	必選	說明
group_name	string	是	團隊名
description	string		團隊描述
is_root	boolean		是否root
parent_group_id	string		父group 與is_root互斥

欄位	類型	必選	說明
result	IGroupItem	是	結果

IGroupItem

名稱	位置	必選	說明
domain_id	string		域id
group_id	string		團隊id
group_name	string		團隊名
description	string		團隊描述
created_at	Date		建立時間
updated_at	Date		更新時間

deleteGroup 方法

重要

需要Admin許可權，或者分組管理員

刪除group。

await client.deleteGroup(params, options)

舉例

await client.deleteGroup({
   group_id: '0cbfe8de7d7645ea835b1b1a91101e4d'
})

參數

欄位	類型	必選	說明
params	Object	是	請求參數
options	AxiosRequestConfig		請求參數

params

欄位	類型	必選	說明
group_id	string	是	團隊id

無

updateGroup 方法

重要

需要Admin許可權，或者分組管理員

更新group。

await client.updateGroup(params, options)

舉例

await client.updateGroup({
   group_id: '0cbfe8de7d7645ea835b1b1a91101e4d',
    group_name: 'new_name',
   description: 'test'
})

參數

欄位	類型	必選	說明
params	IUpdateGroupReq	是	請求參數
options	AxiosRequestConfig		請求參數

IUpdateGroupReq

欄位	類型	必選	說明
group_id	string	是	團隊id
group_name	string		團隊名稱
description	string		是否root

欄位	類型	必選	說明
result	IGroupItem	是	結果

updateGroupName 方法

重要

需要Admin許可權，或者分組管理員

更新團隊名稱。

const result = await client.updateGroupName(params, options)

舉例

await client.updateGroupName({
   group_id: '0cbfe8de7d7645ea835b1b1a91101e4d',
   name: 'new_name'
})

參數

欄位	類型	必選	說明
params	IUpdateGroupNameReq	是	請求參數
options	AxiosRequestConfig		請求參數

IUpdateGroupNameReq

欄位	類型	必選	說明
group_id	string	是	團隊id
name	string		團隊名稱

欄位	類型	必選	說明
result	IGroupItem	是	結果

getGroup 方法

擷取group資訊。

const result = await client.getGroup(params, options)

舉例

const groupInfo = await client.getGroup({
   group_id: '0cbfe8de7d7645ea835b1b1a91101e4d'
})

參數

欄位	類型	必選	說明
params	Object	是	請求參數
options	AxiosRequestConfig		請求參數

params

名稱	類型	必選	說明
group_id	string	是	群id

欄位	類型	必選	說明
result	IGroupItem	是	結果

listGroups 方法

擷取group資訊

await client.listGroups(params, options)

舉例

await client.listGroups({
   limit: 100,
   marker:''
})

參數

欄位	類型	必選	說明
params	IListReq	是	請求參數
options	AxiosRequestConfig		請求參數

IListReq

名稱	類型	必選	說明
limit	number		返回資料最大條數,範圍:[1-100]，預設:100
marker	string		查詢起始標識

欄位	類型	必選	說明
result	IListRes	是	結果

IListRes

名稱	位置	必選	說明
items	IGroupItem[]		團隊列表
next_marker	string		下一次查詢的起始標識

searchGroups 方法

搜尋group 結果預設按照updated_at降序輸出。

await client.searchGroups(params, options)

const {items=[]} = await client.listGroups({
   limit: 100,
   marker:'',
   group_name: 'test_group_name'
})

參數

欄位	類型	必選	說明
params	Object	是	請求參數
options	AxiosRequestConfig		請求參數

params

名稱	類型	必選	說明
limit	number		返回資料最大條數,範圍:[1-100]，預設:100
marker	string		查詢起始標識
group_name	string		團隊名稱

欄位	類型	必選	說明
result	IListRes	是	結果

IListRes

名稱	類型	必選	說明
items	IGroupItem[]		團隊列表
next_marker	string		下一次查詢的起始標識

listMembers 方法

重要

需要Admin許可權，或者分組管理員

列舉一個 group 下的所有子 group或user。

await client.listMembers(params, options)

舉例

await client.listMembers({
   limit: 100,
   marker:'',
   group_id: '0cbfe8de7d7645ea835b1b1a91101e4d',
   member_type: 'group'
})

參數

欄位	類型	必選	說明
params	Object	是	請求參數
options	AxiosRequestConfig		請求參數

params

名稱	類型	必選	說明
limit	number		返回資料最大條數,範圍:[1-100]，預設:100
marker	string		查詢起始標識
group_id	string	是	團隊id
member_type	string	是	群成員類型： 1、user：子使用者 2、group：子群組

欄位	類型	必選	說明
result	IListRes	是	結果

IListRes

名稱	類型	說明
items	array	團隊或者使用者列表
next_marker	string	下一次查詢的起始標識

createMembership 方法

重要

需要Admin許可權，或者分組管理員

建立membership

const result = await client.createMembership(params, options)

舉例

await client.createMembership({
      user_id: 'test',
      member_type: 'user',
      member_role: 'member',
      group_id: '0cbfe8de7d7645ea835b1b1a91101e4d',
    })

參數

欄位	類型	必選	說明
params	IMembershipReq	是	請求參數
options	AxiosRequestConfig		請求參數

IMembershipReq

欄位	類型	必選	說明
group_id	string	是	群id
user_id	string	Y1	使用者id
sub_group_id	string	Y1	子群id（不能是root group）
member_type	string	是	群成員類型： 1、user：子使用者 2、group：子群組
member_role	string	是	群成員角色： 1、member：普通群成員 2、admin：群管理員，可以增刪member（暫不支援） 3、owner：群所有者（暫時不支援）
description	string		群描述
is_root	bool		true則為頂層目錄

Y1: user_id 和sub_group_id 互斥必選一個。

欄位	類型	必選	說明
result	IMembershipItem	是	結果

IMembershipItem

名稱	位置	說明
domain_id	string	域id
group_id	string	群id
user_id	string	使用者id
sub_group_id	string	子群id
member_type	string	群成員類型
member_role	string	群成員角色
description	string	描述
created_at	Date	建立時間
updated_at	Date	更新時間

deleteMembership 方法

重要

需要Admin許可權，或者分組管理員

刪除membership

await client.deleteMembership(params, options)

舉例

await client.deleteMembership({
      user_id: 'test',
      member_type: 'user',
      group_id: '0cbfe8de7d7645ea835b1b1a91101e4d',
    })

參數

欄位	類型	必選	說明
params	IMembershipReq	是	請求參數
options	AxiosRequestConfig		請求參數

IMembershipReq

欄位	類型	必選	說明
group_id	string	是	群id
user_id	string	Y1	使用者id
sub_group_id	string	Y1	子群id（不能是root group）
member_type	string	是	群成員類型： 1、user：子使用者 2、group：子群組

Y1: user_id 和sub_group_id 互斥必選一個。

無

updateMembership 方法

重要

需要Admin許可權，或者分組管理員

更新membership

await client.updateMembership(params, options)

舉例

await client.updateMembership({
      user_id: 'test',
      member_type: 'user',
      member_role: 'member',
      group_id: '0cbfe8de7d7645ea835b1b1a91101e4d',
    })

參數

欄位	類型	必選	說明
params	IMembershipReq	是	請求參數
options	AxiosRequestConfig		請求參數

IMembershipReq

欄位	類型	必選	說明
group_id	string	是	群id
user_id	string	Y1	使用者id
sub_group_id	string	Y1	子群id（不能是root group）
member_type	string	是	群成員類型： 1、user：子使用者 2、group：子群組
member_role	string	是	群成員角色： 1、member：普通群成員 2、admin：群管理員，可以增刪member（暫不支援） 3、owner：群所有者（暫時不支援）
description	string		群描述

Y1: user_id 和sub_group_id 互斥必選一個。

欄位	類型	必選	說明
result	IMembershipItem	是	結果

getMembership 方法

重要

需要Admin許可權，或者分組管理員

查詢 Membership。

const result = await client.getMembership(params, options)

舉例

const info = await client.getMembership({
      user_id: 'test',
      member_type: 'user',
      group_id: '0cbfe8de7d7645ea835b1b1a91101e4d',
})

參數

欄位	類型	必選	說明
params	Object	是	請求參數
options	AxiosRequestConfig		請求參數

params

名稱	類型	必選	說明
group_id	string	是	群id
user_id	string	Y1	使用者id
sub_group_id	string	Y1	子群id
member_type	string	是	群成員類型

Y1: user_id 和sub_group_id 互斥必選一個。

欄位	類型	必選	說明
result	IMembershipItem	是	結果

listDirectChildMemberships 方法

重要

需要Admin許可權，或者分組管理員

列舉直接子成員。

const result= await client.listDirectChildMemberships(params, options)

舉例

const {items=[]} = await client.listDirectChildMemberships({
  group_id:'',
  marker: '',
  member_type: 'user',
  limit: 100,
});

參數

欄位	類型	必選	說明
params	Object	是	請求參數
options	AxiosRequestConfig		請求參數

params

欄位	類型	必選	說明
limit	number		返回資料最大條數,範圍:[1-100]，預設:100
marker	string		查詢起始標識
group_id	string	是	要列舉哪一層group。 ""表示列舉頂層的目錄，否則需要傳入正確的group_id並列舉這個group下的成員
member_type	string		群成員類型 group：只返回group user：只返回user 空：返回group和user

欄位	類型	必選	說明
result	IListRes	是	結果

IListRes

名稱	位置	說明
items	IMembershipItem[]	成員數組
next_marker	string

listDirectParentMemberships 方法

重要

需要Admin許可權，或者分組管理員

擷取群成員所在的直接上一級的群列表。

const result = await client.listDirectParentMemberships(params, options)

舉例

const {items=[]} = await client.listDirectParentMemberships({
    user_id:'123456789',
      marker: '',
      member_type: 'user',
      limit: 100,
    })

參數

欄位	類型	必選	說明
params	Object	是	請求參數
options	AxiosRequestConfig		請求參數

params

欄位	類型	必選	說明
limit	number		返回資料最大條數,範圍:[1-100]，預設:100
marker	string		查詢起始標識
sub_group_id	string	Y1	子群id。sub_group_id 和user_id 必選一個
user_id	string	Y1	使用者id。 sub_group_id 和user_id 必選一個
member_type	string		群成員類型, 取值範圍： group \| user

Y1: user_id 和sub_group_id 互斥必選一個。

欄位	類型	必選	說明
result	IListRes	是	結果

IListRes

名稱	位置	說明
items	IMemberShipRes[]	成員數組
next_marker	string

hasMember 方法

重要

需要Admin許可權，或者分組管理員

群成員關係判定

如果user所在group超過100個，同理對應到其上級上上級group等所在的supergroup個數，均要求在100個內，否在可能判定不準確。

const result = await client.hasMember(params, options)

舉例

const hasUsre = await client.hasMember({
    user_id:'123456789',
    member_type: 'user',
    group_id: '123',
})


const hasGroup = await client.hasMember({
    sub_group_id:'123456789',
    member_type: 'group',
    group_id: '123',
})

參數

欄位	類型	必選	說明
params	Object	是	請求參數
options	AxiosRequestConfig		請求參數

params

欄位	類型	必選	說明
group_id	string	是	群id
user_id	string	Y1	使用者id
sub_group_id	string	Y1	子群id，與 user_id 互斥
member_type	string		群成員類型, 取值範圍： group \| user

Y1: user_id 和sub_group_id 互斥必選一個。

名稱

位置

必選

說明

result

boolean

true: member屬於group

false：不屬於

createGroup 方法

舉例

參數

返回

deleteGroup 方法

舉例

參數

返回

updateGroup 方法

舉例

參數

返回

updateGroupName 方法

舉例

參數

返回

getGroup 方法

舉例

參數

返回

listGroups 方法

舉例

參數

返回

searchGroups 方法

參數

返回

listMembers 方法

舉例

參數

返回

createMembership 方法

舉例

參數

返回

deleteMembership 方法

舉例

參數

返回

updateMembership 方法

舉例

參數

返回

getMembership 方法

舉例

參數

返回

listDirectChildMemberships 方法

舉例

參數

返回

listDirectParentMemberships 方法

舉例

參數

返回

hasMember 方法

舉例

參數

返回