Feishu Open Platform

https://open.feishu.cn/document/
Admin
Feishu Open Platform provides comprehensive documentation, APIs, and tools for developers to build,...
Tokens:2,681,428
Snippets:15,241
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install Go SDK with go get

Source: https://open.feishu.cn/document/server-side-sdk/golang-sdk-guide/preparations

Installs the Go SDK for Feishu (Lark) using the go get command. Run this command in your terminal after setting up the Go environment.

```bash
go get -u github.com/larksuite/oapi-sdk-go/v3@latest
```

--------------------------------

### Install Feishu SDK for Golang

Source: https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-subscription-configure-/request-url-configuration-case

Install the Feishu SDK for Golang using the go get command. This is the first step before using the SDK in your project.

```bash
go get -u github.com/larksuite/oapi-sdk-go/v3
```

--------------------------------

### Initialize module and run Go example

Source: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/authentication-management/access-token/get-user-access-token-v3

Commands to initialize the Go module, fetch required dependencies, and run the example server. Execute in the directory containing main.go.

```bash
go mod init oauth-test
go get github.com/gin-gonic/gin
go get github.com/gin-contrib/sessions
go get github.com/gin-contrib/sessions/cookie
go get github.com/joho/godotenv
go get golang.org/x/oauth2
go run main.go
```

--------------------------------

### Java signature verification example

Source: https://open.feishu.cn/document/ukTMukTMukTM/uYzMxEjL2MTMx4iNzETM

Java code that starts computing the SHA-1 signature for message card callback verification. It concatenates timestamp, nonce, token, and body, and begins the MessageDigest setup. The snippet is incomplete as shown in the source.

```java
import org.apache.commons.codec.binary.Hex;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
class Main {
    public String calculateSignature(String timestamp, String nonce, String token, String body) throws NoSuchAlgorithmException {
        StringBuilder content = new StringBuilder();
        content.append(timestamp).append(nonce).append(token).append(body);
        MessageDigest alg = MessageDigest.getInstance("SHA-1");
        String sig =

```

--------------------------------

### workGroup JSON Example

Source: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/get

JSON example for the workGroup control. The value contains name, start, end, interval, and reason fields. start and end are in RFC3339 format.

```json
{
    "id": "widget1",
    "name": "work",
    "type": "workGroup",
    "value": {
         "name": "Overtime pay"
         "start": "2019-10-01T08:12:01+08:00",
         "end": "2019-10-02T08:12:01+08:00",
         "interval": 2.0,
         "reason": "ask for leave"
     }
}
```

--------------------------------

### Initialize project dependencies

Source: https://open.feishu.cn/document/base-extensions/base-table-view-extension-development-guide

Navigates to the project directory and installs dependencies using npm. Run this after creating the project to set up the development environment.

```bash
cd ${app-dir}/${view-dir} 
npm install
```

--------------------------------

### Enter web-app directory and install dependencies

Source: https://open.feishu.cn/document/home/department-personnel-management-based-on-web-app/step-2-download-and-run-sample-code

Enters the web-app directory and installs the dependency package using npm.

```bash
cd web-app/
npm install
```

--------------------------------

### Go SDK Request Example

Source: https://open.feishu.cn/document/corehr-v1/job-management/job_grade/patch

Initial setup for the Go SDK to interact with the CoreHR job grade API.

```go
package main
import (
"context"
"fmt"
"github.com/larksuite/
oapi-sdk-go/v3"
"github.com/larksuite/
oapi-sdk-go/v3/core"
"github.com/larksuite/
oapi-sdk-go/v3/service/corehr/
v2"
)
// SDK 使用文档：https://open.
feishu.cn/document/uAjLw4CM/
```

--------------------------------

### Request body example for Store applications get tenant_access_token

Source: https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/tenant_access_token

Example request body for the Store applications get tenant_access_token API. It includes the app_access_token and tenant_key fields, both required.

```json
{
    "app_access_token": "a-32bd8551db2f081cbfd26293f27516390b9feb04",
    "tenant_key": "73658811060f175d"
}
```

--------------------------------

### leaveGroup JSON Example

Source: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/get

JSON example for the leaveGroup control. The value contains name, start, end, and interval fields. start and end are in RFC3339 format, interval is the duration in days.

```json
{
    "id": "widget1",
    "name": "leave",
    "type": "leaveGroup",
    "value": {
         "name": "annual leave"
         "start": "2019-10-01T00:00:00+08:00",
         "end": "2019-10-02T00:0:00+08:00",
         "interval": 2.0
     }
}
```

--------------------------------

### Service.User.getUserinfo - Calling and Return Examples

Source: https://open.feishu.cn/document/client-docs/docs-add-on/05-api-doc/service/User/Service.User.getUserinfo

Calling example: initializes the BlockitClient and calls getUserInfo, logging the returned userInfo. Return example: shows the structure of the UserInfo object returned asynchronously.

```javascript
const DocMiniApp = new BlockitClient().initAPI();
DocMiniApp.Service.User.getUserInfo()
  .then((userInfo) => {
    console.log('debug', userInfo);
  })
```

```json
{
    "nickName": "",
    "avatarUrl": "",
    "gender": "male",
    "country": "CN",
    "city": "",
    "language": "zh_CN",
    "tenantId": "1"
}
```

--------------------------------

### Response body example for Batch Get Cost Reports

Source: https://open.feishu.cn/document/payroll-v1/cost_allocation_report/list

Example response body for the Batch Get Cost Reports API. Shows the structure with code, msg, and data fields, including pay_period, page_token, has_more, cost_allocation_report_names, and cost_allocation_report_datas. The example is truncated in the source.

```json
{
"code": 0,
"msg": "success",
"data": {
"pay_period": "2023-11",
"page_token": "6823630319749580302",
"has_more": true,
"cost_allocation_report_names": [
{
"locale": "zh_cn",
"value": "名称"
}
],
"cost_allocation_report_datas": [
{
"data_summary_dimensions": [
{
"dimension_level": 1,
"dimension_type": 1,
"dimension_value_id": "6823630319749580306",
```

--------------------------------

### GET /open-apis/task/v2/custom_fields/{custom_field_guid}

Source: https://open.feishu.cn/document/task-v2/custom_field/get

This snippet documents the GET endpoint for retrieving a custom field by its GUID.

```APIDOC
## [GET] /open-apis/task/v2/custom_fields/{custom_field_guid}

### Description
Retrieves details of a specific custom field by its GUID.

### Method
GET

### Endpoint
/open-apis/task/v2/custom_fields/{custom_field_guid}

### Parameters
#### Path Parameters
- **custom_field_guid** (string) - Required - The GUID of the custom field to retrieve.

#### Query Parameters
- **user_id_type** (string) - Optional - The type of user ID to return in the response. Possible values include `open_id`.

### Request Example
No request body is required for this GET request.

### Response
#### Success Response (200)
- **code** (int) - Error code, zero indicates success.
- **msg** (string) - Error description.
- **data** (object) - The custom field data.

#### Response Example
{
  "code": 0,
  "msg": "success",
  "data": {}
}

### Error Codes
| HTTP Status Code | Error Code | Description | Troubleshooting Suggestions |
|---|---|---|---|
| 400 | 1470400 | The request parameter is incorrect, such as the input custom_field_guid is not valid. | Check the returned msg to determine the specific error reasons. |
| 403 | 1470403 | Missing permission to read custom field. | Confirm that the calling identity has permission to read custom fields. |
| 404 | 1470404 | The custom field to view does not exist. | Verify that the custom field you want to view exists. |
| 500 | 1470500 | Server error. | Try retrying the call. If it continues to fail, please contact support for feedback. |
```

--------------------------------

### Go SDK example for listing tasklists of a task

Source: https://open.feishu.cn/document/task-v2/task/tasklists

This Go SDK code example shows how to call the List Tasklists API. It imports the necessary SDK packages and sets up the client. The example is incomplete as it only shows the package main and imports, with a comment pointing to the SDK documentation.

```Go
package main
import (
"context"
"fmt"
"github.com/larksuite/
oapi-sdk-go/v3"
"github.com/larksuite/
oapi-sdk-go/v3/core"
"github.com/larksuite/
oapi-sdk-go/v3/service/task/v2"
)
// SDK 使用文档：https://open.
feishu.cn/document/uAjLw4CM/
ukTMukTMukTM/server-side-sdk/
```

--------------------------------

### Response body example for Get personal information

Source: https://open.feishu.cn/document/server-docs/corehr-v1/employee/person/get

Response body example for the 'Get personal information' API. Shows a successful response with code 0 and msg 'success', including the person object with fields such as phone_number, legal_name, preferred_name, id, and name_list. The example is truncated in the source.

```json
{
"code": 0,
"msg": "success",
"data": {
"person": {
"phone_number": "11111111111",
"legal_name": "张三",
"preferred_name": "张四",
"id": "646465654545",
"name_list": [
{
"local_primary": "黄",
"local_first_name": "四",
"country_region_id": "6862995757234914824",
"name_type": {
"enum_name": "phone_type",
"display": [
{
"lang": "zh-CN",
"value": "刘梓新"
}
]
}
}
]
}
}
}
```

--------------------------------

### Go SDK Request Example for Get Department

Source: https://open.feishu.cn/document/server-docs/contact-v3/department/get

Example using the Go SDK to call the Get Department API. It creates a client with app credentials, builds a request with department ID 'D096', and invokes the API. Note that the example does not set user_id_type or department_id_type, so defaults apply.

```go
import (
	"context"
	"github.com/larksuite/oapi-sdk-go/v3"
	"github.com/larksuite/oapi-sdk-go/v3/service/contact/v3"
)
func main() {
	client := lark.NewClient("appID", "appSecret")
	req := larkcontact.NewGetDepartmentReqBuilder().
		DepartmentId(`D096`).
		Build()
	resp, err := client.Contact.Department.Get(context.Background(), req)
}
```

--------------------------------

### Go SDK request example for search_launchable

Source: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/search_launchable

Go SDK example for searching launchable approval definitions. The code is incomplete in the source, showing only the package declaration, imports, and a comment pointing to the SDK documentation.

```go
package main
import (
	"context"
	"fmt"
	"github.com/larksuite/
oapi-sdk-go/v3"
	"github.com/larksuite/
oapi-sdk-go/v3/core"
	"github.com/larksuite/
oapi-sdk-go/v3/service/
approval/v4"
)
// SDK 使用文档：https://open.
feishu.cn/document/uAjLw4CM/
```

--------------------------------

### Response body example for Get Root Folder Meta

Source: https://open.feishu.cn/document/server-docs/docs/drive-v1/folder/get-root-folder-meta

Example response body for the Get Root Folder Meta API. It returns the folder token, folder ID, and the owner's user ID.

```json
{
  "code": 0,
  "msg": "Success",
  "data": {
    "token": "nodbcbHUdOsS613xVzTzFEabcef",
    "id": "7110173013420512356",
    "user_id": "7103496998321312356"
	}
}
```

--------------------------------

### Verify installation with opdev help

Source: https://open.feishu.cn/document/tools-and-resources/development-tools/ide-with-commands

Verifies the CLI installation by running the help command. The expected output shows the toolset name, usage, and available account-related commands.

```bash
$ opdev help

```

```text
opdev: Feishu Open Platform Developer Toolset
USAGE
  $ opdev [COMMAND]
COMMANDS
Account related
  login     Login with feishu account
  logout    Log out of the Feishu account
  ....

```

--------------------------------

### Go SDK request example for Batch Get Cost Reports

Source: https://open.feishu.cn/document/payroll-v1/cost_allocation_report/list

Go SDK example for batch getting cost reports. The code is truncated in the source, showing only the import statements and a comment referencing the SDK documentation.

```go
package main
import (
"context"
"fmt"
"github.com/larksuite/
oapi-sdk-go/v3"
"github.com/larksuite/
oapi-sdk-go/v3/core"
"github.com/larksuite/
oapi-sdk-go/v3/service/payroll/
v1"
)
// SDK 使用文档：https://open.
feishu.cn/document/uAjLw4CM/
```

--------------------------------

### Install dependencies with npm install

Source: https://open.feishu.cn/document/quickly-develop-a-web-app-nodejs/step-2-download-and-run-sample-code

Navigates into the unzipped sample code directory and installs the project dependencies using npm.

```bash
cd web_app_quick_start/
npm install
```

--------------------------------

### Run the sample code

Source: https://open.feishu.cn/document/agile-project-cycle-management-based-on-bitable/experience-the-app

Executes the main Python script to run the sample code, which calls all interfaces mentioned in the tutorial.

```bash
python3 bitable_calendar.py
```
Tokens:
Raw