API Description
This API is used to add content on the pages that are pushed to users via the Shake feature, including the titles, subtitles, images and redirect URLs on the pages. The image URLs must the ones returned after the images are uploaded to the Weixin server using the Media Asset Management API.
API Request Format
http request method: POST (use https protocol) https://api.weixin.qq.com/shakearound/page/add?access_token=ACCESS_TOKENPOST data format: JSON
POST data example:
{
"title":"title",
"description":"subtitle",
"page_url":" https://zb.weixin.qq.com ",
"comment":"data example",
"icon_url":"http://3gimg.qq.com/shake_nearby/dy/icon "
}
Parameters
Parameter | Required | Description |
---|---|---|
access_token | Yes | The credential for calling the API |
title | Yes | Title of the page pushed to users via the Shake feature. It has a maximum length of 6 Chinese characters (12 English characters). |
description | Yes | Subtitle of the page pushed to users via the Shake feature. It has a maximum length of 7 Chinese characters (14 English characters). |
icon_url | Yes | Image on the page. The image URL must be the one returned after the image is uploaded to the Weixin server using the "Media Asset Management - Upload Image" API. |
comment | No | Addition information on the page, with a maximum length of 15 Chinese characters (30 English characters). |
Response
Example of JSON packet returned for a successful request:
{
"data": {
"page_id": 28840
}
"errcode": 0,
"errmsg": "success."
}
Parameters
Parameter | Description |
---|---|
page_id | ID of the new page |