# 发送审批Bot消息
此接口可以用来通过Bosshi审批的Bot推送消息给用户,当有新的审批待办,或者审批待办的状态有更新时,可以通过Bosshi审批的Bot告知用户。
# 请求
基本 | |
---|---|
HTTP URL | https://hi-qa.weizhipin.com/open-apis/approval/message/send |
HTTP Method | POST |
支持的应用类型 | 自建应用 商店应用 |
权限要求 | 向官方审批同步数据 |
# 请求头
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token "示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" |
Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
# 通用模板-请求体
参数 | 类型 | 必须 | 说明 | 示例 |
---|---|---|---|---|
user_id | string | 是 | 推送给哪个用户,开放平台的 user_id | b85s39b |
uuid | string | 否 | 幂等 id,最大长度为64,用于保证卡片只发送一次,uuid+user_id相同的卡片只会发送一次 | 1234567 |
instance_id | string | 是 | 审批实例ID | |
approval_name | string | 是 | 卡片标题中的{审批定义名称} | @i18n@1 |
title_user_id | string | 否 | 卡片标题中的{申请人}、{审批人}、{评论人}、{抄送人}等,user_id | b85s39b |
summaries | list | 否 | 审批事由,最多5个 | |
link | external_instance_link | 是 | 审批实例链接集合 ,用于【已发起】列表的跳转,跳转回三方系统; pc_link 和 mobile_link 必须填一个 | |
∟pc_link | string | 是 | pc 端的跳转链接 pc跳转链接和移动端跳转链接必须有一个不为空 | |
∟mobile_link | string | 否 | 移动端 跳转链接 pc跳转链接和移动端跳转链接必须有一个不为空 | |
action_callback_url | string | 否 | 快捷审批:三方系统的操作回调 url,【待审批】列表的任务审批人点同意或拒绝操作后,审批中心调用该地址通知三方系统 | http://www.feish.cn/approval/openapi/instanceOperate |
action_callback_token | string | 否 | 快捷审批:回调时带的 token, 用于业务系统验证请求来自审批 具体参考事件订阅概述 | sdjkljkx9lsadf110 |
action_callback_key | string | 否 | 快捷审批:请求参数加密密钥,如果配置了该参数,则会对请求参数进行加密,业务需要对请求进行解密,加解密算法 | gfdqedvsadfgfsd |
# 通用模板-请求体示例
{
"user_id": "b85s39b",
"uuid": "uuid",
"approval_name": "审批",
"title_user_id": "od-8ec33278bc2",
"instance_id": "xxxxx",
"summaries": [
"xxxx",
"xxx"
],
"link": {
"pc_link": "https://zhishu.zhipin.com/preview?id=AnOcl783J0t",
"mobile_link": "https://zhishu.zhipin.com/preview?id=AnOcl783J0t"
},
"action_callback_url": "http://zhipin.cn/approval/openapi/operate",
"action_callback_token": "sdjkljkx9lsadf110",
"action_callback_key": "gfdqedvsadfgfsd",
"display_method": "BROWSER"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# 响应
# 响应体
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
code | int | 是 | 错误码,非 0 表示失败 |
msg | string | 是 | 返回码的描述 |
data | map | 是 | 返回业务信息 |
∟message_id | string | 是 | 消息 id ,用于卡片更新 |
# 响应体示例
{
"code": 0,
"traceId": "_Ao59UOIBLPCeAAu",
"success": true,
"msg": "操作成功",
"data": {
"message_id": "6968359519504171036"
}
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9