# 更新应用红点
更新应用红点信息，用于工作台场景
## 请求
基本 |
---|---
HTTP URL | https://open.feishu.cn/open-apis/application/v6/app_badge/set
HTTP Method | POST
接口频率限制 | [特殊频控](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求
**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 无
字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请
获取用户 user ID(contact:user.employee_id:readonly)
### 请求头
名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`
**值格式**："Bearer `access_token`"
**示例值**："Bearer t-7f1bcd13fc57d46bac21793a18e560"
[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
Content-Type | string | 是 | **固定值**："application/json; charset=utf-8"
### 查询参数
名称 | 类型 | 必填 | 描述
---|---|---|---
user_id_type | string | 否 | 用户 ID 类型
**示例值**：open_id
**可选值有**：
- open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)
- union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)
- user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id)
**默认值**：`open_id`
**当值为 `user_id`，字段权限要求**：
获取用户 user ID(contact:user.employee_id:readonly)
### 请求体
名称 | 类型 | 必填 | 描述
---|---|---|---
user_id | string | 是 | 用户ID
**示例值**："ou_d317f090b7258ad0372aa53963cda70d"
version | string | 是 | badge数据版本号
**示例值**："1664360599355"
extra | string | 否 | badge extra 信息
**示例值**："{}"
pc | client_badge_num | 否 | pc端badge数量
web_app | int | 否 | h5能力的badge数量
**示例值**：1
**数据校验规则**：
- 取值范围：`0` ～ `2147483647`
gadget | int | 否 | 小程序能力的badge数量
**示例值**：2
**数据校验规则**：
- 取值范围：`0` ～ `2147483647`
mobile | client_badge_num | 否 | 移动端badge数量
web_app | int | 否 | h5能力的badge数量
**示例值**：1
**数据校验规则**：
- 取值范围：`0` ～ `2147483647`
gadget | int | 否 | 小程序能力的badge数量
**示例值**：2
**数据校验规则**：
- 取值范围：`0` ～ `2147483647`
### 请求体示例
```json
{
"user_id": "ou_d317f090b7258ad0372aa53963cda70d",
"version": "1664360599355",
"extra": "{}",
"pc": {
"web_app": 1,
"gadget": 2
},
"mobile": {
"web_app": 1,
"gadget": 2
}
}
```
## 响应
### 响应体
名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
### 响应体示例
```json
{
"code": 0,
"msg": "success",
"data": {}
}
```
### 错误码
HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
400 | 213001 | pc version conflict | PC 端版本冲突，可能是并发更新导致。请稍后重试
400 | 213002 | mobile version conflict | mobile 端版本冲突，并发更新时可能出现
400 | 213003 | no data | 没有数据
400 | 213004 | set same user data concurrently | 并发更新了用户数据
400 | 213005 | invalid version | 版本号不对
400 | 213006 | user status not valid | 用户状态不对
400 | 213007 | user is invisible | 当前应用对用户不可见。请参考[配置应用可用范围](https://open.feishu.cn/document/home/introduction-to-scope-and-authorization/availability)确保用户在应用可见范围内