美文网首页
签到墙互动API(备份）

签到墙互动API(备份）

作者: kingsonCai | 来源:发表于2017-03-07 14:28 被阅读30次

    【提供给机构管理后台接口】

    新建活动

    API

    [POST] /activitys_signin

    请求参数

    参数 类型 允许为空 描述
    activity_name String 否 活动名称
    background String 否 背景图片链接
    logo String 否 机构logo链接
    music String 是 背景音乐链接
    permission String 是 限制参与的会议id
    collect_info String 是 收集的用户信息，用逗号隔开
    show_message_wall String 是 是否显示留言墙，'0':显示，'1':不显示
    agency_id String 是 机构id
    close_time String 是 截止时间

    返回参数

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

    code值含义：

    {
  0：请求成功
  1：操作失败
}

    Sample

    [POST] http://localhost:9999/activitys_signin?access_token=xxx&access_type=org

    Body:

    {
  "activity_name": "签到",
  "background": "http://pic2.cxtuku.com/00/02/31/b945758fd74d.jpg”,
  "logo":"",
  "music": "",
  "permission": "",
  "collect_info":"phone,name",
  "barcode": "链接",
  "agency_id": "非空",
  "close_time":"关闭时间"
}

    Return:

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

    查询活动内容

    API

    [GET] /activitys_signin/{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 否 背景音乐链接
    permission String 是 限制参与的会议id
    collect_info String 是 收集的用户信息，用逗号隔开
    close_time String 是 截止时间

    code值含义：

    {
  0：请求成功
  1：操作失败
}

    Sample

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

    Return:

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

    更新活动内容

    API

    [PUT] /activitys_signin/{id}

    请求参数

    参数 类型 允许为空 描述
    access_token String 否 访问凭证
    access_type String 否 凭证类型
    activity_name String 是 活动名称
    background String 是 背景图片链接
    logo String 是 机构logo链接
    music String 是 背景音乐链接
    permission String 是 限制参与的会议id
    collect_info String 是 收集的用户信息，用逗号隔开
    close_time String 是 截止时间

    返回参数

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

    Sample

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

    Body:

    {
  "activity_name": “签到墙1”,
  "background": "http://pic2.cxtuku.com/00/02/31/b945758fd74d.jpg”,
  "logo": “”,
  “music”: "",
  “permission: "",
  "collect_info":"name,phone"
}

    Return:

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

    删除活动

    API

    [DELETE] /activitys_signin/{id}

    请求参数

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

    返回参数

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

    Sample

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

    Return:

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

    获取机构所有活动列表

    API

    [GET] /activitys_signin

    请求参数

    参数 类型 允许为空 描述
    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/activitys_signin?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] /activitys_signin/{id}/message_list

    请求参数

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

    返回参数

    参数 类型 允许为空 描述
    code int 否 状态码
    msg String 是 描述文字
    data JSON 是 留言消息

    Data:

    参数 类型 允许为空 描述
    member_id String 否 签到成员ID
    member_icon String 否 成员头像
    member_nickname String 否 成员昵称
    member_message String 否 留言消息
    member_status String 否 成员状态

    member_status含义:

    0:未屏蔽状态
1:屏蔽状态

    Sample

    [GET] http://localhost:9999/activitys_signin/1/message_list?access_token=xxx&access_type=org

    Return:

    {
  "code": 0,
  "msg": “获取留言消息成功",
  "data": [
        {
          "member_id":1,
          "member_icon":"xxxx",
          "member_nickname":"xxxx",
          "member_message":"xxxx",
          "member_status": 0
       },      
        {
          "member_id":1,
          "member_icon":"xxxx",
          "member_nickname":"xxxx",
          "member_message":"xxxx",
          "member_status": 0
       },  
 ]
}

    分页获取留言消息

    API

    [GET] /activitys_signin/{id}/message_list_partition

    请求参数

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

    返回参数

    参数 类型 允许为空 描述
    code int 否 状态码
    msg String 是 描述文字
    data JSON 是 留言消息

    Sample

    [GET] http://localhost:9999/activitys_signin/100/message_list_partition?access_token=xxx&access_type=org&page_size=10&page_index=1

    Return:

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

    Data:

    参数 类型 允许为空 描述
    member_id String 否 签到成员ID
    member_icon String 否 成员头像
    member_nickname String 否 成员昵称
    member_message String 否 留言消息
    member_status String 否 成员状态

    获取签到成员名单

    API

    [GET] /activitys_signin/{id}/signin_member_list

    请求参数

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

    返回参数

    参数 类型 允许为空 描述
    code int 否 状态码
    msg String 是 描述文字
    data JSON 是 签到成员名单
    参数 类型 允许为空 描述
    member_id String 否 成员ID
    member_nickname String 否 用户昵称
    member_icon String 否 用户头像
    member_create_time String 否 创建时间

    Data:

    参数 类型 允许为空 描述
    member_id String 否 成员ID
    member_nickname String 否 用户昵称
    member_icon String 否 用户头像
    member_create_time String 否 创建时间

    Sample

    [GET] http://localhost:9999/activitys_signin/1/signin_member_list?access_token=xxx&access_type=org

    Return:

    {
  "code": 0,
  "msg": “读取成功",
  "data": [
        {
          "member_id":1,
          "member_icon":"xxxx",
          "member_nickname":"xxxx",
          "member_create_time":"xxxx"
       },      
        {
          "member_id":1,
          "member_icon":"xxxx",
          "member_nickname":"xxxx",
          "member_create_time":"xxxx"
       }
]

    分页获取签到成员名单

    API

    [GET] /activitys_signin/{id}/signin_member_list_partition

    请求参数

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

    返回参数

    参数 类型 允许为空 描述
    code int 否 状态码
    msg String 是 描述文字
    data JSON 是 签到成员名单
    参数 类型 允许为空 描述
    member_id String 否 成员ID
    member_nickname String 否 用户昵称
    member_icon String 否 用户头像
    member_create_time String 否 创建时间

    Data:

    参数 类型 允许为空 描述
    member_id String 否 成员ID
    member_nickname String 否 用户昵称
    member_icon String 否 用户头像
    member_create_time String 否 创建时间

    Sample

    [GET] http://localhost:9999/activitys_signin/1/signin_member_list_partition?access_token=xxx&access_type=org&page_size=10$page_index=1

    Return:

    {
  "code": 0,
  "msg": “读取成功",
  "data": [
        {
          "member_id":1,
          "member_icon":"xxxx",
          "member_nickname":"xxxx",
          "member_create_time":"xxxx"
       },      
        {
          "member_id":1,
          "member_icon":"xxxx",
          "member_nickname":"xxxx",
          "member_create_time":"xxxx"
       }
]

    禁言

    API

    [PUT] /activitys_signin/{id}/member/{member_id}/ban_message

    请求参数

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

    返回参数

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

    解除禁言

    API

    [PUT] /activitys_signin/{id}/member/{member_id}/allow_message

    请求参数

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

    返回参数

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

    【提供给微信公众号接口】

    查询授权会议

    API

    [GET] /activitys_signin/{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/activitys_signin/1/wx/auth_meeting?access_token=xxx&access_type=user

    Return:

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

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

    API

    [POST] /activitys_signin/{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/activitys_signin/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"
}

    【提供给活动页面的接口】

    注册活动

    客户端->服务端

    ACTION ：

    register

    请求参数

    参数 类型 允许为空 描述
    access_token String 否 访问凭证
    access_type String 否 凭证类型,此处传值org
    activity_id String 否 活动ID

    返回参数

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

    活动成员签到

    服务端->客户端

    ACTION

    join

    请求参数

    参数 类型 允许为空 描述
    access_token String 否 访问凭证
    access_type String 否 凭证类型,此处传值org
    member_id String 否 成员ID
    member_icon String 否 头像链接
    member_nickname String 否 昵称

    返回参数

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

    活动成员留言

    服务端->客户端

    ACTION

    message

    请求参数

    参数 类型 允许为空 描述
    access_token String 否 访问凭证
    access_type String 否 凭证类型,此处传值org
    member_id String 否 成员ID
    member_icon String 否 头像链接
    member_nickname String 否 昵称
    member_message String 否 留言消息

    返回参数

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

    发送留言消息

    API

    [POST] /activitys_signin/{id}/member/{id}/message

    请求参数

    参数 类型 允许为空 描述
    access_token String 否 访问凭证
    access_type String 否 凭证类型,此处传值user
    message_content String 是 消息内容

    返回参数

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

    Data:

    {
    "activity_id":xxx
     "member_id":xxx
}

    Sample

    [POST] /activitys_signin/52/member/666/message?access_token=xxx&access_type=org

    Body:

    {
  "message_content": "I love you"
}

    Return:

    {
  "code": 0,
  "msg": "操作成功",
  "data": {"activity_id":52,"member_id":666}
}

    屏蔽留言墙

    API

    [POST] /activitys_signin/{id}/ban_message_wall

    请求参数

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

    返回参数

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

    Sample

    [POST] /activitys_signin/52/ban_message_wall?access_token=xxx&access_type=org

    Return:

    {
  "code": 0,
  "msg": "操作成功",
  "data": 52
}

    显示留言墙

    API

    [POST] /activitys_signin/{id}/show_message_wall

    请求参数

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

    返回参数

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

    Sample

    [POST] /activitys_signin/52/show_message_wall?access_token=xxx&access_type=org

    Return:

    {
  "code": 0,
  "msg": "操作成功",
  "data": 52

    查询是否显示留言墙

    API

    [GET] /activitys_signin/{id}/is_show_message_wall

    请求参数

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

    返回参数

    参数 类型 允许为空 描述
    code int 否 状态码
    msg String 是 描述文字
    data Boolean 否 是否显示

    Sample

    [GET] /activitys_signin/52/is_show_message_wall?access_token=xxx&access_type=org

    Return:

    {
  "code": 0,
  "msg": "操作成功",
  "data": true

    获取活动页面信息（本接口暂不实现，若有需要再实现）

    API

    [GET] /activitys_signin/{id}/page

    请求参数

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

    返回参数

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

    相关文章

      网友评论

          本文标题：签到墙互动API(备份）

          本文链接：https://www.haomeiwen.com/subject/hfemgttx.html

          延伸阅读

          深度阅读

          • 您也可以注册成为美文阅读网的作者，发表您的原创作品、分享您的心情！

          栏目导航

          热点阅读

          关于我们|服务条款|联系我们|签到墙互动API(备份）|投稿指南|网站地图|RSS订阅|排版工具|手机版

          提供经典美文摘抄,优美散文欣赏,现代诗歌精选,短篇小说,心情随笔,表白情书范文,故事会在线阅读欣赏

          Copyright © 2014-2023 Haomeiwen.com All Rights Reserved. 好美文阅读网 版权所有

          备案信息：桂公网安备 45052102000051号 · 桂ICP备13007215号-3

          本站所收录作品、热点评论等信息部分来源互联网，目的只是为了系统归纳学习和传递资讯

          所有作品版权归原创作者所有，与本站立场无关，如不慎侵犯了你的权益，请联系我们告知，我们将做删除处理！