• 由 未知用户 (guozhaoxiang)创建, 最后修改于7月 12, 2022

正在查看旧版本。 查看 当前版本.

与当前比较 查看页面历史记录

« 前一个 版本 19 下一个 »

背景说明：

兔展支持通过api接口实现作品的管理；

功能详情：

使用说明：通过该接口可以获取当前账号下的作品信息，支持租户模式下跨企业查询

兔展作品列表：

接口协议：HTTPS

HTTP请求方式：GET

请求参数

参数
必选
类型
说明
companyId
false
string
第三方平台的企业id，如果没有则不必传，有则传，其他接口必须保持一致

uid
true
string
第三方平台的用户id
queryTypefalseinteger查询类型 1:查询企业所有的; 0:查询当前用户有数据权限的；默认0 如果查询企业所有的，则当前用户必须是超管角色。非超管角色返回空
keyword
false
string
作品名称
pageNo
false
integer
页码，从1开始的正整数
pageSize
false
integer
每页数量，从1开始的正整数

返回参数

参数类型说明
idstring作品id
namestring作品名称
imgurlstring作品图片地址
appurlstring作品地址（当作品存在 助力、组队、拼团的玩法时需要配置自定义域名，否则不展示appurl）

orgDomain

string作品自定义域名，有则返回，无则不返回
formcountinteger表单数据
statestring作品状态 1:正常；2:封禁；3:白名单；4:可疑，危险的作品
descstring作品描述
appTItlestring作品标题
appTypestring作品类型，1：玩法作品；2：H5作品；3：视频作品
appVersionstring作品版本
createTImelong创建时间
updateTimelong修改时间


使用说明：通过该接口可以根据当前uid账号下的作品id，查询作品详情，支持租户模式下跨企业查询

兔展作品列表：

接口协议：HTTPS

HTTP请求方式：GET

请求参数

参数
必选
类型
说明
companyId
false
string
第三方平台的企业id，如果没有则不必传，有则传，其他接口必须保持一致
uid
true
string
第三方平台的用户id
ids
true
string
兔展作品id,多个以‘,’分隔

返回参数

参数类型说明
idstring作品id。规则uuid，长度64个字符
namestring作品名称
imgurlstring作品图片地址
appurlstring作品地址（当作品存在 助力、组队、拼团的玩法时需要配置自定义域名，否则不展示appurl）

orgDomain

string作品自定义域名，有则返回，无则不返回。（配置了自定义域名，则appurl字段值==orgDomain字段值）
formcountinteger表单数量
audienceCountinteger客户数量
statestring作品状态 1:正常；2:封禁；3:白名单；4:可疑的，危险的作品
appStatusString视频渲染状态：1:正常; 0:新建(未发布); 2:封禁; 3:白名单 4:可疑的、危险的作品 5:已审核 6:转移作品,可疑封禁 7:关闭作品 8:广告作品 9:鸡汤作品 101:转换中 102:转换完成 103:PPT转换失败 104:PPT转换超时 105:系统封禁 111:人工正常 112:机器封禁 212:未上线(腾讯云) 201:作品下线
descstring作品描述
appTItlestring作品标题
appTypeString作品类型: 1:兔展作品，2:长页作品
appVersionstring作品版本
createTImelong创建时间
updateTimelong修改时间
pluginInfoVosList<Object>玩法信息
└─componentIdString组件Id
└─componentNameString玩法名称。比如 抽奖
└─pluginNameString玩法名称。比如 Lottery
└─deletedinteger删除标识。 1-已删除，0-未删除
└─startTimeDate玩法开始时间
└─endTimeDate玩法结束时间


使用说明：通过该接口可以修改当前账号下的作品信息，比如作品名称、作品描述、作品封面。

兔展分享设置：

接口协议：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:显示
settingsfalsestring

高级功能设置，json格式字符串。

示例

{
    "workbench":{
        "wxAuthMode":"3"
    }
}

示例说明

enum AUTH_MODE {
  /** 明文授权 */
  SNSAPI_USERINFO = '0',
  /** 静默授权 */
  SNSAPI_BASE = '1',
  /** 先静默后明文授权 */
  SNSAPI_BOTH = '2',
  /** 强制明文授权 */
  FORCE_SNSAPI_USERINFO = '3',
}

返回参数

参数类型说明
codestring请求结果：200 成功，其他则为失败
errorCodestring请求结果信息：SUCCESS 成功，其他则为失败
msgstring操作返回信息
databoolean操作结果：true:成功


接口协议：HTTPS

HTTP请求方式：POST

请求参数

参数
必选
类型
说明
companyId
false
string
第三方平台的企业id，如果没有则不必传，有则传，其他接口必须保持一致
uid
true
string
第三方平台的用户id
appid
true
integer
作品id

返回参数


参数类型说明
codestring操作结果：200 成功，其他则为失败
errorCodestring操作结果信息：SUCCESS 成功，其他则为失败
msgstring操作返回信息

接口协议：HTTPS

HTTP请求方式：POST

请求参数

参数
必选
类型
说明
companyId
false
string
第三方平台的企业id，如果没有则不必传，有则传，其他接口必须保持一致
uid
true
string
第三方平台的用户id
true
string
兔展的作品id

返回参数示例

{

    "code": "200",

    "errorCode": "SUCCESS",

    "msg": "ok"

}

请求参数:

参数

类型

必选

说明

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

接口协议：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

数据


接口协议：HTTPS

HTTP请求方式：GET

请求参数

参数
必选
类型
说明
qrCodeId
false
long
二维码id，海报扫码场景值去除audienceScanPush部分

返回参数

参数类型说明
appIdstring作品id
orgIdstring企业id
audidlong生成海报的客户的客户档案id
cnllong渠道id

cnlType

string渠道类型

接口协议：HTTPS

HTTP请求方式：GET

请求参数

参数
必选
类型
说明
appid
true
string
兔展作品id

请求示例

换行和缩进只是为了更好的展示:

https://open.rabbitpre.com/api/app/getAppCover

返回参数


类型说明
string作品封面

接口协议：HTTPS

HTTP请求方式：GET

请求参数:

参数

类型

必选

说明

appId

string

true

作品id

uidstringtrue第三方用户ID
companyIdstringfalse第三方公司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问卷
  • 无标签