Skip to content
开发文档
能力中心
应用市场
WebOffice
开发者后台

更新消息

更新消息

请求说明

请求地址https://openapi.wps.cn/v7/messages/{message_id}/update
请求方法POST
签名方式KSO-1
权限要求查询和管理会话消息(应用授权) kso.chat_message.readwrite

请求头(Header)

Header 名称参数类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

路径参数(Path)

名称参数类型说明
message_idstring消息 id

请求体(Body)

名称参数类型是否必填说明
typestring[enum]仅支持消息类型 card:卡片消息
mentionsarray[object]被 at 的人员列表,如果涉及更新消息卡片(card)内的at人,则需要在此更新at人信息。具体用法见【发送消息接口】中详细描述
∟ idstring指定聊天消息中 at 操作的实体索引 id。与消息正文中相应 <at id={index}> 标记中的 {index} 值匹配
∟ identityobject被 at 的用户信息,当 at 所有人时该值为空
∟ ∟ company_idstring用户所属企业id
∟ ∟ idstring用户id
∟ ∟ typestring[enum]身份类型
user:用户;
∟ typestring[enum]at 操作对象类型
all:所有人;user:用户
contentobject消息内容
∟ cardobject卡片消息,见【发送消息接口】中详细描述

请求地址示例

[POST] https://openapi.wps.cn/v7/messages/{message_id}/update

请求体示例

json
{
  "type": "card",
  "mentions": [
  {
    "id": "string",
    "identity": {
      "company_id": "string",
      "id": "string",
      "type": "user"
    },
    "type": "user"
  }
],
  "content": {
    // 当消息类型为文本 type=card 时,传递 card 对象
    "card": {}
  }
}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
moreobject更多的错误信息

响应体示例

json
{
  "code": 0,
  "msg": "string"
}
回到旧版