发送短信加急

PATCH

https://open.feishu.cn/open-apis/im/v1/messages/{message_id}/urgent_sms

对指定消息进行应用内加急与短信加急。

特别说明：

通过接口产生的短信加急将消耗企业的加急额度，请慎重调用

通过租户管理后台-费用中心-短信/电话加急可以查看当前额度

默认接口限流为50 QPS，请谨慎调用

注意事项:

需要开启机器人能力

只能加急机器人自己发送的消息

加急时机器人仍需要在加急消息所在的群组中

加急用户的未读加急总数不能超过200条

当存在部分用户ID有效时将对有效的用户进行加急操作，同时返回无效的用户ID。当所有的用户ID无效时，将返回230001错误码

错误码

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.	机器人能力未启用。在开发者后台-应用功能-机器人页面开启机器人功能并发布上线。
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.	请根据本文档中的权限要求部分补充所需权限。

其他未列出的错误码请参见服务端通用错误码。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://open.feishu.cn/open-apis/im/v1/messages//urgent_sms?user_id_type' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user_id_list": [
        "ou_6yf8af6bgb9100449565764t3382b168"
    ]
}'

响应示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "invalid_user_id_list": [
            "ou_6yf8af6bgb9100449565764t3382b168"
        ]
    }
}

请求参数

Path 参数

message_id

string

必需

待加急的消息ID，详情参见消息ID说明注意：不支持批量消息ID（bm_xxx）示例值："om_dc13264520392913993dd051dba21dcf"

Query 参数

user_id_type

string

必需

用户 ID 类型示例值："open_id" 可选值有： open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？默认值：open_id 当值为 user_id，字段权限要求：获取用户 user ID

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

Body 参数application/json

user_id_list

array[string]

必需

目标用户的ID，列表不可为空；推荐使用 OpenID，获取方式可参考文档如何获取 Open ID？注意：请确保所填的用户ID正确，并且用户在加急消息所在的群组中示例值：["ou_6yf8af6bgb9100449565764t3382b168"]

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

invalid_user_id_list

array[string]

无效的用户ID

必需

修改于 2023-01-12 09:24:40

发送应用内加急

发送电话加急

发送短信加急

错误码#

请求参数

返回响应

错误码