服务端 API/消息/消息加急/发送应用内加急
# 发送应用内加急
对指定消息进行应用内加急。
**注意事项**：特别说明：
- 默认接口限流为50 QPS，请谨慎调用
**注意事项**：注意事项:
- 需要开启[机器人能力](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)
- 不支持加急批量消息
- 只能加急机器人自己发送的消息
- 加急时机器人需要在加急消息所在的群中
- 加急用户的未读加急总数不能超过200条
## 请求
基本 |
---|---
HTTP URL | https://open.larksuite.com/open-apis/im/v1/messages/:message_id/urgent_app
HTTP Method | PATCH
支持的应用类型 | Custom App、Store App
权限要求
**调用该 API 所需的权限。开启其中任意一项权限即可调用**
开启任一权限即可 | 发送应用内加急消息(im:message.urgent)
发送应用内加急消息(im:message.urgent:app_send)
字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请
获取用户 user ID(contact:user.employee_id:readonly)
### 请求头
名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`
**值格式**："Bearer `access_token`"
**示例值**："Bearer t-7f1bcd13fc57d46bac21793a18e560"
[了解更多：如何选择与获取 access token](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
Content-Type | string | 是 | **固定值**："application/json; charset=utf-8"
### 路径参数
名称 | 类型 | 描述
---|---|---
message_id | string | 待加急的消息ID，详情参见[消息ID说明](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2)
**注意**：不支持批量消息ID（bm_xxx）
**示例值**："om_dc13264520392913993dd051dba21dcf"
### 查询参数
名称 | 类型 | 必填 | 描述
---|---|---|---
user_id_type | string | 是 | 用户 ID 类型
**示例值**："open_id"
**可选值有**：
- open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)
- union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)
- user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id)
**默认值**：`open_id`
**当值为 `user_id`，字段权限要求**：
获取用户 user ID(contact:user.employee_id:readonly)
### 请求体
名称 | 类型 | 必填 | 描述
---|---|---|---
user_id_list | string\[\] | 是 | 目标用户的ID，列表不可为空；推荐使用 OpenID，获取方式可参考文档[如何获取 Open ID？](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)
**注意**：
请确保所填的用户ID正确，并且用户在加急消息所在的群组中
**示例值**：["ou_6yf8af6bgb9100449565764t3382b168"]
### 请求体示例
```json
{
"user_id_list": [
"ou_6yf8af6bgb9100449565764t3382b168"
]
}
```
## 响应
### 响应体
名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
invalid_user_id_list | string\[\] | 无效的用户ID
当存在部分用户ID有效时将对有效的用户进行加急操作，同时返回无效的用户ID。当所有的用户ID无效时，将返回230001错误码
### 响应体示例
```json
{
"code": 0,
"msg": "success",
"data": {
"invalid_user_id_list": [
"ou_6yf8af6bgb9100449565764t3382b168"
]
}
}
```
### 错误码
HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
400 | 230001 | Your request contains an invalid request parameter. | 参数错误，请根据接口返回的错误信息并参考文档检查输入参数。
400 | 230002 | The bot can not be outside the group. | 机器人不在对应群组中。
400 | 230006 | Bot ability is not activated. | [机器人能力](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)未启用 。在[开发者后台](https://open.larksuite.com/app)-应用功能-机器人页面开启机器人功能并发布上线。
400 | 230012 | Bot is NOT the sender of the message. | 机器人不是消息的发送者。
400 | 230023 | The user has too many unread urgent messages. | 加急用户的未读加急总数不能超过200条，需要用户阅读一部分被加急的消息才可以继续加急。
400 | 230024 | Reach the upper limit of urgent message. | 加急额度超限，请联系租户管理员。
400 | 230027 | Lack of necessary permissions. | 请根据本文档中的权限要求部分补充所需权限。
其他未列出的错误码请参见[服务端通用错误码](https://open.larksuite.com/document/ukTMukTMukTM/ugjM14COyUjL4ITN)。