18 社区广告API

API列表

编号 API名称（后台）
23.1.1 广告新增
23.1.2 广告编辑
23.1.3 广告状态修改(审核、发布、终止调用该接口)
23.1.4 广告通过ID获取
23.1.5 广告列表
23.1.6 广告文件上传
23.1.7 广告删除
23.1.8 操作日志查看
23.1.9 广告导出
编号 API名称（app端）
23.2.1 APP端广告列表
23.2.2 修改广告浏览次数

23.1.1 广告新增

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：biz/mob/advt/add

方法：POST

请求参数

名称 位置 类型 必填 描述
title BODY STRING 是 广告标题
orderNo BODY String 是 广告排序 1一般 2中 3高
img BODY STRING 是 封面图
linkUrl BODY STRING 是 广告链接
cmtyAppSite BODY STRING 是 云朵社区发布位置 1首页顶部 2逛逛顶部
mngAppSite BODY STRING 是 云管家位置 1首页顶部 2设置顶部
isAllScope BODY Boolean 否 发布范围 true全部项目 false部分项目
appType BODY Integer 是 发布对象 1云朵 2云管家 3全部
pblStatus BODY Integer 否 发布状态 1立即发布 2定时发布 3暂不发布
pblTime BODY STRING 否 上线时间
offTime BODY STRING 否 下线时间
isAudit BODY bit 否 是否需要审核 true审核 false不审核
auditor BODY STRING 否 审核人
creator BODY string 否 创建人
organ BODY string 否 创建人所在组织机构
scopeList BODY Array 是 发布范围列表
communityId BODY Integer 否 发布范围-项目ID
regionId BODY Integer 否 发布范围-区域ID
name BODY string 否 发布范围-项目名称
navbar BODY boolean 是 是否有导航栏 false-无导航栏 true-有导航栏 
{
    "title":"冬天穿秋裤，走路风骚又炫酷",
    "orderNo":"1",
    "linkUrl":"http://www.123hao.com",
    "cmtyAppSite":"1",
    "mngAppSite":"1",
    "img":"http://mideazy-user.oss-cn-hangzhou.aliyuncs.com/news/inform/15715388925393B25D95A-E390-413E-8410-9DB565D4F06B.png",
    "isAllScope":"true",
    "pblStatus":1,
    "pblTime":"2019-10-26 00:00:00",
    "offTime":"2019-10-30 00:00:00",
    "isAudit":"true",
    "auditor":"xiaoming",
    "creator":"xiaoming",
    "navbar": false,
    "scopeList":[
           {
                "communityId": 610,
                "regionId": "121",
                "name": "美的君兰江山（北滘)"
            },
            {
                "communityId": 611,
                "regionId": "121",
                "name": "烽火小区"
            }
    ]
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功"
}

异常返回示例

{"code":400,"message":"新增异常"}

23.1.2 广告编辑

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：biz/mob/advt/edit

方法：POST

请求参数

名称 位置 类型 必填 描述
title BODY STRING 是 广告标题
orderNo BODY String 是 广告排序 1一般 2中 3高
img BODY STRING 是 封面图
linkUrl BODY STRING 是 广告链接
cmtyAppSite BODY STRING 是 云朵社区发布位置 1首页顶部 2逛逛顶部
mngAppSite BODY STRING 是 云管家位置 1首页顶部 2设置顶部
isAllScope BODY Boolean 否 发布范围 true全部项目 false部分项目
appType BODY Integer 是 发布对象 1云朵 2云管家 3全部
pblStatus BODY Integer 否 上线状态 发布状态 1立即发布 2定时发布 3暂不发布
pblTime BODY STRING 否 上线时间
offTime BODY STRING 否 下线时间
isAudit BODY bit 否 是否需要审核 true审核 false不审核
auditor BODY STRING 否 审核人
modifier BODY string 否 操作人
organ BODY string 否 操作人所在组织机构
scopeList BODY Array 是 发布范围列表
communityId BODY Integer 否 发布范围-项目ID
regionId BODY Integer 否 发布范围-区域ID
name BODY string 否 发布范围-项目名称
navbar BODY boolean 是 是否有导航栏 false-无导航栏 true-有导航栏 
{
    "advtId":2,
    "title":"冬天穿秋裤，走路风骚又炫酷",
    "orderNo":"1",
    "linkUrl":"http://www.123hao.com",
    "cmtyAppSite":"1",
    "mngAppSite":"1",
    "img":"http://mideazy-user.oss-cn-hangzhou.aliyuncs.com/news/inform/15715388925393B25D95A-E390-413E-8410-9DB565D4F06B.png",
    "isAllScope":"true",
    "pblStatus":1,
    "pblTime":"2019-10-26 00:00:00",
    "offTime":"2019-10-30 00:00:00",
    "isAudit":"true",
    "auditor":"xiaoming",
    "modifier":"xiaoming",
    "navbar": false,
    "scopeList":[
           {
                "communityId": 610,
                "regionId": "121",
                "name": "美的君兰江山（北滘)"
            },
            {
                "communityId": 611,
                "regionId": "121",
                "name": "烽火小区"
            }
    ]
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功"
}

异常返回示例

{"code":400,"message":"修改异常"}

23.1.3 广告状态修改(审核、发布、终止调用该接口)

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：biz/mob/advt/updateStatus

方法：POST

请求参数

名称 位置 类型 必填 描述
advtId BODY STRING 是 广告ID
status BODY Integer 否 广告状态：1发布 2待发布 3审核中 4终止 5审核通过 6审核驳回 7暂存
logRemark BODY string 否 审核备注 
{
    "advtId":1234,
    "status": "5",
    "logRemark":"完美通过"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码
message 顶层 STRING 是 响应信息

返回结果示例

{
  "code": 200,
  "message": "成功"
}

异常返回示例

{"code":400,"message":"修改异常"}

23.1.4 广告通过ID获取

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：biz/mob/advt/getById

方法：POST

请求参数

名称 位置 类型 必填 描述
advtId BODY STRING 是 广告ID 
{
   "advtId" : 5
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 OBJECT 是 返回数据实体
advtId BODY STRING 是 广告ID
title BODY STRING 是 广告标题
orderNo BODY String 是 广告排序 1一般 2中 3高
img BODY STRING 是 封面图
linkUrl BODY STRING 是 广告链接
cmtyAppSite BODY STRING 是 云朵社区发布位置 1首页顶部 2逛逛顶部
mngAppSite BODY STRING 是 云管家位置 1首页顶部 2设置顶部
isAllScope BODY Boolean 否 发布范围 true全部项目 false部分项目
appType BODY Integer 是 发布对象 1云朵 2云管家 3全部
pblStatus BODY Integer 否 上线状态 发布状态 1立即发布 2定时发布 3暂不发布
pblTime BODY STRING 否 上线时间
offTime BODY STRING 否 下线时间
isAudit BODY bit 否 是否需要审核 true审核 false不审核
auditor BODY STRING 否 审核人
creator BODY string 否 创建人
scopeList BODY Array 是 发布范围列表
communityId BODY Integer 否 发布范围-项目ID
regionId BODY Integer 否 发布范围-区域ID
name BODY string 否 发布范围-项目名称

返回结果示例

{
    "code": 200,
    "data": {
        "advtId": 5,
        "auditor": "xiaoming",
        "cmtyAppSite": "1",
        "createTime": 1571991432000,
        "creator": "xiaoming",
        "img": "http://mideazy-user.oss-cn-hangzhou.aliyuncs.com/news/inform/15715388925393B25D95A-E390-413E-8410-9DB565D4F06B.png",
        "isAllScope": false,
        "isAudit": true,
        "linkUrl": "http://www.123hao.com",
        "mngAppSite": "1",
        "modifier": "",
        "modifyTime": null,
        "offTime": "2019-10-30 00:00:00",
        "orderNo": "1",
        "pblStatus": 1,
        "pblTime": "2019-10-26 00:00:00",
        "scopeList": [
            {
                "advtId": 5,
                "communityId": 610,
                "name": "美的君兰江山（北滘)",
                "regionId": 121,
                "scopeId": 1
            },
            {
                "advtId": 5,
                "communityId": 611,
                "name": "烽火小区",
                "regionId": 121,
                "scopeId": 2
            }
        ],
        "status": 0,
        "title": "再来一次，冬天穿秋裤，走路风骚又炫酷",
        "viewCount": 0
    },
    "message": "success"
}

异常返回示例

{"code":400,"message":"查询异常"}

23.1.5 获广告题列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：biz/mob/advt/listByPage/1/20

方法：POST

请求参数

名称 位置 类型 必填 描述
title BODY STRING 否 广告搜索
communityId BODY LONG 否 项目名称
status BODY Integer 否 广告状态
appType BODY Integer 否 发布对象 1云朵社区 2云管家
orderBy BODY LIST 否 排序
field BODY STRING 否 字段名 （orderNo：优先级/pblTime：上线时间）
order BODY Integer 否 0：正序 1：倒叙
cmtyAppSite BODY Integer 否 云朵社区APP位置 1首页顶部 2逛逛顶部
mngAppSite BODY Integer 否 云管家位置 1首页顶部 2设置顶部 
{
    "title" : "小弟弟",
    "communityId":123,
    "status":1,
    "appType":3,
    "orderBy":{
        "field":"orderNo",
        "order":1
    }
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
advtId BODY STRING 是 广告ID
title BODY STRING 是 广告标题
status BODY STRING 是 状态 1发布 2待发布 3审核中 4终止 5审核通过 6审核驳回 7暂存
orderNo BODY String 是 广告排序 1一般 2中 3高
cmtyAppSite BODY STRING 是 云朵社区发布位置 1首页顶部 2逛逛顶部
mngAppSite BODY STRING 是 云管家位置 1首页顶部 2设置顶部
viewCount BODY Integer 是 浏览数
appType BODY Integer 是 发布对象 1云朵 2云管家 3全部
scopeNames BODY Boolean 是 发布范围 true全部 false部分
pblTime BODY Integer 是 上线时间
offTime BODY Integer 是 下线时间
current 顶层 INTEGER 是 当前页数
total 顶层 INTEGER 是 数据条数
pages 顶层 INTEGER 是 总页数
size 顶层 INTEGER 是 每页数量

返回结果示例

{
    "code": 200,
    "data": {
        "current": 1,
        "orders": [],
        "pages": 1,
        "records": [
            {
                "advtId": 5,
                "appSite": "11",
                "appType": 0,
                "auditor": "",
                "cmtyAppSite": "",
                "createTime": null,
                "creator": "",
                "img": "",
                "isAllScope": false,
                "isAudit": false,
                "linkUrl": "",
                "mngAppSite": "",
                "modifier": "",
                "modifyTime": null,
                "offTime": "2019-10-30 00:00:00",
                "orderNo": "1",
                "pblStatus": 1,
                "pblTime": "2019-10-26 00:00:00",
                "scopeList": [],
                "scopeNames": "美的君兰江山（北滘),烽火小区",
                "status": 0,
                "title": "再来一次，冬天穿秋裤，走路风骚又炫酷",
                "viewCount": 0
            },
            {
                "advtId": 4,
                "appSite": "11",
                "appType": 0,
                "auditor": "",
                "cmtyAppSite": "",
                "createTime": null,
                "creator": "",
                "img": "",
                "isAllScope": false,
                "isAudit": false,
                "linkUrl": "",
                "mngAppSite": "",
                "modifier": "",
                "modifyTime": null,
                "offTime": "2019-10-30 00:00:00",
                "orderNo": "1",
                "pblStatus": 0,
                "pblTime": "2019-10-26 00:00:00",
                "scopeList": [],
                "scopeNames": "全部",
                "status": 0,
                "title": "再来一次，冬天穿秋裤，走路风骚又炫酷",
                "viewCount": 0
            }
        ],
        "searchCount": true,
        "size": 20,
        "total": 4
    },
    "message": "success"
}

异常返回示例

{"code":400,"message":"查询异常"}

23.1.6 话题图片上传

描述

话题图片上传-只限于图片

请求信息

HTTP协议：HTTP,HTTPS

uri：biz/mob/advt/fileUpload

方法：POST

请求参数

名称 位置 类型 必填 描述
file BODY STRING 否 文件对象

请求Body描述(非Form表单数据)

{ 
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code BODY STRING 是 操作状态码
message BODY STRING 是 返回消息
data BODY STRING 是 返回数据实体
fileUrl BODY STRING 是 上传图片URL

返回结果示例

 {
    "code": 200,
    "data": {
        "fileUrl": "http://mideazy-user.oss-cn-hangzhou.aliyuncs.com/news/inform/1567674054360dog.png"
    },
    "message": "success"
}

23.1.7 广告删除

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：biz/mob/advt/delete

方法：POST

请求参数

名称 位置 类型 必填 描述
advtId BODY Integer 是 广告ID

请求Body描述(非Form表单数据)

{
  "advtId":2
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本

返回结果示例

{
  "code": "200",
  "message": "success"
}

异常返回示例

{"code":"400","message":"操作异常"}

23.1.8 操作日志查看

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：biz/mob/advt/listLog

方法：post

请求参数

名称 位置 类型 必填 描述
advtId BODY Integer 是 广告ID

请求Body描述(非Form表单数据)

{
  "advtId":12
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code BODY STRING 是 操作状态码
message BODY STRING 是 返回消息
data BODY STRING 是 返回数据
logId BODY integer 是 日志ID
advtId BODY integer 是 广告ID
organ BODY STRING 是 操作员部门
modifier BODY STRING 是 操作员
operate BODY STRING 是 操作
logTime BODY DATE 是 日期
remark BODY STRING 是 备注

返回结果示例

{
    "code": 200,
    "data": [
        {
            "logId": 31,
            "advtId": 3,
            "organ": "创新园120",
            "modifier": "zhangVVV",
            "operate": "创建",
            "logTime": "2019-09-11T01:07:25.000+0000",
            "remark": null
        },
        {
            "logId": 32,
            "advtId": 3,
            "organ": "创新园120",
            "modifier": "zhangVVV",
            "operate": "发布",
            "logTime": "2019-09-11T01:07:25.000+0000",
            "remark": null
        },
        {
            "logId": 33,
            "advtId": 3,
            "organ": "创新园120",
            "modifier": null,
            "operate": "修改",
            "logTime": "2019-09-11T02:13:34.000+0000",
            "remark": null
        }
    ],
    "message": "success"
}

异常返回示例

{"code":"400","message":"操作异常"}

23.1.9: 导出评价记录

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/biz/mob/report/csv/exportAdvtList

方法：POST

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)

返回信息

返回参数类型

返回参数

返回结果示例

导出

异常返回示例

{"code":400,"message":"暂无信息","data":{}}

23.2.1 APP端广告列表（展现6条）

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：biz/mob/advt/app/listAdvt

方法：POST

请求参数

名称 位置 类型 必填 描述
communityId BODY LONG 是 项目
cmtyAppSite BODY LONG 是 广告位置（云朵APP使用） 1首页顶部 2逛逛顶部
mngAppSite BODY LONG 是 广告位置（云管家APP使用）1首页顶部 2设置顶部 
{
   "communityId":123,
   "cmtyAppSite":1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
advtId BODY STRING 是 广告ID
title BODY STRING 是 广告标题
img BODY STRING 是 封面
linkUrl BODY STRING 是 广告链接
navbar BODY boolean 是 是否有导航栏 false-无导航栏 true-有导航栏

返回结果示例

{
    "code": 200,
    "data": [
        {
            "advtId": 3,
            "appType": 0,
            "auditor": "",
            "cmtyAppSite": "",
            "createTime": null,
            "creator": "",
            "img": "http://mideazy-user.oss-cn-hangzhou.aliyuncs.com/news/inform/15715388925393B25D95A-E390-413E-8410-9DB565D4F06B.png",
            "isAllScope": false,
            "isAudit": false,
            "linkUrl": "http://www.123hao.com",
            "mngAppSite": "",
            "modifier": "",
            "modifyTime": null,
            "offTime": "",
            "orderNo": "",
            "pblStatus": 0,
            "pblTime": "",
            "scopeList": [],
            "scopeNames": "",
            "status": 0,
            "title": "再来一次，冬天穿秋裤，走路风骚又炫酷",
            "viewCount": 0,
            "navbar": false
        }
    ],
    "message": "success"
}

23.2.2 广告查看

描述

点开进入广告详情调用

请求信息

HTTP协议：HTTP,HTTPS

uri：biz/mob/advt/app/remarkView

方法：POST

请求参数

名称 位置 类型 必填 描述
advtId BODY Integer 是 广告ID

请求Body描述(非Form表单数据)

{"advtId": 123}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本

返回结果示例

{
  "code": "200",
  "message": "success"
}

异常返回示例

{"code":"400","message":"操作异常"}

results matching ""

    No results matching ""