文档
测试

发送消息

POST
[host]/OAapp/v1/open-api/send/message/send

接口描述

发送消息

请求头

参数名
类型
描述
必填
Content-Type
string
值必须为:application/json;charset=UTF-8
必填
access_token
string
访问令牌
必填

请求参数

参数名
类型
描述
必填
relation_key
string
关联key(未填写返回消息ID)
可选
accounts
string[]
接收账号数组
必填
title
string
标题 非消息卡片必须输入
可选
module
string
消息模块标记 非消息卡片必须输入
可选
open_params
object
跳转参数 非消息卡片必须输入
可选
web_url
string
PC跳转子路径
必填
pad_url
string
PAD跳转子路径
必填
mobile_url
string
手机跳转子路径
必填
content
object
消息块内容 非消息卡片必须输入
可选
msg_status
string
消息状态
可选
msg_color
string
消息状态颜色(目前支持red,green)
可选
msg_content
string[]
分列展现消息内容
可选
msg_status
string
状态,0是新建
必填
is_post
bool
跳转方式:默认 post 跳转。true post跳转,false get跳转
可选
hide_head
bool
使用系统导航头(手机专用):默认为客户导航头。true 客户导航头,false 小天系统头
可选
is_open_web
bool
外部打开(PC端专用):默认为系统内打开。true 系统外打开网页,false 系统内打开
可选
is_message_card
int
1:消息卡片
可选
card_id
string
消息卡片id 消息卡片必须输入
可选
variable_json
object
消息卡片内容,此处需按照消息卡片id传对应json 消息卡片必须输入
可选

响应参数

参数名
类型
描述
必填
code
int
200000 : 正常 以外:异常
必填
message
string
异常内容
必填
data
string
关联Key或消息ID
可选

说明 / 示例

**普通消息 请求示例** ```language host/OAapp/v1/open-api/send/message/send header access_token:8KFa2RaR1p8wolbYkFnYGZBZsKGa2jCiX1qRGPCinNDRcKGdVl5QVp6woh6dVhnwoV0VmvCgXNYZ2BqaEJ9WnvCgHpjfH1eY2V8QV9VWkVeVXxDX8KLfE Content-Type:application/json;charset=UTF-8 body { "title": "标题", "content": { "msg_status": "待办理", "msg_color": "red", "msg_content": ["第一行内容","第二行内容"] }, "module": "ceshi", "accounts": ["admin"], "open_params": { "web_url": "/html/frame/pc/login.html?taskld=XXX", "pad_url": "/html/frame/pc/login.html?taskld=XXX", "mobile_url":"/html/frame/pc/login.html?taskld=XXX"}, "msg_status": "0" } ``` **消息卡片 请求示例** ```language host/OAapp/v1/open-api/send/message/send header access_token:8KFa2RaR1p8wolbYkFnYGZBZsKGa2jCiX1qRGPCinNDRcKGdVl5QVp6woh6dVhnwoV0VmvCgXNYZ2BqaEJ9WnvCgHpjfH1eY2V8QV9VWkVeVXxDX8KLfE Content-Type:application/json;charset=UTF-8 body { "is_message_card": 1, "module": "ceshi", "accounts": ["admin"], "card_id": "40b566a888734b258a85788e", "variable_json": { "msgImgUrl": { "data": "80d6ef3e468b4e45b190bdbd" }, "traceTitle": { "data": "标题: 数百春梅傲春" }, "traceName": { "data": "发送人: 管理员" }, "traceTime": { "data": "发送时间: 2024-05-01" }, "trace_instance_index_id": { "data": "" } }, "msg_status": "0" } ```