# Open Feishu Approval
Supported since Feishu version 7.3.0.
## Usage scenarios
In some scenarios, it is necessary to jump from the company's internal system or other mini programs to a specified page of Feishu Approval. At this time, you need to use applink to splice a page and call it in a reasonable scenario.
## Protocol
Feishu Approval uses the Applink to open the mini program protocol. For detailed information about AppLink, please refer to the document [Structure of AppLink](https://open.feishu.cn/document/uYjL24iN/ucjN1UjL3YTN14yN2UTN).
`https://applink.feishu.cn/client/mini_program/open`
## Parameters
**Field** | **Required** | **Description** |
| ------ | ------ | ------------------------------------------- |
| appId | Yes | The application ID of the approval, the value is:
Feishu tenant `cli_9cb844403dbb9108`
Lark tenant `cli_9c7cc8a9a9edd105`. |
| path | Yes | The path and related parameters of the approval page to jump to. See below for details. |
| mode | No | Required only in sidebar mode, with the value `mode=sidebar-semi`.
### Explanation of path parameters
Approval page | Mobile page path | PC page path | Supports PC sidebar
---|---|---|---
Application initiation page | `pages/approval-form/index?id=${approval definition id}` | `pc/pages/create-form/index?id=${approval definition id}` | Not supported
Document details page | `pages/detail/index?instanceId=${approval instance id or instance code}` | `pc/pages/in-process/index?instanceId=${approval instance id or instance code}` | Supported, same as Mobile page path
Approval center page | `pages/approval-list/index?selectIndex=${corresponding list index}`
List index enumeration values:
- Pending approval `0`
- Approved `1`
- CC to me `2`
- Initiated `3` | `pc/pages/${list path}/index`
List path enumeration values:
- Pending approval `in-process`
- Approved `approved`
- CC to me `cc-2-me`
- Initiated `requested` | Not supported
- Method to obtain approval instance code: Call the [Batch Get Approval Instance ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/list) API to get it.
- Method to obtain approval definition id: Open the editing page of an approval through the approval management backend and get it from the URL link:
## Opening methods
### Open in browser
To jump from the browser to the Feishu Approval application, you can directly route jump in the browser to the spliced applink address.
```js
const schema = 'https://applink.feishu.cn/client/mini_program/open?mode=appCenter&appId=cli_9cb844403dbb9108&width=1136&height=750&path=pc%2Fpages%2Fin-process%2Findex'
window.location.href = schema
window.open(schema)
```
### Mini program jump
To jump from a Feishu mini program to the Feishu Approval application, you need to use the client API [openSchema](https://open.larkoffice.com/document/client-docs/gadget/-web-app-api/navigation/openschema).
For example, to jump from another mini program to Feishu Approval and open the approval homepage:
```js
tt.openSchema({
schema: "https://applink.feishu.cn/client/mini_program/open?mode=appCenter&appId=cli_9cb844403dbb9108&width=1136&height=750&path=pc%2Fpages%2Fin-process%2Findex",
external: true,
success(res) {
console.log(JSON.stringify(res));
},
fail(res) {
console.log(`openSchema fail: ${JSON.stringify(res)}`);
}
});
```
## Usage exampleswarning
- In actual scenarios, please replace the corresponding path, instanceId, and other parameters with actual values.
- For the specific page path, it must be URL encoded, such as: `pages/detail/index?instanceId=123`→`pages%2Fdetail%2Findex%3FinstanceId%3D123`.
### Mobile examples
#### **Open approval document details page**
```
https://applink.feishu.cn/client/mini_program/open?appId=cli_9cb844403dbb9108&path=pages%2Fdetail%2Findex%3FinstanceId%3D7418929504369377284
```
#### **Open approval form page (initiation page)**
```
https://applink.feishu.cn/client/mini_program/open?appId=cli_9cb844403dbb9108&path=pages%2Fapproval-form%2Findex%3Fid%3D7418928911667068932
```
#### **Open approval list**
```
https://applink.feishu.cn/client/mini_program/open?appId=cli_9cb844403dbb9108&path=pages%2Fapproval-list%2Findex%3FselectIndex%3D0
```
### PC examples
#### **Open approval center details page**
```
https://applink.feishu.cn/client/mini_program/open?mode=appCenter&appId=cli_9cb844403dbb9108&path=pc%2Fpages%2Fin-process%2Findex%3FinstanceId%3D7418929504369377284
```
#### **Open approval list**
```
https://applink.feishu.cn/client/mini_program/open?mode=appCenter&appId=cli_9cb844403dbb9108&path=pc%2Fpages%2Fin-progress%2Findex
```
To open the approved approval list, you need to add the approved page path and reviewed parameter:
```
https://applink.feishu.cn/client/mini_program/open?mode=appCenter&appId=cli_9cb844403dbb9108&path=pc%2Fpages%2Fapproved%2Findex%3Ftab_name%3Dreviewed
```
#### **Open approval form page (initiation page)**
```
https://applink.feishu.cn/client/mini_program/open?mode=appCenter&appId=cli_9cb844403dbb9108&path=pc%2Fpages%2Fcreate-form%2Findex%3Fid%3D7418928911667068932
```
### PC sidebar/pager examples
#### **Open approval document details page**
**⚠️The sidebar needs to add the parameter mode=sidebar-semi, everything else is the same as the mobile end**:
```
https://applink.feishu.cn/client/mini_program/open?appId=cli_9cb844403dbb9108&mode=sidebar-semi&path=pages%2Fdetail%2Findex%3FinstanceId%3D7418929504369377284
```
