V24.6

平台消息提醒

POST

/openApi/sns/sendAppAboutNotice

后端接口/消息服务

接口说明

此接口用于消息推送（推送至启聊、消息中心、门户消息提醒组件）

适用场景
以【发送警报提醒】接口为例：业务方满足一定触发条件后发送警报提醒。

SDK使用

请求参数

Header 参数

Content-Type

string

必需

application/json

secretId

string

密钥

必需

randomStr

string

随机字符串

必需

sign

string

签名

必需

string

101

可选

默认值:

PHPSESSID=2b6bcd0d-8fbe-4dfc-86f7-1f52397d4b0a; access_token=2b6bcd0d-8fbe-4dfc-86f7-1f52397d4b0a

X-Qpaas-Dev-Tags

string

共用环境（本地）

可选

默认值:

ylh

Body 参数application/json

noticeData

object

必需

app

string

必需

消息类型（eg：appnotice，根据业务需求来）

示例值:

消息类型(eg：appnotice，根据业务场景传参)

app_key

string

可选

规则：DF（information_应用ID_表ID_记录ID）；WF:（workflow_应用ID_instance_记录ID），open为link、forbidden时可不必传，但此时消息会放到“业务提醒”分类下，若传的话消息会放到对应的系统分类下。

示例值:

workflow_ShuJuFenXiQi_instance_312

new_app_title

string

必需

应用名称或消息业务固定值

示例值:

应用名称或者业务标识标题

receivers

array[string]

必需

消息接收人的用户ID集合

示例值:

["admin_pretest"]

sender

string

必需

消息发送人的用户ID

示例值:

admin_pretest

new_node_key

string

可选

流程数据相关消息必传，若需要消息跳转到流程数据详情页或者列表页时传此参数

示例值:

WorkNode_2

new_main_content

string

必需

用于区分消息权重，目前只有“通知”|“待办”两中分类

示例值:

通知|待办

body

string

必需

通知内容（不适宜放太长内容，过长不展开详情）

示例值:

通知内容

desc

string

可选

详细通知内容（内容过长会展开详情）

示例值:

详细通知内容

open

string

必需

消息跳转方式（范围：add新建页，detail详情页，list列表页，forbidden禁止跳转，link直接跳转link参数的地址）

示例值:

forbidden

link

string

可选

跳转链接（若open的值为link时，则此参数必传）

示例值:

forbidden

webLink

string

可选

跳转链接（若open的值为link时，则此参数必传，此参数用于web和app两端需要跳转不同的链接，不传则默认与link值一致）

示例值:

forbidden

entId

string

消息所属的企业id

必需

示例值:

forbidden

chatGroups

array[string]

可选

群组ID集合，用户发送启聊群消息

示例

{
  "noticeData": {
    "app": "消息类型(eg：appnotice，根据业务场景传参)",
    "app_key": "workflow_ShuJuFenXiQi_instance_312",
    "new_app_title": "应用名称或者业务标识标题",
    "receivers": "[\"admin_pretest\"]",
    "sender": "admin_pretest",
    "new_node_key": "WorkNode_2",
    "new_main_content": "通知|待办",
    "body": "通知内容",
    "desc": "详细通知内容",
    "open": "forbidden",
    "link": "forbidden",
    "webLink": "forbidden",
    "entId": "forbidden",
    "chatGroups": [
      "string"
    ]
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/openApi/sns/sendAppAboutNotice' \
--header 'secretId;' \
--header 'randomStr;' \
--header 'sign;' \
--header 'X-Qpaas-Dev-Tags: ylh' \
--header 'Cookie: PHPSESSID=2b6bcd0d-8fbe-4dfc-86f7-1f52397d4b0a; access_token=2b6bcd0d-8fbe-4dfc-86f7-1f52397d4b0a' \
--header 'Content-Type: application/json' \
--data-raw '{
    "noticeData": {
        "app": "消息类型(eg：appnotice，根据业务场景传参)",
        "app_key": "workflow_ShuJuFenXiQi_instance_312",
        "new_app_title": "应用名称或者业务标识标题",
        "receivers": "[\"admin_pretest\"]",
        "sender": "admin_pretest",
        "new_node_key": "WorkNode_2",
        "new_main_content": "通知|待办",
        "body": "通知内容",
        "desc": "详细通知内容",
        "open": "forbidden",
        "link": "forbidden",
        "webLink": "forbidden",
        "entId": "forbidden",
        "chatGroups": [
            "string"
        ]
    }
}'

返回响应

🟢200成功

application/json

Body

msg

string

必需

result

enum<boolean>

必需

true待办发送成功

枚举值:

示例值:

true

code

enum<number>

必需

枚举值:

示例值:

8010001

originResp

enum<string>

必需

枚举值:

示例值:

{"msg":"","result":true,"code":200,"guid":"5fa64243359722e1","status":200}

success

enum<boolean>

必需

枚举值:

示例值:

true

guid

enum<string>

必需

枚举值:

示例值:

edc2f7405104b1bd

uuid

enum<string>

必需

枚举值:

示例值:

edc2f7405104b1bd

status

enum<number>

必需

枚举值:

示例值:

200

示例

{
  "status": 200,
  "code": 200,
  "msg": "ok",
  "result": true,
  "guid": "f9426048c5ae5798"
}

发送websocket消息

发送邮件

平台消息提醒

接口说明#

SDK使用#

请求参数

示例代码

返回响应

接口说明

SDK使用