更新消息
更新消息
请求说明
请求地址 | https://openapi.wps.cn/v7/messages/{message_id}/update |
---|---|
请求方法 | POST |
签名方式 | KSO-1 |
权限要求 | 查询和管理会话消息(应用授权) kso.chat_message.readwrite |
请求头(Header)
Header 名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
Content-Type | string | 是 | 使用:application/json |
X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
路径参数(Path)
名称 | 参数类型 | 说明 |
---|---|---|
message_id | string | 消息 id |
请求体(Body)
名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
type | string[enum] | 是 | 仅支持消息类型 card :卡片消息 |
mentions | array[object] | 否 | 被 at 的人员列表,如果涉及更新消息卡片(card)内的at人,则需要在此更新at人信息。具体用法见【发送消息接口】中详细描述 |
∟ id | string | 是 | 指定聊天消息中 at 操作的实体索引 id。与消息正文中相应 <at id={index}> 标记中的 {index} 值匹配 |
∟ identity | object | 否 | 被 at 的用户信息,当 at 所有人时该值为空 |
∟ ∟ company_id | string | 是 | 用户所属企业id |
∟ ∟ id | string | 是 | 用户id |
∟ ∟ type | string[enum] | 是 | 身份类型 user :用户; |
∟ type | string[enum] | 是 | at 操作对象类型 all :所有人;user :用户 |
content | object | 是 | 消息内容 |
∟ card | object | 否 | 卡片消息,见【发送消息接口】中详细描述 |
请求地址示例
[POST] https://openapi.wps.cn/v7/messages/{message_id}/update
1
请求体示例
json
{
"type": "card",
"mentions": [
{
"id": "string",
"identity": {
"company_id": "string",
"id": "string",
"type": "user"
},
"type": "user"
}
],
"content": {
// 当消息类型为文本 type=card 时,传递 card 对象
"card": {}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
响应体
名称 | 参数类型 | 说明 |
---|---|---|
code | integer | 响应代码。非 0 表示失败,参照《状态码说明》 |
msg | string | 响应信息 |
more | object | 更多的错误信息 |
响应体示例
json
{
"code": 0,
"msg": "string"
}
1
2
3
4
2
3
4