Skip to content

更新应用能力

通过该接口可更新自建应用的应用能力(机器人、网页应用等)相关配置,不传入的参数则保持不变,仅针对传入的参数则进行更新。如果应用正在审核中,则无法更新配置

Tip: - 若用 user_access_token 代表某个终端用户操作API,则需确保该用户为应用的所有者、管理员、开发者,否则无法操作成功

  • 若用 tenant_access_token 代表应用操作API,则仅可操作自身

Warning: - 仅支持更新开发者后台创建的自建应用,不包含通过机器人助手等其他渠道创建的自建应用

  • 应用配置修改后需要提交发布,并审核通过后才会在线上生效

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/application/v7/applications/:app_id/ability
HTTP MethodPATCH
接口频率限制100 次/分钟
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用application:application:patch 修改应用信息

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token
Content-Typestring固定值:"application/json; charset=utf-8"

路径参数

名称类型描述
app_idstring应用的app_id 如何获取应用的 App ID
示例值:"cli_a42d0b833ab8d01b"

请求体

名称类型必填描述
web_appapp_ability_web网页应用
  └ enableboolean是否开启网页应用能力
示例值:true
  └ pc_urlstringPC端链接
示例值:"https://open.feishu.cn/"
数据校验规则
- 最大长度:512 字符
  └ pc_new_page_open_modestringPC端新页面打开方式
示例值:"new_tab"
可选值有
- new_tab: PC新页面在飞书打开 - browser: PC新页面在浏览器打开
  └ mobile_urlstring移动端链接
示例值:"https://open.feishu.cn/"
数据校验规则
- 最大长度:512 字符
botapp_ability_bot机器人
  └ enableboolean是否开启
示例值:true
  └ message_card_callback_urlstring消息卡片的回调地址
示例值:"https://open.feishu.cn"
  └ i18nsapp_ability_bot_i18n\[\]国际化内容
数据校验规则
- 长度范围:1200
    └ i18n_keystring语种类型
示例值:"zh_cn"
可选值有
- zh_cn: 中文 - en_us: 英文 - ja_jp: 日文 - zh_hk: 繁体中文(中国香港) - zh_tw: 繁体中文(中国台湾) - id_id: 印度尼西亚语 - ms_my: 马来语 - de_de: 德语 - es_es: 西班牙语 - fr_fr: 法语 - it_it: 意大利语 - pt_br: 葡萄牙语(巴西) - vi_vn: 越南语 - ru_ru: 俄语 - th_th: 泰语 - ko_kr: 韩语
    └ get_started_descstring如何开始使用描述文案
示例值:"如何使用机器人"
数据校验规则
- 最大长度:64 字符

请求体示例

json
{
    "web_app": {
        "enable": true,
        "pc_url": "https://open.feishu.cn/",
        "pc_new_page_open_mode": "new_tab",
        "mobile_url": "https://open.feishu.cn/"
    },
    "bot": {
        "enable": true,
        "message_card_callback_url": "https://open.feishu.cn",
        "i18ns": [
            {
                "i18n_key": "zh_cn",
                "get_started_desc": "如何使用机器人"
            }
        ]
    }
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {}
}

错误码

HTTP状态码错误码描述排查建议
400210011Param is invalid根据错误提示信息,检查参数是否符合要求
404210012The specified application does not exist指定的应用不存在,请检查传入的app_id参数是否正确
500210013Internal server error服务内部错误,请稍候重试或联系技术支持(https://applink.feishu.cn/TLJpeNdW)
400210014This API only does not support to update ISV App, only support to update Self-Built App仅自建应用可以使用该API,请使用自建应用调用
403210015As the App was created via Base, it cannot be updated using this API.仅可以操作开发者后台创建的应用,请使用开发者后台创建的应用调用该API
403210016Lack of permission to update other App.应用身份调用仅允许更新自身,不允许更新其它应用,请使用应用自身的身份调用该API
403210017The current user has no permission to modify the app configurations当前用户无权限修改应用配置,请通过返回结果确认缺失的权限,并为应用申请所需权限
400210019The validation for message_card_callback_url failed.消息卡片回调地址校验失败,详细请查看配置应用的回调地址
400210020Unable to update configurations, as the app is currently under review.应用正在审核中,不能进行该操作,请等待审核通过后再尝试
403210021The specified application is not created via developer platform, can not modify by this API仅可以操作开发者后台创建的应用,请使用开发者后台创建的应用调用该API

内容来源:飞书开放平台 · 自动爬取整理