微信小程序开发文档 第44页
uniformMessage.send 本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载) wx-server-sdk >= 0.4.0 下发小程序和公众号统一的服务消息 调用方式: HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/cgi-bin/message/wxopen/template/uniform_send?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 touser string 是 用户openid,可以是小程序的openid,也可以是mp_template_msg.appid对应的公众号的openid weapp_template_msg Object 否 小程序模板消息相关的信息,可以参考小程序模板消息接口; 有此节点则优先发送小程序模板消息 mp_template_msg Object 是 公众号模板消息相关的信息,可以参考公众号模板消息接口;有此节点并且没有weapp_template_msg节点时,发送公众号模板消息 weapp_template_msg 的结构 属性 类型 默认值 必填 说明 template_id string 是 小程序模板ID page string 是 小程序页面路径 form_id string 是 小程序模板消息formid data string 是 小程序模板数据 emphasis_keyword string 是 小程序模板放大关键词 mp_template_msg 的结构 属性 类型 默认值 必填 说明 appid string 是 公众号appid,要求与小程序有绑定且同主体 template_id string 是 公众号模板id url string 是 公众号模板消息所要跳转的url miniprogram string 是 公众号模板消息所要跳转的小程序,小程序的必须与公众号具有绑定关系 data string 是 公众号模板消息的数据 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode number 错误码 errmsg string 错误信息 错误 错误码 错误信息 说明 40037 模板id不正确,weapp_template_msg.template_id或者mp_template_msg.template_id 41028 weapp_template_msg.form_id过期或者不正确 41029 weapp_template_msg.form_id已被使用 41030 weapp_template_msg.page不正确 45009 接口调用超过限额...
customerServiceMessage.uploadTempMedia 本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载) wx-server-sdk >= 0.4.0 把媒体文件上传到微信服务器。目前仅支持图片。用于发送客服消息或被动回复用户消息。 调用方式: HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/cgi-bin/media/upload?access_token=ACCESS_TOKEN&type=TYPE 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 type string 是 文件类型 media FormData 是 form-data 中媒体文件标识,有filename、filelength、content-type等信息 type 的合法值 值 说明 最低版本 image 图片 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode number 错误码 errmsg string 错误信息 type string 文件类型 media_id string 媒体文件上传后,获取标识,3天内有效。 created_at number 媒体文件上传时间戳 errcode 的合法值 值 说明 最低版本 40004 无效媒体文件类型 type 的合法值 值 说明 最低版本 image 图片 调用示例 使用 CURL 命令,用 FORM 表单方式上传一个多媒体文件 curl -F media=@test.jpg "https://api.weixin.qq.com/cgi-bin/media/upload?access_token=ACCESS_TOKEN&type=TYPE" 返回示例 { "errcode": 0, "errmsg": "ok", "type": "image", "media_id": "MEDIA_ID", "created_at": "xxx" } 云调用 云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。 接口方法 openapi.customerServiceMessage.uploadTempMedia 需在 config.json 中配置 customerServiceMessage.uploadTempMedia API 的权限,详情 请求参数 属性 类型 默认值 必填 说明 type string 是 文件类型 media FormData 是...
customerServiceMessage.setTyping 本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载) wx-server-sdk >= 0.4.0 下发客服当前输入状态给用户。详见 客服消息输入状态 调用方式: HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/cgi-bin/message/custom/typing?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 touser string 是 用户的 OpenID command Strign 是 命令 command 的合法值 值 说明 最低版本 Typing 对用户下发”正在输入”状态 CancelTyping 取消对用户的”正在输入”状态 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode number 错误码 errmsg string 错误信息 errcode 的合法值 值 说明 最低版本 45072 command字段取值不对 45080 下发输入状态,需要之前30秒内跟用户有过消息交互 45081 已经在输入状态,不可重复下发 请求示例 { "touser": "OPENID", "command": "Typing" } 云调用 云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。 接口方法 openapi.customerServiceMessage.setTyping 需在 config.json 中配置 customerServiceMessage.setTyping API 的权限,详情 请求参数 属性 类型 默认值 必填 说明 touser string 是 用户的 OpenID command Strign 是 命令 command 的合法值 值 说明 最低版本 Typing 对用户下发”正在输入”状态 CancelTyping 取消对用户的”正在输入”状态 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errCode number 错误码 errMsg string 错误信息 errCode...
customerServiceMessage.send 本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载) wx-server-sdk >= 0.4.0 发送客服消息给用户。详细规则见 发送客服消息 调用方式: HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/cgi-bin/message/custom/send?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 touser string 是 用户的 OpenID msgtype string 是 消息类型 text Object 是 文本消息,msgtype=”text” 时必填 image Object 是 图片消息,msgtype=”image” 时必填 link Object 是 图文链接,msgtype=”link” 时必填 miniprogrampage Object 是 小程序卡片,msgtype=”miniprogrampage” 时必填 msgtype 的合法值 值 说明 最低版本 text 文本消息 image 图片消息 link 图文链接 miniprogrampage 小程序卡片 text 的结构 属性 类型 默认值 必填 说明 content string 是 文本消息内容 image 的结构 属性 类型 默认值 必填 说明 media_id string 是 发送的图片的媒体ID,通过 新增素材接口 上传图片文件获得。 link 的结构 属性 类型 默认值 必填 说明 title string 是 消息标题 description string 是 图文链接消息 url string 是 图文链接消息被点击后跳转的链接 thumb_url string 是 图文链接消息的图片链接,支持 JPG、PNG 格式,较好的效果为大图 640 X 320,小图 80 X 80...
customerServiceMessage.getTempMedia 本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载) wx-server-sdk >= 0.4.0 获取客服消息内的临时素材。即下载临时的多媒体文件。目前小程序仅支持下载图片文件。 调用方式: HTTPS 调用 云调用 HTTPS 调用 请求地址 GET https://api.weixin.qq.com/cgi-bin/media/get?access_token=ACCESS_TOKEN&media_id=MEDIA_ID 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 media_id string 是 媒体文件 ID 返回值 Buffer 返回的图片 Buffer 异常返回 Object JSON 属性 类型 说明 errcode number 错误码 errmsg string 错误信息 errcode 的合法值 值 说明 最低版本 40007 无效媒体文件 ID 返回值说明 如果调用成功,会直接返回图片二进制内容,如果请求失败,会返回 JSON 格式的数据。 调用示例 使用 CURL 命令,用 FORM 表单方式上传一个多媒体文件 curl -I -G "https://api.weixin.qq.com/cgi-bin/media/get?access_token=ACCESS_TOKEN&media_id=MEDIA_ID" 云调用 云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。 接口方法 openapi.customerServiceMessage.getTempMedia 需在 config.json 中配置 customerServiceMessage.getTempMedia API 的权限,详情 请求参数 属性 类型 默认值 必填 说明 mediaId string 是 媒体文件 ID 返回值 Object 包含二进制数据及其数据类型的对象 属性 类型 说明 contentType String 数据类型 (MIME Type) buffer Buffer 数据 Buffer 异常 Object JSON 属性 类型 说明 errCode number 错误码 errMsg string 错误信息 errCode 的合法值 值 说明 最低版本 请求示例 const cloud...
analysis.getVisitPage 本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载) wx-server-sdk >= 0.4.0 访问页面。目前只提供按 page_visit_pv 排序的 top200。 调用方式: HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/datacube/getweanalysisappidvisitpage?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 begin_date string 是 开始日期。格式为 yyyymmdd end_date string 是 结束日期,限定查询1天数据,允许设置的最大值为昨日。格式为 yyyymmdd 返回值 Object 返回的 JSON 数据包 属性 类型 说明 page_path string 页面路径 page_visit_pv number 访问次数 page_visit_uv number 访问人数 page_staytime_pv number 次均停留时长 entrypage_pv number 进入页次数 exitpage_pv number 退出页次数 page_share_pv number 转发次数 page_share_uv number 转发人数 请求数据示例 { "begin_date" : "20170313", "end_date" : "20170313" } 返回数据示例 { "ref_date": "20170313", "list": [ { "page_path": "pages/main/main.html", "page_visit_pv": 213429, "page_visit_uv": 55423, "page_staytime_pv": 8.139198, "entrypage_pv": 117922, "exitpage_pv": 61304, "page_share_pv": 180, "page_share_uv": 166 }, { "page_path": "pages/linedetail/linedetail.html", "page_visit_pv": 155030, "page_visit_uv": 42195, "page_staytime_pv": 35.462395, "entrypage_pv": 21101, "exitpage_pv": 47051, "page_share_pv": 47, "page_share_uv": 42 }, {...
analysis.getVisitDistribution 本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载) wx-server-sdk >= 0.4.0 获取用户小程序访问分布数据 调用方式: HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/datacube/getweanalysisappidvisitdistribution?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 begin_date string 是 开始日期。格式为 yyyymmdd end_date string 是 结束日期,限定查询 1 天数据,允许设置的最大值为昨日。格式为 yyyymmdd 返回值 Object 返回的 JSON 数据包 属性 类型 说明 ref_date string 日期,格式为 yyyymmdd list Array.<Object> 数据列表 list 的结构 属性 类型 说明 index number 分布类型 item_list Array.<Object> 分布数据列表 index 的合法值 值 说明 最低版本 access_source_session_cnt 访问来源分布 access_staytime_info 访问时长分布 access_depth_info 访问深度的分布 item_list 的结构 属性 类型 说明 key number 场景 id,定义在各个 index 下不同,具体参见下方表格 value number 该场景 id 访问 pv access_source_visit_uv number 该场景 id 访问 uv 请求数据示例 { "begin_date" : "20170313", "end_date" : "20170313" } 返回数据示例 { "ref_date": "20170313", "list": [ { "index": "access_source_session_cnt", "item_list": [ { "key": 10,...
analysis.getUserPortrait 本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载) wx-server-sdk >= 0.4.0 获取小程序新增或活跃用户的画像分布数据。时间范围支持昨天、最近7天、最近30天。其中,新增用户数为时间范围内首次访问小程序的去重用户数,活跃用户数为时间范围内访问过小程序的去重用户数。 调用方式: HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/datacube/getweanalysisappiduserportrait?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 begin_date string 是 开始日期。格式为 yyyymmdd end_date string 是 结束日期,开始日期与结束日期相差的天数限定为0/6/29,分别表示查询最近1/7/30天数据,允许设置的最大值为昨日。格式为 yyyymmdd 返回值 Object 返回的 JSON 数据包 属性 类型 说明 ref_date string 时间范围,如:”20170611-20170617″ visit_uv_new Object 新用户画像 visit_uv Object 活跃用户画像 visit_uv_new 的结构 属性 类型 说明 index number 分布类型 province Object 省份,如北京、广东等 city Object 城市,如北京、广州等 genders Object 性别,包括男、女、未知 platforms Object 终端类型,包括 iPhone,android,其他 devices Object 机型,如苹果 iPhone 6,OPPO R9 等 ages Object 年龄,包括17岁以下、18-24岁等区间 province 的结构 属性 类型 说明 id number 属性值id name string 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 access_source_visit_uv number 该场景访问uv city 的结构 属性 类型 说明 id number 属性值id name string 属性值名称,与id对应。如属性为 province 时,返回的属性值名称包括「广东」等。 access_source_visit_uv number 该场景访问uv genders 的结构 属性 类型 说明 id number 属性值id name...
analysis.getDailyVisitTrend 本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载) wx-server-sdk >= 0.4.0 获取用户访问小程序数据日趋势 调用方式: HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/datacube/getweanalysisappiddailyvisittrend?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 begin_date string 是 开始日期。格式为 yyyymmdd end_date string 是 结束日期,限定查询1天数据,允许设置的最大值为昨日。格式为 yyyymmdd 返回值 Object 返回的 JSON 数据包 属性 类型 说明 list Array.<Object> 数据列表 list 的结构 属性 类型 说明 ref_date string 日期,格式为 yyyymmdd session_cnt number 打开次数 visit_pv number 访问次数 visit_uv number 访问人数 visit_uv_new number 新用户数 stay_time_uv number 人均停留时长 (浮点型,单位:秒) stay_time_session number 次均停留时长 (浮点型,单位:秒) visit_depth number 平均访问深度 (浮点型) 请求数据示例 { "begin_date" : "20170313", "end_date" : "20170313" } 返回数据示例 { "list": [ { "ref_date": "20170313", "session_cnt": 142549, "visit_pv": 472351, "visit_uv": 55500, "visit_uv_new": 5464, "stay_time_session": 0, "visit_depth": 1.9838 } ] } 云调用 云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。 接口方法 openapi.analysis.getDailyVisitTrend 需在 config.json 中配置 analysis.getDailyVisitTrend API 的权限,详情 请求参数 属性 类型 默认值...
analysis.getDailySummary 本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载) wx-server-sdk >= 0.4.0 获取用户访问小程序数据概况 调用方式: HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/datacube/getweanalysisappiddailysummarytrend?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 begin_date string 是 开始日期。格式为 yyyymmdd end_date string 是 结束日期,限定查询1天数据,允许设置的最大值为昨日。格式为 yyyymmdd 返回值 Object 返回的 JSON 数据包 属性 类型 说明 list Array.<Object> 数据列表 list 的结构 属性 类型 说明 ref_date string 日期,格式为 yyyymmdd visit_total number 累计用户数 share_pv number 转发次数 share_uv number 转发人数 请求数据示例 { "begin_date" : "20170313", "end_date" : "20170313" } 返回数据示例 { "list": [ { "ref_date": "20170313", "visit_total": 391, "share_pv": 572, "share_uv": 383 } ] } 云调用 云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。 接口方法 openapi.analysis.getDailySummary 需在 config.json 中配置 analysis.getDailySummary API 的权限,详情 请求参数 属性 类型 默认值 必填 说明 beginDate string 是 开始日期。格式为 yyyymmdd endDate string 是 结束日期,限定查询1天数据,允许设置的最大值为昨日。格式为 yyyymmdd 返回值 Object 返回的 JSON 数据包 属性 类型 说明 list...