微信小店
微信门店
微信智能接口
微信设备功能

页面管理

出自微信公众平台开发者文档
跳转到: 导航, 搜索

目录

新增页面

新增摇一摇出来的页面信息,包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。其中,图片必须为用素材管理接口上传至微信侧服务器后返回的链接。

接口调用说明

http请求方式: POST(请使用https协议)
https://api.weixin.qq.com/shakearound/page/add?access_token=ACCESS_TOKEN
POST数据格式:json
POST数据例子:
{
   "title":"主标题",   
   "description":"副标题",	
   "page_url":" https://zb.weixin.qq.com ",	
   "comment":"数据示例",
   "icon_url":"http://3gimg.qq.com/shake_nearby/dy/icon "
}

参数说明

参数 是否必须 说明
access_token 调用接口凭证
title 在摇一摇页面展示的主标题,不超过6个汉字或12个英文字母
description 在摇一摇页面展示的副标题,不超过7个汉字或14个英文字母
icon_url 在摇一摇页面展示的图片。图片需先上传至微信侧服务器,用“素材管理-上传图片素材”接口上传图片,返回的图片URL再配置在此处
comment 页面的备注信息,不超过15个汉字或30个英文字母

返回说明 正常时的返回JSON数据包示例:

{
    "data": {
        "page_id": 28840
    }
    "errcode": 0,
    "errmsg": "success."
}

参数说明

参数 说明
page_id 新增页面的页面id

编辑页面信息

编辑摇一摇出来的页面信息,包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。

接口调用说明

http请求方式: POST(请使用https协议)
https://api.weixin.qq.com/shakearound/page/update?access_token=ACCESS_TOKEN
POST数据格式:json
POST数据例子:
{
 "page_id":12306
 "title":"主标题",   
 "description":"副标题",	
 "page_url":" https://zb.weixin.qq.com ",	
 "comment":"数据示例",
 "icon_url":" http://3gimg.qq.com/shake_nearby/dy/icon"
}

参数说明

参数 是否必须 说明
access_token 调用接口凭证
page_id 摇周边页面唯一ID
title 在摇一摇页面展示的主标题,不超过6个汉字或12个英文字母
description 在摇一摇页面展示的副标题,不超过7个汉字或14个英文字母
icon_url 在摇一摇页面展示的图片。图片需先上传至微信侧服务器,用“素材管理-上传图片素材”接口上传图片,返回的图片URL再配置在此处
page_url 跳转链接
comment 页面的备注信息,不超过15个汉字或30个英文字母

返回说明 正常时的返回JSON数据包示例:

{
    "data": {
        
    },
    "errcode": 0,
    "errmsg": "success."
}

查询页面列表

查询已有的页面,包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。提供两种查询方式,可指定页面ID查询,也可批量拉取页面列表。

接口调用请求说明

http请求方式: POST(请使用https协议)
https://api.weixin.qq.com/shakearound/page/search?access_token=ACCESS_TOKEN
POST数据格式:json
POST数据例子:
需要查询指定页面时:
{
    "type": 1,
    "page_ids":[12345, 23456, 34567]
}

需要分页查询或者指定范围内的页面时:
{
    "type": 2,
    "begin": 0,		
    "count": 3
}

参数说明

参数 是否必须 说明
access_token 调用接口凭证
type 查询类型。1: 查询页面id列表中的页面信息;2:分页查询所有页面信息
page_ids 指定页面的id列表;当type为1时,此项为必填
begin 页面列表的起始索引值;当type为2时,此项为必填
count 待查询的页面数量,不能超过50个;当type为2时,此项为必填

返回说明 正常时的返回JSON数据包示例:

{
    "data": {
        "pages": [
            {
                "comment": "just for test",
                "description": "test",
                "icon_url": "https://www.baidu.com/img/bd_logo1",
                "page_id": 28840,
                "page_url": "http://xw.qq.com/testapi1",
                "title": "测试1"
            },
            {
                "comment": "just for test",
                "description": "test",
                "icon_url": "https://www.baidu.com/img/bd_logo1",
                "page_id": 28842,
                "page_url": "http://xw.qq.com/testapi2",
                "title": "测试2"
            }
        ],
        "total_count": 2
    },
    "errcode": 0,
    "errmsg": "success."
}

参数说明

参数 说明
total_count 商户名下的页面总数
page_id 摇周边页面唯一ID
title 在摇一摇页面展示的主标题,
description 在摇一摇页面展示的副标题
icon_url 在摇一摇页面展示的图片
page_url 跳转链接
comment 页面的备注信息

删除页面

删除已有的页面,包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。只有页面与设备没有关联关系时,才可被删除。

接口调用请求说明

http请求方式: POST(请使用https协议)
https://api.weixin.qq.com/shakearound/page/delete?access_token=ACCESS_TOKEN
POST数据格式:json
POST数据例子:
{
    "page_id":34567
}

参数说明

参数 是否必须 说明
page_id 指定页面的id

返回说明 正常时的返回JSON数据包示例:

{
    "data": {
        
    },
    "errcode": 0,
    "errmsg": "success."
}