设置活动自定义菜单
简要描述:
- 设置活动自定义菜单
访问权限
账号类型 | 是否有权限 |
---|---|
主账号 | 是 |
子账号 | 是 |
接口URL:
http://api.zmengzhu.com/business/v1/navigation/set |
请求方式:
POST |
返回结果格式:
JSON |
参数:
参数名 | 是否必须 | 类型 | 默认值 | 说明 |
---|---|---|---|---|
ticket_id | 是 | int | 0 | 活动ID |
navigation | 是 | string | 自定义菜单内容 详细内容见 自定义菜单更新参数示例 |
返回示例:
响应成功JSON示例:
{
"code": 200,
"msg": "ok",
"data": {}
}
字段说明:
参数名 | 说明 |
---|---|
code | 成功为200 |
msg | 成功返回ok |
错误时返回:
{
"code": 20001,
"msg": "签名校验失败",
"data": {}
}
参数示例
接口请求参数 navigation 完整示例
[
{
"name":"互动",
"code":"chat",
"data":{"content":[]}
},
{
"name":"简介",
"code":"summary",
"data":{
"content":[],
"is_enter_channel":1
}
},
{
"name":"章节",
"code":"chapter",
"data":{"content":[]}},
{
"name":"问答",
"code":"answer",
"data":{"content":[]}
}
]
字段说明:
参数名 | 示例值 | 类型 | 说明 |
---|---|---|---|
name | 聊天 | string | 菜单名称 如 聊天、互动、简介(或自定义填写的名称) |
code | doc | string | 菜单代码标志,用来区分菜单功能 (功能代码见 菜单子参数代码标识) |
data | {'content':[]} | object | 菜单内容,不同功能菜单,内容格式不同 (详细见 菜单自参数内容示例) |
菜单子参数代码标识:
名称 | 功能说明 |
---|---|
chat | 聊天互动 |
summary | 简介 |
rich_text | 富文本 |
link | 链接 |
rank | 排行榜 |
component | 组件 |
doc | 文档 |
chapter | 章节 |
answer | 问答 |
菜单子参数内容:
菜单功能代码标志 | 内容示例 | 说明 |
---|---|---|
chat | {"content":[]} | 聊天功能系统默认, content内容为空 |
summary | {"content":[],"is_enter_channel":1} | 简介功能系统默认, content内容为空,使用互动的简介内容,is_enter_channel参数控制H5页面是否展示进入频道的入口,0:关闭入口 1:展示入口 |
rich_text | {"content":[" 第一行内容 第二行内容 "]} |
富文本菜单,content数组内容首个元素为 文本内容 |
link | {"content":["https://www.xx.com"]} | 自定义链接菜单 content数组首个元素 为链接地址 |
rank | {"content":["reward","invite","share"]} | 排行榜菜单,控制H5页面展示排行榜单 reward:打赏榜,invite:邀约榜,share:分享榜 |
component | {"content":["webinar","external-link","invite-data"]} | 系统组件功能 webinar:展示活动, external-link:展示外链, invite-data:展示我的频道数据 |
doc | {"content":[]} | 文档菜单, content内容为空,H5页面展示活动关联文档内容 |
chapter | {"content":[]} | 章节菜单, content内容为空, H5页面展示活动设置的章节内容 |
answer | {"content":[]} | 问答菜单, content内容为空, H5页面展示活动设置的问答内容 |