更新消息
用于应用更新已发出的消息。
请求说明
| 请求地址 | 配置域名+/o/woa/api/v1/developer/app/messages |
|---|---|
| 请求方法 | PUT |
| 签名方式 | 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值 |
请求地址示例
http
[PUT] 配置域名+/o/woa/api/v1/developer/app/messages请求体(Body)
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| app_key | string | 是 | 协作应用 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 端打开地址址 |
请求体示例
json
{
"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 表示失败,参照《状态码说明》 |
响应体示例
json
{
"result": 100000
}