1. 消息推送

通过开放平台推送轻筑消息

注意

  • 如果接口需要提供auth-token,你需要通过轻筑开放平台创建应用来获取appid和secret,然后通过appid和secret来获取接口访问凭证auth-token。
  • 如果需要获取当前用户的使用信息,授权确保你能获取到qzcode,然后通过网页授权接口获取相关信息。
  • 消息支持点击跳转不跳转两种方式,通过设置消息点击处理方式来发送不同处理方式的消息。
  • 如需设置消息封面图片,请先调用上传文件接口,将图片上传并获取上传后的链接。
  • 当跳转类型为授权链接时,会在消息跳转时在 url 上附带 qzcode,第三方可以通过 qzcode 调用用户授权接口获取当前的用户信息。

1.1. 基本信息

概况 内容
接口地址 /api/platform/message/send
请求方法 POST
请求数据类型 JSON
响应数据类型 JSON

1.2. 请求数据

1.2.1. 请求头(request-header)

请求头除了默认的参数还需要添加如下请求头参数:

字段 描述
auth-token 接口访问凭据,你可以通过平台下发的appid和secret获取凭据
Content-Type application/json;charset=UTF-8

1.2.2. 请求体(request-body)

字段 类型 是否必填 描述
title string 消息标题
subTitle string 消息副标题
content string 消息内容(200字以内)
accessHandle number 消息点击处理方式,缺省为 自动检测。 0 = 自动检测, 1 = 跳转msgUrl指定链接(此时msgUrl字段不能为空字符串或null), 2 = 无跳转(此时msgUrl字段将会被忽略)。
自动检测:检测传入的msgUrl字段,若为空字符串或null则无跳转,否则跳转到mgsUrl给定链接
msgUrl string 消息跳转链接。当accessHandle = 1时,此字段不能为空字符串或null
accessType number 消息跳转类型(1 =授权链接, 2 = 普通链接),授权链接将会在跳转到消息链接时附带qzcode
msgType number 消息类型(1 = 劳务模块消息,2 = 安全模块消息)
memberIds array 消息接收人成员ID列表(至少包含一个)
pictureUrl string 消息封面图片链接(不带签名)

1.3. 响应数据

响应数据中 code, message, data 为默认字段,所有字段如下表所示:

字段 类型 是否必填 描述
code number 返回码,1为正常返回,其他为错误返回
message string 返回消息
data string 正常返回数据字段,可能为null

响应数据结构如下所示:

{
  "code" : 0,
  "message" : "XXX",
  "data" : null
}

1.4. 错误码

当返回数据中的 code 不为 0 时,为错误返回。其中errCode为详细的错误码。

© All Rights Reserved            updated 2024-08-23 10:14:55

results matching ""

    No results matching ""