抽奖活动API

• 获取参与抽奖名单
• 分页获取参与抽奖名单
• 导出参与名单的报表模板
• 导入参与名单
• 内定中奖名单列表
• 获取待添加到内定名单的列表
• 添加内定中奖人
• 修改内定中奖人的关联奖项
• 奖项列表
• 删除参与抽奖成员
• 删除内定中奖成员

提供给机构管理后台接口

新建活动

API

[POST] /api/v3/activitys

请求参数

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

返回参数

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}

请求参数

返回参数

Data:

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}

请求参数

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

返回参数

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}

请求参数

返回参数

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

请求参数

返回参数

Data:

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

请求参数

返回参数

Sample

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

Return:

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

Data:

分页获取中奖名单

API

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

请求参数

返回参数

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的数据项:

获取参与抽奖名单

API

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

请求参数

返回参数

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

join_status:

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

member_source:

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

set_default_awards:

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

分页获取参与抽奖名单

API

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

请求参数

返回参数

Data:

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

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

join_status:

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

member_source:

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

set_default_awards:

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

导出参与抽奖的名单

API

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

请求参数

返回
excel表joinlist.xlsx

导出中奖名单

API

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

请求参数

返回
excel表winlist.xlsx

设置用户已兑奖

API

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

请求参数

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

请求参数

返回参数

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

请求参数

返回参数

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

请求参数

返回参数

Data:

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}

请求参数

返回参数

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

请求参数

返回参数

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

请求参数

返回参数

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

请求参数

返回参数

Data:

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

请求参数

返回参数

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”:”头像链接”}
]
}
]

奖项名单信息:

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

请求参数

返回参数

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": ""
}
]

奖项名单信息:

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}

请求参数

返回参数

Data数据项:

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

请求参数

返回参数

若失败，data数组的每个数据项格式：

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

内定中奖名单列表

API

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

请求参数

返回参数

data数组数据项格式:

member_status:

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

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

API

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

请求参数

返回参数

Data:

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

current_page数组的数据项格式:

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}

返回参数

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

API

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

返回参数

奖项列表

API

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

返回参数

删除参与抽奖成员

API

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

返回参数

删除内定中奖成员

API

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

返回参数