快速入门 服务端 客户端 通用能力 开发指南 服务商指南
本文内容

更新消息

用于应用更新已发出的消息。

请求说明

请求地址 https://openapi.wps.cn/oauthapi/v1/voa/app/messages
请求方法 PUT
签名方式 wps-3，签名URL：/oauthapi/v1/voa/app/messages
支持应用类型 企业自建应用、第三方企业应用
权限要求 通过接口发送消息(xz_message)

请求头

Header名称 是否必填 说明
Content-Type 是 目前固定为："application/json"
Content-Md5 是 当HTTP请求的Body有数据时，计算Body的MD5值，否则计算空字符串的MD5值。再将MD5值转为十六进制字符串形式。即：Format("%x", md5Byte)
Date 是 RFC1123格式的日期，例: Wed, 23 Jan 2013 06:43:08 GMT
X-Auth 是 X-Auth计算方法参考签名说明

查询参数（Query）

名称 类型 是否必填 说明
company_token string 是 企业授权凭证

请求地址示例

[PUT] https://openapi.wps.cn/oauthapi/v1/voa/app/messages?company_token=COMPANY_TOKEN

请求体（Body）

参数 类型 是否必填 说明
app_key string 是 WPS协作应用 AppID
ctx_id string 是 需要后续更新消息时则必须，ctx_id 映射到消息 id(最大长度 128，建议先不要占满，方便后续在此进行其他拓展)
operator string 是 操作者 id
utype integer 是 需要后续更新消息时则必须，后续消息更新方式： 0:后续不更新 1:后续更新消息中 content（目前只允许更新消息按钮）
content object 是 消息内容
 ∟ href object 否 模板卡⽚底部链接按钮展示
   ∟ url string 否 链接的 url 地址
   ∟ text string 否 链接显示的文案
   ∟ style string 否 链接样式 normal:蓝色 secondary:置灰 warn:红色
   ∟ disable bool 否 不可点击标识 true:不可点击 false:可点击
   ∟ platform_url object 否 各平台打开的 url 地址
     ∟ ios string 否 IOS 端打开地址址
     ∟ android string 否 Android 端打开地址址
     ∟ pc string 否 PC 端打开地址址
 ∟ hrefs object 否 模板卡⽚底部链接按钮展示
   ∟ url string 否 链接的 url 地址
   ∟ text string 否 链接显示的文案
   ∟ style string 否 链接样式 normal:蓝色 secondary:置灰 warn:红色
   ∟ disable bool 否 不可点击标识 true:不可点击 false:可点击
   ∟ platform_url object 否 各平台打开的 url 地址
     ∟ ios string 否 IOS 端打开地址址
     ∟ android string 否 Android 端打开地址址
     ∟ pc string 否 PC 端打开地址址

请求体示例

{
  "app_key": "WK202xxxx3141501",
  "service_id": "WK202xxxx3141501",
  "ctx_id": "your_ctx_id",
  "utype": 1,
  "operator": "ZGplZGplaWlqZGUK",
  "content": {
    "href": {
      "url": "https://kdocs.cn/l/cS28LcQ",
      "text": "查看⽂档",
      "style": "secondary",
      "disable": true,
      "platform_url": {
        "ios": "ksoxz://xz.wps.cn/toast?body=该消息适合在PC上处理",
        "android": "ksoxz://xz.wps.cn/toast?body=该消息适合在PC上处理",
        "pc": "ksoxz://xz.wps.cn/toast?body=该消息适合在PC上处理"
      }
    },
    "hrefs": [
      {
        "url": "https://kdocs.cn/l/cS28LcQ",
        "text": "查看⽂档",
        "style": "secondary",
        "disable": true,
        "platform_url": {
          "ios": "ksoxz://xz.wps.cn/toast?body=该消息适合在PC上处理",
          "android": "ksoxz://xz.wps.cn/toast?body=该消息适合在PC上处理",
          "pc": "ksoxz://xz.wps.cn/toast?body=该消息适合在PC上处理"
        }
      }
    ]
  }
}

响应体

名称 类型 说明
result integer 状态码，非 0 表示失败，参照《状态码说明》

响应体示例

{
  "result": 100000
}
本文内容