美文网首页
提问墙互动API

提问墙互动API

作者: kingsonCai | 来源:发表于2017-04-01 16:31 被阅读22次

    新建活动

    API

    [POST] /activitys_message

    请求参数

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

    返回参数

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

    code值含义：

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

    Sample

    [POST] http://localhost:9999/activitys_message?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",
  "send_question_limit":5
  "agency_id": "非空",
  "close_time":"关闭时间"
}

    Return:

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

    查询活动内容

    API

    [GET] /activitys_message/{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 是 收集的用户信息，用逗号隔开
    send_question_limit int 是 发送问题次数限制
    close_time String 是 截止时间

    code值含义：

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

    Sample

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

    Return:

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

    更新活动内容

    API

    [PUT] /activitys_message/{id}

    请求参数

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

    返回参数

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

    Sample

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

    Body:

    {
  "activity_name": “xxxx”,
  "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_message/{id}

    请求参数

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

    返回参数

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

    Sample

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

    Return:

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

    获取留言消息（可分页，也可不分页）

    API

    [GET] /activitys_message/{id}/message_list

    请求参数

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

    返回参数

    参数 类型 允许为空 描述
    code int 否 状态码
    msg String 是 描述文字
    data JSON 是 留言消息
    参数 类型 允许为空 描述
    message_id String 否 消息ID
    message_content String 否 消息内容
    member_id String 否 成员ID
    activity_id String 否 活动ID
    message_type String 否 消息类型
    message_status String 否 消息状态
    message_create_time int 否 消息创建时间

    message_status含义:

    unsolved:未屏蔽状态(等待审核）
ban:屏蔽状态
finish:完成发送

    Sample

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

    Return:

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

    获取未审核留言消息（可分页，也可不分页）

    API

    [GET] /activitys_message/{id}/message_list/unsolved

    请求参数和返回参数同【获取留言消息】接口

    获取已通过留言消息（可分页，也可不分页）

    API

    [GET] /activitys_message/{id}/message_list/pass

    请求参数和返回参数同【获取留言消息】接口

    获取已通过但未标星的留言消息（可分页，也可不分页）

    API

    [GET] /activitys_message/{id}/message_list/pass_without_star

    请求参数和返回参数同【获取留言消息】接口

    获取已拒绝留言消息（可分页，也可不分页）

    API

    [GET] /activitys_message/{id}/message_list/ban

    请求参数和返回参数同【获取留言消息】接口

    获取已标星留言消息（可分页，也可不分页）

    API

    [GET] /activitys_message/{id}/message_list/star

    请求参数和返回参数同【获取留言消息】接口

    获取参与成员名单（可分页，也可不分页）

    API

    [GET] /activitys_message/{id}/member_list

    请求参数

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

    返回参数

    参数 类型 允许为空 描述
    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_message/1/member_list?access_token=xxx&access_type=org&page_size=10$page_index=1

    Return:

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

    导出审核通过消息(不包含标星的）

    API

    [GET]
    /activitys_message/{id}/message_list_pass_export

    请求参数

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

    返回

    excel表messagelist.xlsx

    导出标星消息

    API

    [GET]
    /activitys_message/{id}/message_list_star_export

    请求参数

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

    返回

    excel表messagelist.xlsx

    导出签到成员名单

    API

    [GET]
    /activitys_message/{id}/member_list_export

    请求参数

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

    返回

    excel表memberlist.xlsx

    禁言

    API

    [PUT] /activitys_message/{id}/member/{member_id}/ban_message_permission

    请求参数

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

    返回参数

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

    解除禁言

    API

    [PUT] /activitys_message/{id}/member/{member_id}/allow_message_permission

    请求参数

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

    返回参数

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

    屏蔽留言

    API

    [PUT] /activitys_message/{id}/message/{message_id}/reject_message

    请求参数

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

    返回参数

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

    通过留言

    API

    [PUT] /activitys_message/{id}/message/{message_id}/pass_message

    请求参数

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

    返回参数

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

    撤销留言

    API

    [PUT] /activitys_message/{id}/message/{message_id}/revoke_message

    请求参数

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

    返回参数

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

    给消息标星

    API

    [PUT] /activitys_message/{id}/message/{message_id}/star_message

    请求参数

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

    返回参数

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

    取消消息标星

    API

    [PUT] /activitys_message/{id}/message/{message_id}/unstar_message

    请求参数

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

    返回参数

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

    切换审核方式

    API

    [PUT] /activitys_message/{id}/message_check_way

    请求参数

    参数 类型 允许为空 描述
    access_token String 否 访问凭证
    access_type String 否 凭证类型
    check_way String 否 消息审核方式,'machine':机器审核，'human':人工审核

    返回参数

    参数 类型 允许为空 描述
    code int 否 状态码
    msg String 是 描述文字
    data String 是 审核方式,'machine':机器审核，'human':人工审核

    查询审核方式

    API

    [GET] /activitys_message/{id}/message_check_way

    请求参数

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

    返回参数

    参数 类型 允许为空 描述
    code int 否 状态码
    msg String 是 描述文字
    data String 是 审核方式,'machine':机器审核，'human':人工审核

    管理后台注册活动socket

    客户端->服务端

    ACTION ：

    bs_register_activity

    参数

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

    微信端发送留言消息

    客户端->服务端

    ACTION ：

    message

    请求参数

    参数 类型 允许为空 描述
    access_token String 否 访问凭证
    access_type String 否 凭证类型,此处传值user
    send_time String 否 发送时间
    activity_id String 否 活动ID
    member_id String 否 成员ID
    message_content String 否 消息内容

    推送留言消息状态到留言页面

    服务端->客户端

    ACTION ：

    message_update

    参数

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

    data:

    参数 类型 允许为空 描述
    send_time String 否 发送时间
    message_status String 否 消息状态，'unsolved' 、 'finish' 、 'ban' 分别对应 =>正在发送 、完成发送 、 被屏蔽

    example Data:

    {
    "send_time"xxx
     "message_status": "unsolved"  
}

    推送留言消息到管理后台

    服务端->客户端

    ACTION ：

    message

    参数

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

    data:

    参数 类型 允许为空 描述
    send_time String 否 发送时间
    activity_id String 否 活动ID
    member_id String 否 成员ID
    member_icon String 否 头像链接
    member_nickname String 否 昵称
    message_id String 否 消息ID
    message_content String 否 消息内容
    message_status String 否 消息状态，'unsolved' 、 'finish' 、 'ban' 分别对应 =>正在发送 、完成发送 、 被屏蔽

    example Data:

    {
    "send_time"xxx
    "activity_id":xxx
     "member_id":xxx
     "message_id":xxxx
     "member_icon" : xxxx
     "member_nickname":xxx
     "message_content":xxxx
     "message_status": "unsolved"  
}

    推送留言消息状态更新到管理后台

    服务端->客户端

    ACTION ：

    message_update

    参数

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

    data:

    参数 类型 允许为空 描述
    message_id String 否 消息id
    send_time String 否 发送时间
    message_status String 否 消息状态， 'finish' 、 'ban' 分别对应 =>完成发送 、 被屏蔽

    example Data:

    {
    "message_id":'xxx',
    "send_time"xxx,
     "message_status": "finish"  
}

    获取用户的历史留言消息

    API

    [GET] /activitys_message/{id}/wx/member/{member_id}/message

    请求参数

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

    返回参数

    参数 类型 允许为空 描述
    code int 否 状态码
    msg String 是 描述文字
    data JSON 否 历史留言信息
    参数 类型 允许为空 描述
    member_id String 否 签到成员ID
    member_icon String 否 成员头像
    member_nickname String 否 成员昵称
    member_message String 否 留言消息
    member_status String 否 成员状态

    Data 数据项：

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

    member_status含义:

    unsolved:未屏蔽状态
ban:屏蔽状态
finish:完成发送

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

    活动页面注册活动

    客户端->服务端

    ACTION ：

    register

    请求参数

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

    返回参数

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

    添加留言到大屏活动页

    服务端->客户端

    ACTION

    message

    参数

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

    data:

    参数 类型 允许为空 描述
    send_time String 否 发送时间
    activity_id String 否 活动ID
    member_id String 否 成员ID
    member_icon String 否 头像链接
    member_nickname String 否 昵称
    message_id String 否 消息ID
    message_content String 否 消息内容
    message_status String 否 消息状态, 'finish' 、 'star' 分别对应 =>普通审核消息 、 标星消息

    example Data:

    {
    "send_time"xxx
    "activity_id":xxx
     "member_id":xxx
     "message_id":xxxx
     "member_icon" : xxxx
     "member_nickname":xxx
     "message_content":xxxx
     "message_status": "finish"  
}

    从大屏活动页撤销留言

    服务端->客户端

    ACTION

    message_revoke

    参数

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

    修改大屏活动页留言消息状态（标星与非标星消息切换）

    服务端->客户端

    ACTION

    message_update

    参数

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

    data:

    {
    "message_id":"消息ID",
    "message_update_time": "更新时间",
    "message_status": "消息状态,star:切换为标星消息，finish:切换为普通审核消息"
}

    相关文章

      网友评论

          本文标题：提问墙互动API

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

          延伸阅读

          深度阅读

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

          栏目导航

          热点阅读

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

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

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

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

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

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