user

package
v1.0.0-beta.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 16, 2020 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package user 用户管理

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func Add 

func Add(ctx *feishu.App, payload []byte) (resp []byte, err error)

新增用户

该接口用于向通讯录中新增用户。

**权限说明** ：调用该接口需要申请 更新通讯录 以及 以应用身份访问通讯录 权限。新增用户的所有部门必须都在当前应用的通讯录授权范围内才允许新增用户。应用商店应用无权限调用此接口。

See: https://open.feishu.cn/document/ukTMukTMukTM/uMzNz4yM3MjLzczM

POST https://open.feishu.cn/open-apis/contact/v1/user/add

Example 
package main

import (
	"fmt"

	"github.com/ylck/feishu"
	"github.com/ylck/feishu/apis/contact/user"
)

func main() {
	var ctx *feishu.App

	payload := []byte("{}")
	resp, err := user.Add(ctx, payload)

	fmt.Println(resp, err)
}

Output:

func BatchGet 

func BatchGet(ctx *feishu.App, params url.Values) (resp []byte, err error)

批量获取用户信息

该接口用于批量获取用户详细信息。

**权限说明** : 调用该接口需要申请“以应用身份访问通讯录”以及[用户数据权限](https://open.feishu.cn/document/ukTMukTMukTM/uQjN3QjL0YzN04CN2cDN)。请求的用户如果在当前应用的通讯录授权范围内，会返回该用户的详细信息；否则不会返回。

See: https://open.feishu.cn/document/ukTMukTMukTM/uIzNz4iM3MjLyczM

GET https://open.feishu.cn/open-apis/contact/v1/user/batch_get?employee_ids=2fab1234&employee_ids=2f1234cd

Example 
package main

import (
	"fmt"
	"net/url"

	"github.com/ylck/feishu"
	"github.com/ylck/feishu/apis/contact/user"
)

func main() {
	var ctx *feishu.App

	params := url.Values{}
	resp, err := user.BatchGet(ctx, params)

	fmt.Println(resp, err)
}

Output:

func BatchGetId 

func BatchGetId(ctx *feishu.App, params url.Values) (resp []byte, err error)

使用手机号或邮箱获取用户 ID

ID

根据用户邮箱或手机号查询用户 open_id 和 user_id，支持批量查询。 调用该接口需要申请 通过手机号或者邮箱获取用户ID 权限。

:::warnning 只能查询到应用可用性范围内的用户 ID，不在范围内的用户会表现为不存在。 :::

See: https://open.feishu.cn/document/ukTMukTMukTM/uUzMyUjL1MjM14SNzITN

GET https://open.feishu.cn/open-apis/user/v1/batch_get_id?emails=lisi@z.com&emails=wangwu@z.com&mobiles=13812345678&mobiles=%2b12126668888

Example 
package main

import (
	"fmt"
	"net/url"

	"github.com/ylck/feishu"
	"github.com/ylck/feishu/apis/contact/user"
)

func main() {
	var ctx *feishu.App

	params := url.Values{}
	resp, err := user.BatchGetId(ctx, params)

	fmt.Println(resp, err)
}

Output:

func Delete 

func Delete(ctx *feishu.App, payload []byte) (resp []byte, err error)

删除用户

该接口用于从通讯录中删除用户。

**权限说明** : 调用该接口需要申请 更新通讯录 以及 以应用身份访问通讯录 权限。应用需要有待删除用户、待删除用户的所有部门的通讯录权限才能删除该用户。应用商店应用无权限调用接口。

See: https://open.feishu.cn/document/ukTMukTMukTM/uUzNz4SN3MjL1czM

POST https://open.feishu.cn/open-apis/contact/v1/user/delete

Example 
package main

import (
	"fmt"

	"github.com/ylck/feishu"
	"github.com/ylck/feishu/apis/contact/user"
)

func main() {
	var ctx *feishu.App

	payload := []byte("{}")
	resp, err := user.Delete(ctx, payload)

	fmt.Println(resp, err)
}

Output:

func DepartmentUserDetailList 

func DepartmentUserDetailList(ctx *feishu.App, params url.Values) (resp []byte, err error)

获取部门用户详情

该接口用于获取部门用户详情信息。 **权限说明**：调用该接口需要申请 获取部门组织架构信息 和 以应用身份访问通讯录 权限，同时根据需要返回字段申请对应的[用户数据权限]。应用需要有被调用部门的通讯录授权。(https://open.feishu.cn/document/ukTMukTMukTM/uQjN3QjL0YzN04CN2cDN)

See: https://open.feishu.cn/document/ukTMukTMukTM/uYzN3QjL2czN04iN3cDN

GET https://open.feishu.cn/open-apis/contact/v1/department/user/detail/list?department_id=TT-1234&page_size=10&fetch_child=true

Example 
package main

import (
	"fmt"
	"net/url"

	"github.com/ylck/feishu"
	"github.com/ylck/feishu/apis/contact/user"
)

func main() {
	var ctx *feishu.App

	params := url.Values{}
	resp, err := user.DepartmentUserDetailList(ctx, params)

	fmt.Println(resp, err)
}

Output:

func DepartmentUserList 

func DepartmentUserList(ctx *feishu.App, params url.Values) (resp []byte, err error)

获取部门用户列表

该接口用于获取部门用户列表。 **权限说明**：调用该接口需要申请 获取部门组织架构信息 和 以应用身份访问通讯录 权限。应用需要有被调用部门的通讯录授权

See: https://open.feishu.cn/document/ukTMukTMukTM/uEzNz4SM3MjLxczM

GET https://open.feishu.cn/open-apis/contact/v1/department/user/list?department_id=TT-1234&page_size=100&fetch_child=true

Example 
package main

import (
	"fmt"
	"net/url"

	"github.com/ylck/feishu"
	"github.com/ylck/feishu/apis/contact/user"
)

func main() {
	var ctx *feishu.App

	params := url.Values{}
	resp, err := user.DepartmentUserList(ctx, params)

	fmt.Println(resp, err)
}

Output:

func RoleList 

func RoleList(ctx *feishu.App) (resp []byte, err error)

获取角色列表

该接口用于获取企业的用户角色列表。

**权限说明** ：调用该接口需要申请 获取角色 和 以应用身份访问通讯录 权限

See: https://open.feishu.cn/document/ukTMukTMukTM/uYzMwUjL2MDM14iNzATN

GET https://open.feishu.cn/open-apis/contact/v2/role/list

Example 
package main

import (
	"fmt"

	"github.com/ylck/feishu"
	"github.com/ylck/feishu/apis/contact/user"
)

func main() {
	var ctx *feishu.App

	resp, err := user.RoleList(ctx)

	fmt.Println(resp, err)
}

Output:

func RoleMembers 

func RoleMembers(ctx *feishu.App, params url.Values) (resp []byte, err error)

获取角色成员列表

该接口用于获取角色下的用户列表。

**权限说明** ：调用该接口需要申请 获取角色 和 以应用身份访问通讯录 权限。角色内不在当前应用通讯录授权范围内的用户不会返回。

See: https://open.feishu.cn/document/ukTMukTMukTM/uczMwUjL3MDM14yNzATN

GET https://open.feishu.cn/open-apis/contact/v2/role/members?role_id=or_846ea69995a259a27cc690182f27de87&page_size=2&page_token=763bd1e74d05e958

Example 
package main

import (
	"fmt"
	"net/url"

	"github.com/ylck/feishu"
	"github.com/ylck/feishu/apis/contact/user"
)

func main() {
	var ctx *feishu.App

	params := url.Values{}
	resp, err := user.RoleMembers(ctx, params)

	fmt.Println(resp, err)
}

Output:


func Search(ctx *feishu.App, params url.Values, accessToken string) (resp []byte, err error)

搜索用户

以用户身份搜索其他用户的信息，无法搜索到外部企业或已离职的用户。 调用该接口需要申请 搜索用户 权限。

See: https://open.feishu.cn/document/ukTMukTMukTM/uMTM4UjLzEDO14yMxgTN

GET https://open.feishu.cn/open-apis/search/v1/user?query=zhangsan&page_size=20&page_token=20

func UnionIdBatchGetList 

func UnionIdBatchGetList(ctx *feishu.App, params url.Values) (resp []byte, err error)

使用统一 ID 获取用户 ID

ID 获取用户 ID 使用统一 ID 获取用户 ID信息。 调用该接口需要具有 获取用户统一ID 权限。

See: https://open.feishu.cn/document/ukTMukTMukTM/uUTO5UjL1kTO14SN5kTN

GET https://open.feishu.cn/open-apis/user/v1/union_id/batch_get/list?union_ids=on_94a1ee5551019f18cd73d9f111898cf2&union_ids=on_42f2ef9d07319a4d96fffd7ef5cbfc79

Example 
package main

import (
	"fmt"
	"net/url"

	"github.com/ylck/feishu"
	"github.com/ylck/feishu/apis/contact/user"
)

func main() {
	var ctx *feishu.App

	params := url.Values{}
	resp, err := user.UnionIdBatchGetList(ctx, params)

	fmt.Println(resp, err)
}

Output:

func Update 

func Update(ctx *feishu.App, payload []byte) (resp []byte, err error)

更新用户信息

该接口用于更新通讯录中用户信息。

**权限说明** : 调用该接口需要申请 更新通讯录 以及 以应用身份访问通讯录 权限。应用需要拥有待更新用户的通讯录授权，如果涉及到用户部门变更，还需要同时拥有所有新部门的通讯录授权。应用商店应用无权限调用此接口。

See: https://open.feishu.cn/document/ukTMukTMukTM/uQzNz4CN3MjL0czM

POST https://open.feishu.cn/open-apis/contact/v1/user/update

Example 
package main

import (
	"fmt"

	"github.com/ylck/feishu"
	"github.com/ylck/feishu/apis/contact/user"
)

func main() {
	var ctx *feishu.App

	payload := []byte("{}")
	resp, err := user.Update(ctx, payload)

	fmt.Println(resp, err)
}

Output:

Types

This section is empty.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.