修改消息状态
功能介绍
该接口用于修改文本卡片消息，应用卡片消息的消息状态。
接口约束
- 认证方式： access_token，请参考获取access_token
调试
您可以在API Explorer中调试该接口。
URL
POST https://open.welink.huaweicloud.com/api/messages/v1/update
请求消息
请求头部见表1
表1 请求头部
参数 |
是否必选 |
参数类型 |
描述（值） |
|---|---|---|---|
x-wlk-Authorization |
是 |
String |
access_token |
Content-Type |
是 |
String |
application/json |
请求参数见表2
表2 请求参数
参数 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
toUserList |
是 |
Array[String] |
用户账号；单次修改用户数最大1000人 |
itemId |
是 |
String |
消息ID |
messageStatus |
是 |
String |
消息状态，具体显示见样例图片（PC端不支持，移动端从5.45.X版本开始支持）。 格式："messageStatus":"{"EN":"processed","CN":"已处理"}", 其中CN长度: 2-5个字; EN长度: 2-10个字符。 |
statusColor |
否 |
String |
状态对应的颜色（PC端不支持，移动端从5.45.X版本开始支持） 支持三种颜色0 (灰色), 1（黄色）, 2（绿色）；默认：0 |
publicAccID |
特殊可选 |
String |
公众号id；不传默认为"通知中心", 如果发送消息时使用了自定义公众号，此参数必传，否则会出现无法找到消息的情况 |
响应消息
正常返回结果：
{ "code":"0", "message":"ok", "failedUserId":["zhangsan@welink"] }
异常返回结果：
{ "code": "51021", "message": "推送消息缺少必要的参数" }
请求示例
- 请求参数示例
{ "toUserList": [ "test1@d9d92e24e5" ], "itemId":"b643dbbe-8f4d-4c4e-ad92-d4d5ab994bf8", "messageStatus":"{\"EN\":\"processed\",\"CN\":\"已完成\"}", "statusColor":"1", "publicAccID": "HXgPDrJqhYzHR9NcfZ" }
返回值
返回参数说明：
参数 |
说明 |
|---|---|
code |
数据正常返回“0”，如果发生错误，会返回对应的错误码。 |
message |
返回信息，包括接口请求发生错误时的详细信息。 |
failedUserId |
推送失败的用户ID |
错误码
错误码 |
说明 |
|---|---|
51018 |
单次发送用户数最大1000人 |
51021 |
推送消息缺少必要的参数 |
51033 |
找不到匹配数据 |
51107 |
该消息为无状态消息，不能修改 |
51104 |
messageStatus消息状态参数不合法 |
附录
图片样式：
