华为云WELINK-应用卡片消息:请求消息

时间:2023-12-18 15:59:47

请求消息

请求头部见表1

表1 请求头部

参数

是否必选

参数类型

描述(值)

x-wlk-Authorization

String

access_token

Content-Type

String

application/json

请求参数见表2

表2 请求参数

参数

是否必选

参数类型

说明

publicAccID

String

接收消息的公众号ID,不传则默认发送消息到通知中心;可以在管理后台-公众号-公众号设置找到公众号ID

msgRange

String

0:按用户推送;1:按部门发送;2:按角色发送;默认0:按用户推送

toUserList

Array[String]

接收消息的人员ID(多个接收者用','分隔,最多支持1000个);msgRange=0时必传

departmentList

Array[String]

接收消息的部门ID(多个接收者用','分隔,最多支持100个);msgRange=1时必传

roleList

Array[String]

接收消息的角色ID(多个接收者用','分隔,最多支持100个);msgRange=2时必传

msgTitle

String

消息标题,长度不超过128字节。

如仅展示中文消息,可直接传普通string,如 “出差电子流” 。

需要双语则参考请求包体示例,传入json类型的string。

contentList

Array[content]

正文列表,key正文名称,value正文描述(限制为5行)。详见下表content数据结构

receiveDeviceType

String

接收消息终端,0 :PC;1 :Mobile;2 :PC+MOBILE(默认)

urlType

String

urlPath 类型定义。当前只支持“html”,点击后跳转到相关链接

urlPath

String

点击消息,跳转的链接

btnType

String

按钮布局,暂支持horizontal(水平布局)、vertical (垂直布局)两种类型功能按钮

btnList

Array[btn]

按钮列表,horizontal最多支持两个按钮,vertical最多支持3个按钮。详见下表btn数据结

messageStatus

String

消息状态,具体显示见样例图片(PC端不支持,移动端从5.45.X版本开始支持)。

格式:

"messageStatus":"{"EN":"processed","CN":"已处理"}",

其中CN长度: 2-5个字; EN长度: 2-10个字符。

statusColor

String

状态对应的颜色(PC端支持7.0以上,移动端5.45 以上支持)

支持三种颜色1 (蓝色), 2(灰色), 3(橙色);默认:1

isForceTips

Integer

是否强提醒。

强提醒时PC WeLink 收到消息,屏幕右下角会有弹窗提示。0:否;1:是。为空时默认为0,不强提醒

  • content 参数说明

参数式

是否必选

数据类型

说明

key

String

传入json类型的string,如:

"{\"EN\":"participants\",\"CN\":\"参与人\"}"。长度不超过128字节

value

String

传入json类型的string,如:"{\"EN\":\"all\",\"CN\":\"技术部全体\"}"。长度不超过256字节

  • btn 参数说明

参数式

是否必选

数据类型

说明

btnTitle

String

json类型的string,如:

"{\"EN\":"videoconferencing\",\"CN\":\"视频会议\"}"。长度不超过128字节

btnUrl

String

按钮跳转地址。

urlType

String

链接类型定义,如"html",则可跳转到http://url地址

support.huaweicloud.com/devg-welink/start-142.html