版本比较

旧版本 3

changes.mady.by.user 未知用户 (lilonghong)

保存于

比较

新版本 当前版本

changes.mady.by.user 未知用户 (lilonghong)

保存于

标识

  • 该行被添加。
  • 该行被删除。
  • 格式已经改变。

...

  1. 当活动发布成功后，会推送活动信息给第三方

3、活动接口调用

     1）获取活动列表 1）获取活动列表    

/api/integrate/activity/getActivityList

请求方式 POST

consumes ["application/json"]

...

参数名称参数说明请求类型参数类型是否必须描述
X-Token自建应用访问tokenheaderstringtrue
activityName
活动标题bodystringfalse
activityStatus活动状态bodystringfalse
活动状态：0未发布,1发布申请中,2已发布,3已发布有修改,4修改申请中,5已下线,10未开始,11进行中,12已过期
deptIds
归属部门
bodystringfalse


pageNo
页码bodyintfalse默认值为1
pageSize每页记录数bodyintfalse默认值为5

出参说明

参数名称参数说明参数类型描述
activityId
活动Idlong
activityName
活动标题string
activityCode
活动编号string

beginTime
活动开始时间
date


endTime
活动结束时间
date
orgId企业Idstring
activityIntroduction
活动简介string
totalBudget
总预算decimal
activityStatus
活动状态
int
活动状态：0未发布,1发布申请中,2已发布,3已发布有修改,4修改申请中,5已下线
approveStatus
审批状态
int
0空,1待提交审批,2发布审批中,3发布审批通过,4发布审批驳回,5发布审批撤销,6下线审批中,7下线审批通过,
8下线审批驳回,9下线审批撤销,10删除审批中,11删除审批驳回,12删除审批撤销
createUserId
创建人用户Id
string

deptRelVo
归属部门信息
object
{
    "deptRelVo":{
        "deptId":"872871040115032064", // 部门Id
        "deptName":"兔展智能科技/企业微信应用消息" // 部门名称 全路径
    }
}
create_time创建时间date
update_time更新时间date

4、返回触达结果


 

 2）获取活动详情

/api/integrate/activity/getActivityDetail

请求方式 GET

入参说明 1） 同步返回

参数名称参数说明请求类型参数类型是否必须描述
code
X-Token自建应用访问tokenheaderstringtrue
请求码，200-请求成功，其他为请求失败resultinttrue触达结果，1为触达成功，0为触达失败timestamplongfalse时间戳格式，触达用户的时间msgstringtrue触达失败原因，客户回调兔展接口返回，当触达用户失败时（即code不等于200时）需要填写

2) 异步返回   调用工作台接口

接口地址 /api/integrate/callback/getMessage

请求方式 POST

consumes ["application/json"]

produces ["application/json"]

接口描述 企业级接口，hearer必须携带X-Token


activityId
活动Idbodylongtrue

出参说明

参数名称参数说明参数类型描述
activityId
活动Idlong
activityName
活动标题string
activityCode
活动编号string

beginTime
活动开始时间
date


endTime
活动结束时间
date
deptId所属部门long
activityIntroduction
活动简介string
totalBudget
总预算decimal
activityStatus
活动状态
int
活动状态：0未发布,1发布申请中,2已发布,3已发布有修改,4修改申请中,5已下线
approveStatus
审批状态
int
0空,1待提交审批,2发布审批中,3发布审批通过,4发布审批驳回,5发布审批撤销,6下线审批中,7下线审批通过,
8下线审批驳回,9下线审批撤销,10删除审批中,11删除审批驳回,12删除审批撤销
awardVoList
权益列表
list
{
"id":"984150119322968064", //权益Id
 "awardName":"One Piece", //权益名称
 "costPrice":9.9, // 成本单价
 "totalStock":0, // 奖品总数
 "budgetPrice":0, //预算小计
 "extraMultiple":0, // 额外倍数
 "awardType":"PRIZE" //  PRIZE=奖品 , COUPON=优惠券 , POINT=积分 , REDPACKET=红包
 }
activityItemBudgetVoList
预算列表
list
{
 "activityId":"978343893456105472", // 活动Id
 "orgId":"487aa4e1-cc06-4758-85e5-600705a05a94", // 企业Id
 "budgetName":"微信红包预算", // 预算名称
 "usedBudget":1.2, // 已使用预算
 "consumeCost":0, // 已消耗成本
 "remainBudget":1.2, //剩余预算
 "type":"REDPACKET" // PRIZE=奖品 , COUPON=优惠券 , POINT=积分 , REDPACKET=红包， CUSTOM=自定义
 }
appContentVoList
作品列表
list
{
    "appId":"c3a8e5dc-185d-4ad8-ae38-ef64deedcb4e", //作品Id
    "orgId":"487aa4e1-cc06-4758-85e5-600705a05a94", //企业Id
    "userId":"9c36b6e7-8c4c-4d78-94a8-41aad63ded78",// 创建人Id
    "appName":"我的兔展作品", // 作品名称
    "appDesc":"我用兔展做了一个超炫酷的H5,快来看看吧！", // 描述
    "shortUrl":"FrWpVqdvTgF", // 短链
    "appTags":[
        "942476802029531136", //标签id
        "935542501048463360"
    ],
    "publish":1, // 是否发布；1 是；0否
    "deleteFlag":0, //是否删除；1 是；0否,
  "contentPlayVoList":{
        "componentId":135,
        "pluginName":"玩法001",
        "prizeInfoDtos":[
            {
                "prizeId":"奖品Id",
                "interestId":"权益Id",
                "thirdAwardId":"第三方奖品Id",
                "awardName":"奖品名称",
                "awardLevel":"奖品等级",
                "awardNum":888
            }
        ]
    }
}


4、活动变更推送信息入参说明

参数名称参数说明请求类型参数类型
是否必须
描述
X-Token
signature
自建应用访问token
接口签名header
truetrue
msgId
消息Id
string可用于第三方鉴权，加密方式参考签名鉴权
nonce
6位随机字符串bodystring
timestamp时间戳bodystring当前时间戳（毫秒）
activityId活动Idbodylong
trueresult触达结果bodyinttruetimestamp时间戳，触达用户的时间bodylong

 false

msg触达失败原因bodystringfalse

activityCode活动编码bodystring
activityName活动名称bodystring
beginTime
活动开始时间
body

date


endTime
活动结束时间
bodydate
activityIntroduction
活动简介bodystring
deptId所属部门bodylong
createUserId创建人bodystring
orgId企业Idbodystring
totalBudget
总预算bodydecimal
activityStatus
活动状态
body
int
活动状态：0未发布,1发布申请中,2已发布,3已发布有修改,4修改申请中,5已下线
approveStatus
审批状态
body
int
0空,1待提交审批,2发布审批中,3发布审批通过,4发布审批驳回,5发布审批撤销,6下线审批中,7下线审批通过,
8下线审批驳回,9下线审批撤销,10删除审批中,11删除审批驳回,12删除审批撤销
create_time创建时间bodydate
update_time更新时间bodydate
awardVoList
权益列表
body
list
{
"id":"984150119322968064", //权益Id
 "awardName":"One Piece", //权益名称
 "costPrice":9.9, // 成本单价
 "totalStock":0, // 奖品总数
 "budgetPrice":0, //预算小计
 "extraMultiple":0, // 额外倍数
 "awardType":"PRIZE" //  PRIZE=奖品 , COUPON=优惠券 , POINT=积分 , REDPACKET=红包
 }

activityItemBudgetVoList
预算列表
body
list
{
 "budgetName":"微信红包预算", // 预算名称
 "usedBudget":1.2, // 已使用预算
 "consumeCost":0, // 已消耗成本
 "remainBudget":1.2, //剩余预算
 "type":"REDPACKET" // PRIZE=奖品 , COUPON=优惠券 , POINT=积分 , REDPACKET=红包， CUSTOM=自定义
 }
appContentVoList
作品列表
body
list
{
    "appId":"c3a8e5dc-185d-4ad8-ae38-ef64deedcb4e", //作品Id
    "orgId":"487aa4e1-cc06-4758-85e5-600705a05a94", //企业Id
    "userId":"9c36b6e7-8c4c-4d78-94a8-41aad63ded78",// 创建人Id
    "appName":"我的兔展作品", // 作品名称
    "appDesc":"我用兔展做了一个超炫酷的H5,快来看看吧！", // 描述
    "shortUrl":"FrWpVqdvTgF", // 短链
    "appTags":[
        "942476802029531136", //标签id
        "935542501048463360"
    ],
    "publish":1, // 是否发布；1 是；0否
    "deleteFlag":0, //是否删除；1 是；0否,
  "contentPlayVoList":{
        "componentId":135,
        "pluginName":"玩法001",
        "prizeInfoDtos":[
            {
                "prizeId":"奖品Id",
                "interestId":"权益Id",
                "thirdAwardId":"第三方奖品Id",
                "awardName":"奖品名称",
                "awardLevel":"奖品等级",
                "awardNum":888
            }
        ]
    }
}