feishu-urgent

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Feishu Urgent Tool

飞书加急工具

Single tool
feishu_urgent
for sending urgent (buzz) notifications to recipients for an already-sent message.
单一工具
feishu_urgent
用于向收件人发送已发送消息的加急(buzz)通知。

Overview

概述

Urgent notifications (also called "buzz" in Feishu) send a strong push notification to specified recipients. Use this to escalate important messages that require immediate attention.
Important: The message must already be sent before sending an urgent notification. You need the
message_id
from a previously sent message.
加急通知(在飞书中也被称为"buzz")会向指定收件人发送强提醒推送通知,可用于升级需要立即处理的重要消息。
重要提示:发送加急通知前,对应消息必须已经发送,你需要获取先前已发送消息的
message_id

Urgency Types

加急类型

TypeDescriptionCost
app
In-app buzz notification (popup + sound)Free
sms
SMS push to recipient's phoneMay incur cost
phone
Voice call to recipient's phoneMay incur cost
类型描述成本
app
应用内加急通知(弹窗+声音)免费
sms
向收件人手机发送短信推送可能产生费用
phone
向收件人手机拨打语音电话可能产生费用

Send App Urgent (Default)

发送应用内加急(默认)

json
{
  "message_id": "om_xxx",
  "user_ids": ["ou_xxx"],
  "urgent_type": "app"
}
json
{
  "message_id": "om_xxx",
  "user_ids": ["ou_xxx"],
  "urgent_type": "app"
}

Send SMS Urgent

发送短信加急

json
{
  "message_id": "om_xxx",
  "user_ids": ["ou_xxx"],
  "urgent_type": "sms"
}
json
{
  "message_id": "om_xxx",
  "user_ids": ["ou_xxx"],
  "urgent_type": "sms"
}

Send Phone Call Urgent

发送电话加急

json
{
  "message_id": "om_xxx",
  "user_ids": ["ou_xxx"],
  "urgent_type": "phone"
}
json
{
  "message_id": "om_xxx",
  "user_ids": ["ou_xxx"],
  "urgent_type": "phone"
}

Multiple Recipients

多收件人场景

json
{
  "message_id": "om_xxx",
  "user_ids": ["ou_xxx", "ou_yyy", "ou_zzz"],
  "urgent_type": "app"
}
json
{
  "message_id": "om_xxx",
  "user_ids": ["ou_xxx", "ou_yyy", "ou_zzz"],
  "urgent_type": "app"
}

Parameters

参数说明

ParameterRequiredDescription
message_id
YesMessage ID to send urgent notification for (e.g.,
om_xxx
). The message must already be sent.
user_ids
YesList of
open_id
values to buzz. Minimum 1 recipient. Recipients must be members of the chat where the message was sent.
urgent_type
NoUrgency delivery method:
app
(default),
sms
, or
phone
.
参数是否必填描述
message_id
需要发送加急通知的消息ID(例如
om_xxx
),对应消息必须已经发送。
user_ids
要加急的
open_id
列表,最少1个收件人,收件人必须是消息所在聊天的成员。
urgent_type
加急送达方式:
app
(默认)、
sms
phone

Response

返回结果

json
{
  "ok": true,
  "message_id": "om_xxx",
  "urgent_type": "app",
  "invalid_user_list": []
}
  • invalid_user_list
    : List of user IDs that could not receive the urgent notification (e.g., not in the chat, or invalid ID).
json
{
  "ok": true,
  "message_id": "om_xxx",
  "urgent_type": "app",
  "invalid_user_list": []
}
  • invalid_user_list
    :无法接收加急通知的用户ID列表(例如不在聊天内、或ID无效)。

Configuration

配置方式

yaml
channels:
  feishu:
    tools:
      urgent: true  # default: true
yaml
channels:
  feishu:
    tools:
      urgent: true  # default: true

Permissions

权限要求

  • im:message.urgent
    - Send in-app urgent notifications
  • im:message.urgent:sms
    - Send SMS urgent notifications (may incur cost)
  • im:message.urgent:phone
    - Send phone call urgent notifications (may incur cost)
  • im:message.urgent
    - 发送应用内加急通知
  • im:message.urgent:sms
    - 发送短信加急通知(可能产生费用)
  • im:message.urgent:phone
    - 发送电话加急通知(可能产生费用)

Notes

注意事项

  • Message must exist: The
    message_id
    must be from a message that has already been sent. You cannot send urgent notifications for messages being composed.
  • Recipients must be chat members: Users in
    user_ids
    must be members of the chat where the original message was sent.
  • Quota limits: Urgent notifications have quotas (especially
    sms
    and
    phone
    ). Error
    230024
    ("Reach the upper limit of urgent message") indicates quota exhausted. Contact your tenant admin or check Feishu admin console > Cost Center > Quota.
  • Invalid user IDs: Returns HTTP 400 error if any user_id is invalid (not found or not in the chat).
  • Cost warning:
    sms
    and
    phone
    types may incur costs on the tenant. Use
    app
    (default) for free notifications.
  • 消息必须已存在
    message_id
    必须来自已发送的消息,无法为正在编辑的消息发送加急通知。
  • 收件人必须是聊天成员
    user_ids
    中的用户必须是原消息所在聊天的成员。
  • 配额限制:加急通知有配额限制(尤其是
    sms
    phone
    类型)。错误
    230024
    ("Reach the upper limit of urgent message")表示配额已用尽,请联系租户管理员或查看飞书管理后台 > 成本中心 > 配额。
  • 无效用户ID:如果有任何user_id无效(未找到或不在聊天内),将返回HTTP 400错误。
  • 成本提醒
    sms
    phone
    类型可能会向租户收取费用,推荐使用默认的
    app
    类型获取免费通知。