...
兔展支持通过api接口实现作品的管理;
功能详情:
1、获取作品列表
使用说明:通过该接口可以获取当前账号下的作品信息,支持租户模式下跨企业查询接口地址:获取作品列表
兔展作品列表:功能说明:通过该接口可以获取作品详情,包括作品相关信息。
接口协议:HTTPS
HTTP请求方式:GET
请求参数
...
参数
...
必选
...
类型
...
说明
companyId
false
string
第三方平台的企业id,如果没有则不必传,有则传,其他接口必须保持一致
uid
true
string
第三方平台的用户id
queryType
false
integer
查询类型 1:查询企业所有的; 0:查询当前用户有数据权限的;默认0 如果查询企业所有的,则当前用户必须是超管角色。非超管角色返回空
keyword
false
string
作品名称
pageNo
false
integer
页码,从1开始的正整数
pageSize
false
integer
每页数量,从1开始的正整数
返回参数
参数
类型
说明
id
string
作品id
name
string
作品名称
imgurl
string
作品图片地址
appurl
string
作品地址(当作品存在 助力、组队、拼团的玩法时需要配置自定义域名,否则不展示appurl)
orgDomain
string
作品自定义域名,有则返回,无则不返回
formcount
integer
表单数据
state
string
作品状态 1:正常;2:封禁;3:白名单;4:可疑,危险的作品
desc
string
作品描述
appTItle
string
作品标题
appType
string
作品类型,1:玩法作品;2:H5作品;3:视频作品
appVersion
string
作品版本
createTIme
long
创建时间
updateTime
long
修改时间
2、根据作品ids获取作品信息
使用说明:通过该接口可以根据当前uid账号下的作品id,查询作品详情,支持租户模式下跨企业查询
接口协议:HTTPS
HTTP请求方式:GET
请求参数
参数
必选
类型
说明
companyId
false
string
第三方平台的企业id,如果没有则不必传,有则传,其他接口必须保持一致
uid
true
string
第三方平台的用户id
ids
true
string
兔展作品id,多个以‘,’分隔
返回参数
参数
类型
说明
id
string
作品id。规则uuid,长度64个字符
name
string
作品名称
imgurl
string
作品图片地址
appurl
string
作品地址(当作品存在 助力、组队、拼团的玩法时需要配置自定义域名,否则不展示appurl)
orgDomain
string
作品自定义域名,有则返回,无则不返回。(配置了自定义域名,则appurl字段值==orgDomain字段值)
formcount
integer
表单数量
audienceCount
integer
客户数量
state
string
作品状态 1:正常;2:封禁;3:白名单;4:可疑的,危险的作品
appStatus
String
视频渲染状态:1:正常; 0:新建(未发布); 2:封禁; 3:白名单 4:可疑的、危险的作品 5:已审核 6:转移作品,可疑封禁 7:关闭作品 8:广告作品 9:鸡汤作品 101:转换中 102:转换完成 103:PPT转换失败 104:PPT转换超时 105:系统封禁 111:人工正常 112:机器封禁 212:未上线(腾讯云) 201:作品下线
2、根据作品ids获取作品信息
接口地址:根据作品ID获取作品信息和玩法信息
使用说明:通过该接口可以根据当前uid账号下的作品id,查询作品详情,支持租户模式下跨企业查询
3、作品分享设置
接口地址:根据作品ID获取作品信息和玩法信息
使用说明:通过该接口可以修改当前账号下的作品信息,比如作品名称、作品描述、作品封面。
4、删除作品
接口地址:删除作品
使用说明:通过该接口可以删除对应账户下的作品
5、作品封禁
接口地址:作品封禁
使用说明:通过该接口可以封禁对应账户下的作品,用户不可再进入已封禁的作品,如需解封,请联系兔展运营人员。
6、复制作品
接口地址:复制作品
使用说明:通过该接口可以复制对应账户下的作品
7、作品上下线
接口地址:作品上下线
使用说明:通过该接口可以操作对应账户下的作品的发布和下线
8、获取作品海报二维码信息
接口地址:获取作品海报二维码信息
使用说明:通过该接口可以获取对应账户下的作品的海报二维码的信息
9、获取作品封面
接口地址:获取作品封面
使用说明:通过该接口可以获取对应账户下的作品封面
10、获取作品的玩法
接口地址:获取作品的玩法
desc
string
作品描述
appTItle
string
作品标题
appType
String
作品类型: 1:兔展作品,2:长页作品
appVersion
string
作品版本
createTIme
long
创建时间
updateTime
long
修改时间
pluginInfoVos
List<Object>
玩法信息
└─componentId
String
组件Id
└─componentName
String
玩法名称。比如 抽奖
└─pluginName
String
玩法名称。比如 Lottery
└─deleted
integer
删除标识。 1-已删除,0-未删除
└─startTime
Date
玩法开始时间
└─endTime
Date
玩法结束时间
3、作品分享设置
使用说明:通过该接口可以修改当前账号下的作品信息,比如作品名称、作品描述、作品封面。
兔展分享设置:
接口协议:HTTPS
HTTP请求方式:POST
请求参数
参数
必选
类型
说明
companyId
false
string
第三方平台的企业id,如果没有则不必传,有则传,其他接口必须保持一致
uid
true
string
第三方平台的用户id
appid
true
string
作品id
shareTitle
true
string
分享标题
shareDesc
true
string
分享描述
shareImg
true
string
分享图片url
showViewFlag
true
integer
是否显示阅读数,0:不显示;1:显示
settings
false
string
高级功能设置,json格式字符串。
示例
{
"workbench":{
"wxAuthMode":"3"
}
}
示例说明
enum AUTH_MODE {
/** 明文授权 */
SNSAPI_USERINFO = '0',
/** 静默授权 */
SNSAPI_BASE = '1',
/** 先静默后明文授权 */
SNSAPI_BOTH = '2',
/** 强制明文授权 */
FORCE_SNSAPI_USERINFO = '3',
}
返回参数
参数
类型
说明
code
string
请求结果:200 成功,其他则为失败
errorCode
string
请求结果信息:SUCCESS 成功,其他则为失败
msg
string
操作返回信息
data
boolean
操作结果:true:成功
4、删除作品
接口协议:HTTPS
HTTP请求方式:POST
请求参数
参数
必选
类型
说明
companyId
false
string
第三方平台的企业id,如果没有则不必传,有则传,其他接口必须保持一致
uid
true
string
第三方平台的用户id
appid
true
integer
作品id
返回参数
参数
类型
说明
code
string
操作结果:200 成功,其他则为失败
errorCode
string
操作结果信息:SUCCESS 成功,其他则为失败
msg
string
操作返回信息
5、作品封禁
接口协议:HTTPS
HTTP请求方式:POST
请求参数
参数
必选
类型
说明
companyId
false
string
第三方平台的企业id,如果没有则不必传,有则传,其他接口必须保持一致
uid
true
string
第三方平台的用户id
appid
true
string
兔展的作品id
返回参数示例
{
"code": "200",
"errorCode": "SUCCESS",
"msg": "ok"
}
6、复制作品
接口协议:HTTPS
HTTP请求方式:GET
请求参数:
参数
类型
必选
说明
opfid
string
true
开放平台ID
nonce
string
true
6位随机字串不能为空
timestamp
string
true
签名时间戳
signature
string
true
签名
uid
string
true
第三方平台的用户id
appid
string
true
作品id
返回参数:
参数
类型
说明
code
string
状态码
errorCode
string
错误状态码
msg
string
状态描述
data
object
数据
└─id
string
作品id
└─name
string
作品名
└─desc
string
作品说明
└─appUrl
string
作品短链全路径url
7、作品上下线
接口协议:HTTPS
HTTP请求方式:GET
请求参数:
参数
类型
必选
说明
opfid
string
true
开放平台ID
nonce
string
true
6位随机字串不能为空
timestamp
string
true
签名时间戳
signature
string
true
签名
appId
string
true
作品id
status
string
true
作品状态:1-上线 201-下线
uid
String
true
第三方平台的用户id
contentSource
String
true
内容来源:editor:编辑器制作
xapp:外部导入
gzharticle:公众号图文素材导入(公众号文章)
gzhimage:公众号图文素材导入
返回参数:
参数
类型
说明
code
string
状态码
errorCode
string
错误状态码
msg
string
状态描述
data
object
数据
8、获取作品海报二维码信息
接口协议:HTTPS
HTTP请求方式:GET
请求参数
参数
必选
类型
说明
qrCodeId
false
long
二维码id,海报扫码场景值去除audienceScanPush部分
返回参数
参数
类型
说明
appId
string
作品id
orgId
string
企业id
audid
long
生成海报的客户的客户档案id
cnl
long
渠道id
cnlType
string
渠道类型
9、获取作品封面
接口协议:HTTPS
HTTP请求方式:GET
请求参数
参数
必选
类型
说明
appid
true
string
兔展作品id
返回参数
类型
说明
string
作品封面
10、获取作品的玩法
接口协议:HTTPS
HTTP请求方式:GET
请求参数:
参数
类型
必选
说明
appId
string
true
作品id
uid
string
true
第三方用户ID
companyId
string
false
第三方公司ID,联合登录有传则该api必须传
返回参数:
参数
类型
说明
code
string
状态码
errorCode
string
错误状态码
msg
string
状态描述
data
array
数据
└─componentId
string
组件Id
└─componentName
string
组件名称
└─pluginName
string
玩法名称。可选值,参考示例
└─deleted
int32
删除标志 0: 未删除 1:删除
玩法name(pluginName)
玩法title
Award
领奖
Help
助力
Lottery
抽奖
Task
任务
Signin
签到
Team
组队
Vote
投票
Reserve
预约
Answer
答题
Game
游戏
Points
积分
Question
...
使用说明:通过该接口可以获取对应账户下的作品玩法