# 发送短信加急
对指定消息进行应用内加急与短信加急。
注意事项:
- 需要开启机器人能力
- 只能加急机器人自己发送的消息
- 加急时机器人仍需要在会话内
# 请求
基本 | |
---|---|
HTTP URL | https://hi-gw.weizhipin.com/open-apis/im/v2/messages/:message_id/urgent_sms |
HTTP Method | PATCH |
支持的应用类型 | 自建应用 商店应用 |
权限要求 开启任一权限即可 | 获取用户给机器人发送的信息、向用户发送单聊、群聊消息、发送短信加急消息 |
字段权限要求 | 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 获取用户 user_id(仅自建应用) |
# 请求头
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token "示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" |
Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
# 路径参数(url中冒号标识的参数,如":xxxx"请连同:整体替换成对应值)
名称 | 类型 | 描述 |
---|---|---|
message_id | string | 待加急的消息ID。注意不支持批量消息ID(bm_xxx) 示例值:"150402" |
# 查询参数
名称 | 类型 | 描述 |
---|---|---|
user_id_type | string | 用户 ID 类型示例值:"open_id" 可选值有: open_id:用户的 open id union_id:用户的 union id user_id:用户的 user id 默认值:open_id,字段权限要求: 获取用户 user ID |
# 请求体
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
user_id_list | string[] | 是 | 目标用户的ID。列表不可为空。 示例值:["150402"] 字段权限要求: 获取用户 user_id(仅自建应用) |
请确保所填的用户ID正确,并且用户在加急消息所在的群中。
# 请求体示例
{
"user_id_list": [
"150402"
]
}
1
2
3
4
5
2
3
4
5
# 响应
# 响应体
名称 | 类型 | 描述 |
---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | - | - |
∟invalid_user_id_list | string[] | 无效的用户ID |
# 响应体示例
{
"code": 0,
"traceId": "_Ao59UOIBLPCeAAu",
"success": true,
"data": [
"11111111435"
],
"msg": "操作成功"
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9