淘宝开放平台

登录
文档中心 > API类目 > 淘宝小程序API

淘宝小程序API

qimen.taobao.miniapp.msg.noticebar.get (小程序提醒条信息读取)

获取小程序对应的提醒条信息

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
appId Number 必须 3000022444 C端小程序id
openId String 必须 erqda2233 登录用户的openId

响应参数

名称 类型 示例值 描述
result ResultDTO 返回结果
  • └ success
  • Boolean
  • true
  • 是否成功
  • └ errMsg
  • String
  • 处理过程异常
  • 具体的错误信息
  • └ errCode
  • String
  • FAIL_XXX
  • 失败时，返回错误码
  • model
  • MiniAppNoticeBarInfo
  • 提醒条的详细信息
  • └ materialId
  • Number
  • 1002
  • 素材id，需要展示提醒条时，该字段必须返回
  • └ contentJson
  • String
  • {"intrest":"兴趣内容"}
  • 消息内容信息，基于每个消息模板支持的动态字段，注册素材的时候，请注意自己使用的消息模板支持哪些字段
  • └ bizId
  • String
  • abcdesf
  • 自定义参数的值，如果小程序未使用动态的自定义参数，则无需传递该字段。

请求示例

{"openId":"erqda2233","appId":0}

响应示例

{
    "result":{
        "success":true,
        "errMsg":"处理过程异常",
        "errCode":"FAIL_XXX",
        "model":{
            "materialId":1002,
            "contentJson":"{\"intrest\":\"兴趣内容\"}",
            "bizId":"abcdesf"
        }
    }
}

验签示例

{"result":{"success":"false","errCode":"sign-check-failure","errMsg":"Illegal request"}}

错误码解释

错误码 错误描述 解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问
返回
顶部