Api设计

抽奖活动API

2017-02-16  本文已影响399人  kingsonCai

抽奖活动API

提供给机构管理后台接口

新建活动

API

[POST] /api/v3/activitys

请求参数

参数 类型 允许为空 描述
activity_name String 活动名称
background String 背景图片链接
logo String 机构logo链接
music String 背景音乐链接
activity_desc String 活动描述
permission String 限制参与的会议id
collect_info String 收集的用户信息,用逗号隔开
barcode String 二维码短地址
agency_id String 机构id
awards String 设置奖项
close_time String 截止时间

Awards:
[
{
"prize_name": "奖项名称",
"prize_desc": "奖品描述",
"prize_picture": "奖品图片链接",
"number": "抽中人数"
},
{
"prize_name": "奖项名称",
"prize_desc": "奖品描述",
"prize_picture": "奖品图片链接",
"number": "抽中人数"
}
]

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data String 活动ID

code值含义:

{
  0:请求成功
  601:操作失败
  40010:会员已经存在
}

Sample

[POST] http://localhost:9999/api/v3/activitys?access_token=xxx&access_type=org

Body:

{
  "activity_name": "抽奖1",
  "background": "http://pic2.cxtuku.com/00/02/31/b945758fd74d.jpg”,
  "logo":"",
  "music": "",
  "activity_desc": "天商未来回馈粉丝的抽奖活动",
  "permission": "",
  "collect_info": "name,phone",
  "barcode": "链接",
  "agency_id": "非空",
  "awards": []
}

Return:

{
  "code": 0,
  "msg": "创建成功",
  "data": “1”
}

查询活动内容

API

[GET] /api/v3/activitys/{id}

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data Object 返回数据

Data:

参数 类型 允许为空 描述
activity_id String 活动id
activity_name String 活动名称
background String 背景图片链接
logo String 机构logo链接
music String 背景音乐链接
activity_desc String 活动描述
permission String 限制参与的会议id
collect_info String 要收集的用户信息
barcode String 二维码短地址
awards Array 奖项

Awards:
[
{
“prize_name”: "奖项名称",
“prize_desc”: "奖品描述",
"prize_picture": "奖品图片链接",
"number": "抽中人数"
},
{
“prize_name”: "奖项名称",
“prize_desc”: "奖品描述",
"prize_picture": "奖品图片链接",
"number": "抽中人数"
},
]

code值含义:

{
  0:请求成功
  601:操作失败
  404:没有找到
  40010:会员已经存在
}

Sample

[GET] http://localhost:9999/api/v3/activitys/1?access_token=xxx&access_type=org

Return:

{
  "code": 0,
  "msg": “查询成功",
  "data": {
          暂略
     }
}

更新活动内容

API

[PUT] /api/v3/activitys/{id}

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型
activity_name String 活动名称
background String 背景图片链接
logo String 机构logo链接
music String 背景音乐链接
activity_desc String 活动描述
permission String 限制参与的会议id
collect_info String 要收集的用户信息,用逗号隔开
barcode String 二维码短地址
awards String 奖项,修改的奖项带id ,新增的奖项不带id

Awards:
[
{
"id":"奖项id",
“prize_name”: "奖项名称",
“prize_desc”: "奖品描述",
"prize_picture": "奖品图片链接",
"number": "抽中人数"
},
{
“prize_name”: "奖项名称",
“prize_desc”: "奖品描述",
"prize_picture": "奖品图片链接",
"number": "抽中人数"
},
]

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data String activity ID

Sample

[PUT] http://localhost:9999/api/v3/activitys/1?access_token=xxx&access_type=org

Body:

{
  "activity_name": “抽奖1”,
  "background": "http://pic2.cxtuku.com/00/02/31/b945758fd74d.jpg”,
  "logo": “”,
  “music”: "",
  “activity_desc”: “天商未来回馈粉丝的抽奖活动”,
  “permission: "",
  “collect_info”: ”name,phone“,
  “barcode”: “链接”,
  “awards":[]
}

Return:

{
  "code": 0,
  "msg": "更新成功",
  "data": “1”
}

删除活动

API

[DELETE] /api/v3/activitys/{id}

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data String activity ID

Sample

[DELETE] http://localhost:9999/api/activitys/{id}?access_token=xxx&access_type=org

Return:

{
  "code": 0,
  "msg": “删除活动成功”,
  "data”:1
}

获取机构所有活动列表

API

[GET] /api/v3/activitys

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型
agency_id String 机构ID

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data Array 活动列表
参数 类型 允许为空 描述
activity_id String 活动id
activity_name String 活动名称
background String 背景图片链接
logo String 机构logo链接
join_count String 参与人数

Data:

参数 类型 允许为空 描述
activity_id String 活动id
activity_name String 活动名称
background String 背景图片链接
logo String 机构logo链接
join_count String 参与人数

Sample

[GET] http://localhost:9999/api/v3/activity?access_token=xxx&access_type=org&agency_id=1

Return:

{
  "code": 0,
  "msg": “获取活动列表成功",
  "data": [
        {
          "id":1,
          "activity_name":"lottery1",
          "background":"xxxx",
          "logo":"xxxx",
          "join_count": 10
       },      
        {
          "id":2,
          "activity_name":"lottery2",
          "background":"xxxx",
          "logo":"xxxx",
          "join_count": 10
       },               
}

获取中奖名单

API

[GET] /api/v3/activitys/{id}/win_lottery

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data String 中奖名单

Sample

[GET] http://localhost:9999/api/v3/activitys/1/win_lottery?access_token=xxx&access_type=org

Return:

{
  "code": 0,
  "msg": “获取中奖名单成功",
  "data": {}
}

Data:

参数 类型 允许为空 描述
win_id String 中奖id
prize_name String 奖项名称
prize_desc String 奖品描述
prize_picture String 奖品图片地址
nickname String 用户昵称
icon String 用户头像
phone String 用户手机
real_name String 用户姓名
win_status String 兑奖状态

分页获取中奖名单

API

[GET] /api/v3/activitys/{id}/win_lottery_partition

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型
page_size String 一页显示行数
page_index String 页索引

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data JSON 中奖名单

Sample

[GET] http://localhost:9999/api/v3/activitys/1/win_lottery_partition?access_token=xxx&access_type=org&page_size=10&page_index=1

Return:

{
  "code": 0,
  "msg": “读取成功",
  "data": {
      "total":10
      "current_page":[]
}
}

current_page的数据项:

参数 类型 允许为空 描述
win_id String 中奖id
prize_name String 奖项名称
prize_desc String 奖品描述
prize_picture String 奖品图片地址
nickname String 用户昵称
icon String 用户头像
phone String 用户手机
real_name String 用户姓名
win_status String 兑奖状态

获取参与抽奖名单

API

[GET] /api/v3/activitys/{id}/join_lottery

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型
search String 模糊搜索条件

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data Array 参与抽奖名单

<span id="join_list"></span>
data数组数据项格式:

参数 类型 允许为空 描述
id String id
nickname String 用户昵称
icon String 用户头像
phone String 用户手机
real_name String 用户姓名
create_time String 创建时间
join_status String 中奖状态
member_source String 用户来源
set_default_awards String 是否设置了内定奖项

join_status:

{
  0:未中奖
  1:已中奖
}

member_source:

{
  'wx':来源是微信
  'offline':线下导入
}

set_default_awards:

{
  'true':设置了内定奖项
  'false':未设置内定奖项
}

分页获取参与抽奖名单

API

[GET] /api/v3/activitys/{id}/join_lottery_partition

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型
page_size String 一页显示行数
page_index String 页索引
search String 模糊搜索条件

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data JSON 参与抽奖名单

Data:

{
      "total": 整数
      "current_page": 数组
}

current_page数组的数据项格式:
同获取参与抽奖名单返回的参数

参数 类型 允许为空 描述
id String id
nickname String 用户昵称
icon String 用户头像
phone String 用户手机
real_name String 用户姓名
create_time String 创建时间
join_status String 中奖状态
member_source String 用户来源
set_default_awards String 是否设置了内定奖项

join_status:

{
  0:未中奖
  1:已中奖
}

member_source:

{
  'wx':来源是微信
  'offline':线下导入
}

set_default_awards:

{
  'true':设置了内定奖项
  'false':未设置内定奖项
}

导出参与抽奖的名单

API

[GET] /api/v3/activitys/{id}/join_lottery_export

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型

返回
excel表joinlist.xlsx

导出中奖名单

API

[GET] /api/v3/activitys/{id}/win_lottery_export

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型

返回
excel表winlist.xlsx

设置用户已兑奖

API

[POST] /api/v3/activitys/{id}/give_awards?
access_token=xxx&access_type=org

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型
win_ids String 中奖ids

win_ids:多个中奖id,用#隔开

Sample

[GET] http://localhost:9999/api/v3/activitys/1/give_awards?access_token=xxx&access_type=user

Body:

{
  "awards_ids": "1#2#3"
}

Return:

{
  "code": 0,
  "msg": "成功获取",
  "data": 520
}

提供给微信公众号接口

查询授权会议

API

[GET] /api/v3/activitys/{id}/wx/auth_meeting

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data String 0 或 meeting_id, 0表示没有会议授权

Sample

[GET] http://localhost:9999/api/v3/activitys/1/wx/auth_meeting?access_token=xxx&access_type=user

Return:

{
  "code": 0,
  "msg": "成功获取",
  "data": 520
}

待收集的用户信息

API

[GET] /api/v3/activitys/{id}/wx/collect_info

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data String 需要收集的信息“name,phone" or "name" or "phone"

Sample

[GET] http://localhost:9999/api/v3/activitys/1/wx/collect_info?access_token=xxx&access_type=org

Return:

{
  "code": 0,
  "msg": "成功获取",
  "data": "phone,name"
}

查询活动成员中奖信息

API

[GET] /api/v3/activitys/{id}/wx/member/:member_id/award_info

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data Object 中奖信息

Data:

参数 类型 允许为空 描述
activity_name String 活动名称
create_time String 参与时间
nickname String 昵称
icon String 头像短地址
real_name String 真实名字
phone String 手机号码
prize_name String 奖项名称
prize_desc String 奖项描述
prize_picture String 奖品图片链接
status String 领奖状态
close_time String 兑奖时间

Sample

[GET] http://localhost:9999/api/v3/activitys/2/wx/awards/2/member/2?access_token=xxx&access_type=org

Return:

{
  "code": 0,
  "msg": "查询活动成员中奖信息成功",
  "data": {
    "status": "1",
    "activity_name": "xxxx",
    "create_time": 20170220205602,
    "nickname": "520too",
    "icon": "xxx",
    "real_name": "xxx",
    "phone": "13800138000",
    "prize_name": "奖项名称1",
    "prize_desc": "奖品描述",
    "prize_picture": "奖品图片链接",
    "close_time": 20170220205602
  }
}

查询是否已经参与抽奖

API

[GET] /api/v3/activitys/{id}/wx/hasJoin/{member_id}

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data String 0或1, 0:未参与,1:已经参与

Sample

[GET] http://localhost:9999/api/v3/activitys/2/wx/hasJoin?access_token=xxx&access_type=org

Return:

{
  "code": 0,
  "msg": "成功获取",
  "data": 1
}

上传用户微信头像URL和昵称

API

[POST] /api/v3/activitys/{id}/wx/userInfo

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型
member_icon String 头像url
member_nickname String 昵称
member_id String 活动成员id
member_real_name String 活动成员姓名
member_phone String 活动成员手机号码

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data int 成员id

Sample

[POST] http://localhost:9999/api/v3/activitys/1/wx/userInfo?access_token=xxx&access_type=org

Body:

{
  "member_icon": "xxx",
  "member_nickname": "abc”,
  "member_id": “xxxx”
}

Return:

{
  "code": 0,
  "msg": "提交用户微信信息成功",
  "data": "xxxx"
}

中奖反馈(服务器=>公众号,再由公众号推给微信用户)

API

[POST] /api/v3/activitys/feedback

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型,此处传值user
info String 活动反馈信息
member_id String 活动成员id
activity_id String 活动id
awards_id String 奖项id

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data int 活动成员id

Sample

[POST] http://localhost:9999/api/v3/activity/feedback?access_token=xxx&access_type=user&member_id&info

Body:

{
  "member_id": "xxx",
  "info": "xxxx”,
  "activity_id":2,
  "awards_id":1
}

Return:

{
  "code": 0,
  "msg": "反馈成功",
  "data":"xxxx",
}

提供给活动页面的接口

获取活动页面信息(二维码,奖项,背景图片,背景音乐)

API

[GET] /api/v3/activitys/{id}/page

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型,此处传值user

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data JSON 活动内容信息

Data:

参数 类型 允许为空 描述
barcode String 二维码短地址
awards int 奖项
background Array 背景图片链接
music Array 背景音乐链接
join_count Array 参与抽奖人数

Awards:
[
{
“prize_name”: "奖项名称",
“prize_desc”: "奖品描述",
"prize_picture": "奖品图片链接",
"number": "抽中人数",
"win_prize":"已中奖名单"
},
{
“prize_name”: "奖项名称",
“prize_desc”: "奖品描述",
"prize_picture": "奖品图片链接",
"number": "抽中人数",
"win_prize":"已中奖名单"
},
]

Sample

[GET] http://localhost:9999/api/v3/activitys/1/page?access_token=xxx&access_type=user

Return:

{
      暂略
}

中奖用户名单

API

[GET] /api/v3/activitys/{id}/win_lottery/category

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型,此处传值user

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data JSON 中奖名单

Data:
[
{
“awards”: 奖项名称,
“content”:[
{"member_id":"活动成员id",“nickname”:"昵称",“icon”:”头像链接”},
{"member_id":"活动成员id",“nickname”:"昵称",“icon”:”头像链接”}
]
},
{
“awards”: 奖项名称,
“content”:[
{"member_id":"活动成员id",“nickname”:"昵称",“icon”:”头像链接”},
{"member_id":"活动成员id",“nickname”:"昵称",“icon”:”头像链接”}
]
}
]

奖项名单信息:

参数 类型 允许为空 描述
nickname String 昵称
icon String 微信头像链接

Sample

[GET] http://localhost:9999/api/v3/activitys/1/win_lottery/category?access_token=xxx&access_type=user

Return:

{
      暂略
}

抽奖(废弃,改用批量抽奖接口)

API

[GET] /api/v3/activitys/{id}/awards/{id}/drawresult

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型,此处传值user

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data JSON 中奖名单

Data:
[
{
"member_id": "活动成员id",
"member_nickname": "昵称",
"member_icon": "xxx",
"member_real_name": "xxx",
"member_phone": "手机号码"
},
{
"member_id": 1,
"member_nickname": "520",
"member_icon": "xxx",
"member_real_name": "xx",
"member_phone": ""
}
]

奖项名单信息:

参数 类型 允许为空 描述
nickname String 昵称
icon String 微信头像链接

Sample

[GET] http://localhost:9999/api/v3/activitys/2/awards/5/drawresult?access_token=xxx&access_type=user

Return:

{
  "code": 0,
  "msg": "抽奖成功",
  "data": [
    {
      "member_id": 2,
      "member_nickname": "520too",
      "member_icon": "xxx",
      "member_real_name": "xxx",
      "member_phone": 13800138000
    },
    {
      "member_id": 1,
      "member_nickname": "520",
      "member_icon": "xxx",
      "member_real_name": "xx",
      "member_phone": 0
    }
  ]
}

批量抽奖

API

[GET] /api/v3/activitys/{id}/awards/{id}/batchdraw/{num}

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型,此处传值user

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data JSON 中奖名单

Data数据项:

参数 类型 允许为空 描述
member_id String 成员ID
member_nickname String 昵称
member_icon String 微信头像链接
member_real_name String 名字
member_phone String 手机号码

Sample

[GET] http://localhost:9999/api/v3/activitys/2/awards/5/batchdraw/1?access_token=xxx&access_type=user

Return:

{
  "code": 0,
  "msg": "抽奖成功",
"data": [
    {
      "member_id": 2,
      "member_nickname": "520too",
      "member_icon": "xxx",
      "member_real_name": "xxx",
      "member_phone": 13800138000
    },
    {
      "member_id": 1,
      "member_nickname": "520",
      "member_icon": "xxx",
      "member_real_name": "xx",
      "member_phone": 0
    }
  ]
}

导出参与名单的报表模板

API

[GET] /api/v3/activitys/{id}/excel_template

返回

excel表import_members_template.xlsx

导入参与名单

API

[POST] /api/v3/activitys/{id}/batch_members

请求参数

参数 类型 允许为空 描述
fileLink String 文件链接

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data int 成功返回活动ID,失败返回数组

若失败,data数组的每个数据项格式:

{
  member_name:  姓名
  member_phone: 手机
  msg: 失败原因
}

内定中奖名单列表

API

[GET] /api/v3/activitys/{id}/default_win_list

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型
page_size String 一页显示行数
page_index String 页索引
search String 模糊搜索条件

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data Array 内定中奖名单

data数组数据项格式:

参数 类型 允许为空 描述
member_id String 成员ID
member_nickname String 昵称
member_icon String 微信头像链接
member_real_name String 名字
member_phone String 手机号码
member_status String 成员状态
prize_name String 设置奖项名称

member_status:

{
   0:未中奖
   1:已中奖
}

获取待添加到内定名单的列表

API

[GET] /api/v3/activitys/{id}/members_for_set_default_win

请求参数

参数 类型 允许为空 描述
access_token String 访问凭证
access_type String 凭证类型
page_size String 一页显示行数
page_index String 页索引
search String 模糊搜索条件

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data JSON 参与抽奖名单

Data:

{
      "total": 整数
      "current_page": 数组
}

current_page数组的数据项格式:

参数 类型 允许为空 描述
id String id
nickname String 用户昵称
icon String 用户头像
phone String 用户手机
real_name String 用户姓名
create_time String 创建时间
join_status String 中奖状态
member_source String 用户来源

member_source:

{
  'wx':来源是微信
  'offline':线下导入
}

添加内定中奖人

API

[POST] /api/v3/activitys/{id}/add_default_winer/add/{member_id}/to/{awards_id}
[POST] /api/v3/activitys/{id}/add_default_winer/{member_id}

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data int 内定成员ID

修改内定中奖人的关联奖项

API

[PUT] /api/v3/activitys/{id}/awards_relation/relate/{member_id}/to/{awards_id}

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data int 内定成员ID

奖项列表

API

[GET] /api/v3/activitys/{id}/awards_list

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data Array 奖项列表

删除参与抽奖成员

API

[DELETE] /api/v3/activitys/{id}/join_member/{member_id}

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data int 抽奖成员ID

删除内定中奖成员

API

[DELETE] /api/v3/activitys/{id}/default_winer/{member_id}

返回参数

参数 类型 允许为空 描述
code int 状态码
msg String 描述文字
data int 内定成员ID
上一篇 下一篇

猜你喜欢

热点阅读