发送消息(API名称:addMessages)
功能介绍
最常用的消息发送接口。
相关接口
URL
请求方式 | HTTPS地址 | 服务架构 | 消息体类型 |
|---|---|---|---|
POST | https://isdp+域名/openapi/v1/messageFacede/addMessages | Rest | application/json |
请求头
KEY | VALUE | 是否必填 | 描述 |
|---|---|---|---|
Content-Type | application/json | 是 | 无 |
Authorization | bearer ${access_token} | 是 | bearer +“ ”+5.2.1中获取的access_token的值 |
请求参数
参数 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
msgTitle | String | 是 | 消息标题 |
msgType | String | 是 | 消息类型(一级分类) |
subcategory | String | 否 | 二级分类 |
msgDescription | String | 是 | 消息正文 |
publishTime | Date | 否 | 接收时间 |
readStatus | int | 否 | 消息状态 |
pubUserIds | String | 是 | 接收者的userId |
extended1 | String | 否 | 业务字段1 |
extended2 | String | 否 | 业务字段1 |
extended3 | String | 否 | 业务字段1 |
extended4 | String | 否 | 业务字段1 |
extended5 | String | 否 | 业务字段1 |
响应参数
参数 | 类型 | 描述 |
|---|---|---|
status | String | 状态 |
msg | String | 消息 |
data | List<Object> | 响应结果内容data |
data参数:
字段名 | 字段名称 | 数据类型 | 数据示例 |
msgTitle | 消息标题 | 是 | String |
msgType | 消息类型 | 是 | String |
subcategory | 二级分类 | 否 | String |
msgDescription | 消息正文 | 是 | String |
publishTime | 接收时间 | 否 | Date |
readStatus | 消息状态 | 否 | int |
Extended1 | 业务字段1 | 否 | String |
Extended2 | 业务字段1 | 否 | String |
Extended3 | 业务字段1 | 否 | String |
Extended4 | 业务字段1 | 否 | String |
Extended5 | 业务字段1 | 否 | String |
请求示例
{
"modelList": [
{
"pubUserIds": "1",
"pubTenantId": "1",
"msgDescription": "test",
"msgType": "0",
"msgTitle": "title",
"subcategory": "04_02",
"readStatus": "0",
"extended1": "test1",
"extended2": "test2",
"extended3": "test3",
"extended4": "test4",
"extended5": "test5"
}
]
} 响应示例
{
"status": "success",
"msg": null,
"data": [
4364138
],
"failed": false,
"success": true
} 状态码
状态码请参见状态码。
错误码
错误码请参见错误码。

