创建三方审批定义

POST

https://open.feishu.cn/open-apis/approval/v4/external_approvals

审批定义是审批的描述，包括审批名称、图标、描述等基础信息。创建好审批定义，用户就可以在审批应用的发起页中看到审批，如果用户点击发起，则会跳转到配置的发起三方系统地址去发起审批。

另外，审批定义还配置了审批操作时的回调地址：审批人在待审批列表中进行【同意】【拒绝】操作时，审批中心会调用回调地址通知三方系统。

注意，审批中心不负责审批流程的流转，只负责展示、操作、消息通知。因此审批定义创建时没有审批流程的信息。

错误码

HTTP状态码	错误码	描述	排查建议
400	1390001	param is invalid	参数错误
400	1395001	There have been some errors. Please try again later	服务出现错误，请稍候再试

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://open.feishu.cn/open-apis/approval/v4/external_approvals?department_id_type=open_department_id&user_id_type=open_id' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "approval_name": "@i18n@1",
    "approval_code": "permission_test",
    "group_code": "work_group",
    "group_name": "@i18n@2",
    "external": {
        "create_link_pc": "https://applink.feishu.cn/client/mini_program/open?mode=appCenter&appId=cli_9c90fc38e07a9101&path=pc%2Fpages%2Fcreate-form%2Findex%3Fid%3D9999",
        "create_link_mobile": "https://applink.feishu.cn/client/mini_program/open?appId=cli_9c90fc38e07a9101&path=pages%2Fapproval-form%2Findex%3Fid%3D9999",
        "support_pc": true,
        "support_mobile": true,
        "support_batch_read": false,
        "action_callback_url":"http://feishu.cn/approval/openapi/operate",
        "action_callback_token":"sdjkljkx9lsadf110",
        "action_callback_key":"gfdqedvsadfgfsd",
        "enable_mark_readed": false
    },
    "i18n_resources":[
     {
        "locale":"zh-CN",
        "is_default":true,
         "texts":[
             {
             "key": "@i18n@1",
             "value":"people"  
            },
            {
             "key": "@i18n@2",
             "value":"hr"  
            }
         ]
      }
    ],
    "viewers": [
        {
            "viewer_type": "TENANT"
        }
    ],
    "managers":["96449fb3"]
}'

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "approval_code": "C30381C8-7A5F-4717-A9CF-C233BF0202D4"
  }
}

请求参数

Query 参数

department_id_type

string

可选

此次调用中使用的部门ID的类型

示例值:

open_department_id

user_id_type

string

可选

用户 ID 类型

示例值:

open_id

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

Body 参数application/json

approval_name

string

必需

审批定义名称，创建审批定义返回的值，表示该实例属于哪个流程；该字段会影响到列表中该实例的标题，标题取自对应定义的 name 字段。示例值："@i18n@1"

approval_code

string

必需

审批定义 code，用户自定义，定义的唯一标识，如果不存在该 code，则创建，否则更新示例值："permission_test"

group_code

string

必需

审批定义所属审批分组，用户自定义；如果group_code当前不存在，则会新建审批分组；如果group_code已经存在，则会使用group_name更新审批分组名称示例值："work_group"

group_name

string

必需

分组名称，值的格式是 i18n key，文案放在 i18n_resource；如果是 group_code 当前不存在，则该 group_name 必填，否则，如果填写了则会更新分组名称，不填则不更新分组名称；审批发起页审批定义的分组名称来自该字段示例值："@i18n@2"

external

object

可选

审批定义的说明，值的格式是 i18n key，文案放在 i18n_resource；审批发起页审批定义的说明内容来自该字段示例值："@i18n@2"

create_link_pc

string

必需

PC端发起链接，如果设置了该链接，则会在PC端审批发起页展示该审批，用户点击后会跳转到该链接进行发起；如果不填，则在PC端不显示该审批；示例值："https://applink.feishu.cn/client/mini_program/open?mode=appCenter&appId=cli_9c90fc38e07a9101&path=pc/pages/create-form/index?id=9999"

create_link_mobile

string

必需

support_pc

boolean

必需

审批实例、审批任务、审批抄送是否要在PC端展示，如果为 true，则PC端列表会展示该定义下的实例信息，否则，不展示示例值：true

support_mobile

boolean

必需

审批实例、审批任务、审批抄送是否要在移动端展示，如果为 true，则移动端列表会展示该定义下的实例信息，否则，不展示； support_pc和support_mobile不可都为false，否则不展示示例值：true

support_batch_read

boolean

必需

是否支持批量已读示例值：true

action_callback_url

string

必需

三方系统的操作回调 url，【待审批】列表的任务审批人点同意或拒绝操作后，审批中心调用该地址通知三方系统，回调地址相关信息可参见：三方审批快捷审批回调示例值："http://www.feishu.cn/approval/openapi/instanceOperate"

action_callback_token

string

必需

回调时带的 token，用于业务系统验证请求来自审批,具体参考开放平台文档示例值："sdjkljkx9lsadf110"

action_callback_key

string

必需

请求参数加密密钥，如果配置了该参数，则会对请求参数进行加密，业务需要对请求进行解密，加解密算法参考关联外部选项说明示例值："gfdqedvsadfgfsd"

enable_mark_readed

boolean

必需

是否支持标注可读（该字段无效）示例值：true

i18n_resources

array [object {3}]

三方审批相关

必需

locale

string

可选

语言可选值有： zh-CN：中文 en-US：英文 ja-JP：日文示例值："zh-CN" 可选值有： zh-CN：中文 en-US：英文 ja-JP：日文

is_default

boolean

可选

是否默认语言，默认语言需要包含所有key，非默认语言如果key不存在会使用默认语言代替示例值：true

texts

array [object {2}]

可选

文案 key, value, i18n key 以 @i18n@ 开头；该字段主要用于做国际化，允许用户同时传多个语言的文案，审批中心会根据用户当前的语音环境使用对应的文案，如果没有传用户当前的语音环境文案，则会使用默认的语言文案。

viewers

array [object {1}]

必需

可见人列表，可通知配置多个可见人，只有在配置的范围内用户可以在审批发起也看到该审批，默认不传，则是任何人不可见

viewer_type

string

可选

可见人类型示例值："USER" 可选值有： TENANT：租户内可见 DEPARTMENT：指定部门 USER：指定用户 NONE：任何人都不可见

managers

array[string]

国际化文案

必需

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

approval_code

string

必需

审批定义code，审批生成的唯一标识，用于三方审批实例同步时使用

修改于 2023-02-02 03:28:54

三方快捷审批回调

资源介绍

创建三方审批定义

错误码#

请求参数

返回响应

错误码