消息加急
用于对指定消息进行应用内加急强提醒。
请求说明
| 请求地址 | 配置域名+/o/woa/api/v1/developer/app/message/{message_id}/urgent |
|---|---|
| 请求方法 | POST |
| 签名方式 | wps-4 |
| 支持应用类型 | 企业自建应用、第三方企业应用 |
| 权限要求 | 发送消息(kso.im.message.send) |
请求头
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| Wps-Docs-Date | 是 | 取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考签名说明 |
| Authorization | 是 | 授权token,格式:Bearer ${access_token},${access_token}需替换为从授权接口获取的access_token值 |
路径参数(Path)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| message_id | string | 是 | 消息 id |
请求地址示例
http
配置域名+/o/woa/api/v1/developer/app/message/{message_id}/urgent请求体(Body)
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| chat_id | integer | 否 | 群聊 id,不为 0 时加急群聊中的消息 |
| user_ids | []integer | 是 | 需要加急的用户 id |
请求体示例
json
{
"chat_id": 123,
"user_ids": [1001, 1002]
}响应体
| 名称 | 类型 | 说明 |
|---|---|---|
| result | integer | 状态码,非 0 表示失败,参照《状态码说明》 |
| invalid_user_ids | []integer | 加急失败的用户 id |
响应体示例
json
{
"invalid_user_ids": [1001],
"result": 0
}