- 开发无止境 -
Data: 2016-02-20 00:12:19Form: JournalClick: 9
API
API
导读一级分类 | 二级分类 | API | 描述 |
登陆 | code2Session | 登录凭证校验。通过 wx.login 接口获得临时登录凭证 code 后传到开发者服务器调用此接口完成登录流程 | |
用户信息 | getPaidUnionId | 用户支付完成后,获取该用户的 UnionId,无需用户授权 | |
接口调用凭证 | getAccessToken | 获取小程序全局唯一后台接口调用凭据(access_token)。调用绝大多数后台接口时都需使用 access_token,开发者需要进行妥善保存 | |
数据分析 | 访问留存 | getDailyRetain | 获取用户访问小程序日留存 |
getMonthlyRetain | 获取用户访问小程序月留存 | ||
getWeeklyRetain | 获取用户访问小程序周留存 | ||
getDailySummary | 获取用户访问小程序数据概况 | ||
访问趋势 | getDailyVisitTrend | 获取用户访问小程序数据日趋势 | |
getMonthlyVisitTrend | 获取用户访问小程序数据月趋势 | ||
getWeeklyVisitTrend | 获取用户访问小程序数据周趋势 | ||
getUserPortrait | 获取小程序新增或活跃用户的画像分布数据。时间范围支持昨天、最近7天、最近30天 | ||
getVisitDistribution | 获取用户小程序访问分布数据 | ||
getVisitPage | 访问页面。目前只提供按 page_visit_pv 排序的 top200 | ||
客服消息 | getTempMedia | 获取客服消息内的临时素材。即下载临时的多媒体文件。目前小程序仅支持下载图片文件 | |
send | 发送客服消息给用户 | ||
setTyping | 下发客服当前输入状态给用户 | ||
uploadTempMedia | 把媒体文件上传到微信服务器。目前仅支持图片。用于发送客服消息或被动回复用户消息 | ||
模版消息 | addTemplate | 组合模板并添加至帐号下的个人模板库 | |
deleteTemplate | 组合模板并添加至帐号下的个人模板库 | ||
getTemplateLibraryById | 组合模板并添加至帐号下的个人模板库 | ||
getTemplateLibraryList | 组合模板并添加至帐号下的个人模板库 | ||
getTemplateList | 组合模板并添加至帐号下的个人模板库 | ||
send | 组合模板并添加至帐号下的个人模板库 | ||
统一服务消息 | send | 下发小程序和公众号统一的服务消息 | |
动态消息 | createActivityId | 创建被分享动态消息的 activity_id | |
setUpdatableMsg | 修改被分享的动态消息 | ||
插件管理 | applyPlugin | 向插件开发者发起使用插件的申请 | |
getPluginDevApplyList | 获取当前所有插件使用方 | ||
getPluginList | 查询已添加的插件 | ||
setDevPluginApplyStatus | 修改插件使用申请的状态 | ||
unbindPlugin | 删除已添加的插件 | ||
附近的小程序 | add | 添加地点 | |
delete | 删除地点 | ||
getList | 查看地点列表 | ||
setShowStatus | 展示/取消展示附近小程序 | ||
小程序码 | createQRCode | 获取小程序二维码,适用于需要的码数量较少的业务场景 | |
get | 获取小程序码,适用于需要的码数量较少的业务场景 | ||
getUnlimited | 获取小程序码,适用于需要的码数量极多的业务场景 | ||
内容安全 | imgSecCheck | 校验一张图片是否含有违法违规内容 | |
mediaCheckAsync | 异步校验图片/音频是否含有违法违规内容 | ||
msgSecCheck | 检查一段文本是否含有违法违规内容 | ||
广告 | addUserAction | 回传广告数据 | |
addUserActionSet | 广告创建数据源 | ||
getUserActionSetReports | 广告数据源报表查询 | ||
getUserActionSets | 广告数据源查询 | ||
图像处理 | aiCrop | 本接口提供基于小程序的图片智能裁剪能力 | |
scanQRCode | 本接口提供基于小程序的条码/二维码识别的API | ||
superresolution | 本接口提供基于小程序的图片高清化能力 | ||
即时配送 | 小程序使用 | abnormalConfirm | 异常件退回商家商家确认收货接口 |
addOrder | 下配送单接口 | ||
addTip | 可以对待接单状态的订单增加小费 | ||
cancelOrder | 取消配送单接口 | ||
getAllImmeDelivery | 获取已支持的配送公司列表接口 | ||
getBindAccount | 拉取已绑定账号 | ||
getOrder | 拉取配送单信息 | ||
mockUpdateOrder | 模拟配送公司更新配送单状态 | ||
onOrderStatus | 配送单配送状态更新通知接口 | ||
preAddOrder | 预下配送单接口 | ||
preCancelOrder | 预取消配送单接口 | ||
reOrder | 重新下单 | ||
服务提供方使用 | onAgentPosQuery | 查询骑手当前位置信息 | |
onAuthInfoGet | 使用授权码拉取授权信息 | ||
onCancelAuth | 取消授权帐号 | ||
onOrderAdd | 真实发起下单任务 | ||
onOrderAddTips | 可以对待接单状态的订单增加小费 | ||
onOrderCancel | 取消订单操作,取消逻辑参照各配送公司取消规则 | ||
onOrderConfirmReturn | 异常妥投商户收货确认 | ||
onOrderPreAdd | 并非真正发单,用来验证是否配送公司是否可以接单,并在成功时返回时效、计价等信息,也可用来验证地址以及时间是否在配送范围内 | ||
onOrderPreCancel | 预取消订单操作,用于在取消订单前查询是否可以取消以及取消扣除的违约金 | ||
onOrderQuery | 查询订单状态 | ||
onOrderReAdd | 在调用下单接口后,订单被取消或者投递异常的情况下,调用此接口重新下单 | ||
onPreAuthCodeGet | 获取预授权码 | ||
onRiderScoreSet | 给骑手评分 | ||
updateOrder | 配送公司更新配送单状态 | ||
物流助手 | 小程序使用 | addOrder | 生成运单 |
batchGetOrder | 批量获取运单数据 | ||
bindAccount | 绑定、解绑物流账号 | ||
cancelOrder | 取消运单 | ||
getAllAccount | 获取所有绑定的物流账号 | ||
getAllDelivery | 获取支持的快递公司列表 | ||
getOrder | 获取运单数据 | ||
getPath | 查询运单轨迹 | ||
getPrinter | 获取打印员。若需要使用微信打单 PC 软件,才需要调用 | ||
getQuota | 获取电子面单余额。仅在使用加盟类快递公司时,才可以调用 | ||
onBindResultUpdate | 绑定商户审核结果更新事件。收到事件之后,回复success或者空串即可 | ||
onPathUpdate | 运单轨迹更新事件。当运单轨迹有更新时,会产生如下数据包。收到事件之后,回复success或者空串即可 | ||
testUpdateOrder | 模拟快递公司更新订单状态, 该接口只能用户测试 | ||
updatePrinter | 配置面单打印员,可以设置多个,若需要使用微信打单 PC 软件,才需要调用 | ||
服务提供方使用 | getContact | 获取面单联系人信息 | |
onAddOrder | 请求下单事件 | ||
onCancelOrder | 取消订单事件 | ||
onCheckBusiness | 审核商户事件 | ||
onGetQuota | 查询商户余额事件 | ||
previewTemplate | 预览面单模板。用于调试面单模板使用 | ||
updateBusiness | 更新商户审核结果 | ||
updatePath | 更新运单轨迹 | ||
OCR | bankcard | 本接口提供基于小程序的银行卡 OCR 识别 | |
businessLicense | 本接口提供基于小程序的营业执照 OCR 识别 | ||
driverLicense | 本接口提供基于小程序的驾驶证 OCR 识别 | ||
idcard | 本接口提供基于小程序的身份证 OCR 识别 | ||
printedText | 本接口提供基于小程序的通用印刷体 OCR 识别 | ||
vehicleLicense | 本接口提供基于小程序的行驶证 OCR 识别 | ||
运维中心 | realtimelogSearch | 实时日志查询 | |
小程序搜索 | submitPages | 小程序开发者可以通过本接口提交小程序页面url及参数信息,让微信可以更及时的收录到小程序的页面信息,开发者提交的页面信息将可能被用于小程序搜索结果展示 | |
服务市场 | invokeService | 调用服务平台提供的服务 | |
导购助手 | 导购管理 | addGuideAcct | 为服务号添加导购 |
delGuideAcct | 删除导购 | ||
getGuideAcct | 获取导购信息 | ||
getGuideAcctConfig | 获取服务号的敏感词信息与自动回复信息 | ||
getGuideAcctList | 拉取导购列表 | ||
getGuideBuyerChatRecord | 获取导购聊天记录 | ||
getGuideConfig | 获取导购快捷回复信息 | ||
guideCreateQrCode | 生成导购二维码 | ||
onGuideCreateQrCode | 微信用户扫导购二维码后会触发的事件推送 | ||
pushShowWxaPathMenu | 复制小程序页面路径开关,开关打开后有效期是60天,开关的作用是用于在微信上复制对应小程序的任意页面path | ||
setGuideAcctConfig | 为服务号设置敏感词与自动回复 | ||
setGuideConfig | 设置导购快捷回复信息 | ||
updateGuideAcct | 更新导购昵称或者头像 | ||
标签管理 | addGuideBuyerDisplayTag | 添加展示标签信息 | |
addGuideBuyerTag | 为粉丝添加可查询标签 | ||
addGuideTagOption | 添加标签可选值 | ||
delGuideBuyerTag | 删除粉丝标签 | ||
getGuideBuyerDisplayTag | 查询展示标签信息 | ||
getGuideBuyerTag | 查询粉丝标签 | ||
getGuideTagOption | 查询标签可选值信息 | ||
newGuideTagOption | 新建可查询标签类型,支持新建4类可查询标签 | ||
queryGuideBuyerByTag | 根据标签值筛选粉丝 | ||
粉丝管理 | addGuideBuyerRelation | 为服务号导购添加粉丝 | |
delGuideBuyerRelation | 删除导购的粉丝 | ||
getGuideBuyerRelation | 查询某一个粉丝与导购的绑定关系 | ||
getGuideBuyerRelationByBuyer | 通过粉丝信息查询该粉丝与导购的绑定关系 | ||
getGuideBuyerRelationList | 拉取导购的粉丝列表 | ||
rebindGuideAcctForBuyer | 将粉丝从一个导购迁移到另外一个导购下 | ||
updateGuideBuyerRelation | 更新粉丝昵称 | ||
素材管理 | delGuideCardMaterial | 删除小程序卡片素材 | |
delGuideImageMaterial | 删除图片素材 | ||
delGuideWordMaterial | 删除文字素材 | ||
getGuideCardMaterial | 获取小程序卡片素材信息 | ||
getGuideImageMaterial | 获取图片素材信息 | ||
getGuideWordMaterial | 获取文字素材信息 | ||
setGuideCardMaterial | 添加小程序卡片素材 | ||
setGuideImageMaterial | 添加图片素材 | ||
setGuideWordMaterial | 为服务号添加文字素材 | ||
生物认证 | verifySignature | SOTER 生物认证秘钥签名验证 | |
订阅消息 | addTemplate | SOTER 组合模板并添加至帐号下的个人模板库 | |
deleteTemplate | 删除帐号下的个人模板 | ||
getCategory | 获取小程序账号的类目 | ||
getPubTemplateKeyWordsById | 获取模板标题下的关键词列表 | ||
getPubTemplateTitleList | 获取帐号所属类目下的公共模板标题 | ||
getTemplateList | 获取当前帐号下的个人模板列表 | ||
send | 发送订阅消息 |
API
getAccessToken
获取小程序全局唯一后台接口调用凭据请求地址
GET https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=APPID&secret=APPSECRET
请求参数
编号 | 属性 | 类型 | 必填 | 说明 |
---|---|---|---|---|
1 | grant_type | string | 是 | 填写client_credential |
2 | appid | string | 小程序唯一凭证,即 AppID | |
3 | secret | string | 小程序唯一凭证密钥,即 AppSecret,获取方式同 appid |
返回值
编号|属性|类型|说明 ---|---|---|---|--- 1|access_token|string|获取到的凭证 2|expires_in|number|凭证有效时间,单位:秒。目前是7200秒之内的值 3|errcode|number|错误码 4|errmsg|string|错误信息
Page({
onLoad(){
wx.request({
url: 'https://api.weixin.qq.com/cgi-bin/token',
data: {
grant_type: 'client_credential',
APPID: 'wx1ef6ae398255f643',
secret: 'd5ae23dff1fb8c8dc67b75659a85b8a4'
},
method: 'GET',
dataType: 'json',
responseType: 'text',
success(res) {
console.log(res);
}
})
}
})
getMonthlyRetain
获取用户访问小程序月留存请求地址
POST https://api.weixin.qq.com/datacube/getweanalysisappidmonthlyretaininfo?access_token=ACCESS_TOKEN
请求参数
编号 | 属性 | 类型 | 必填 | 说明 |
---|---|---|---|---|
1 | access_token | string | 是 | 接口调用凭证 |
2 | begin_date | string | 是 | 开始日期,为自然月第一天。格式为 yyyymmdd |
3 | end_date | string | 是 | 结束日期,为自然月最后一天,限定查询一个月数据。格式为 yyyymmdd |
返回值
编号|属性|类型|说明 ---|---|---|---|--- 1|ref_date|string|时间,如:"201702" 2|visit_uv_new|Object|新增用户留存 3|visit_uv|Object|活跃用户留存
Page({
onLoad(){
wx.request({
url: 'https://api.weixin.qq.com/cgi-bin/token',
data: {
grant_type: 'client_credential',
APPID: 'wx1ef6ae398255f643',
secret: 'd5ae23dff1fb8c8dc67b75659a85b8a4'
},
method: 'GET',
dataType: 'json',
responseType: 'text',
success(res) {
wx.request({
url: 'https://api.weixin.qq.com/datacube/getweanalysisappidmonthlyretaininfo?access_token=' + res.data.access_token,
data: {
begin_date:"20200101",
end_date:"20200131"
},
header: {
'content-type': 'application/json'
},
method: 'POST',
dataType: 'json',
responseType: 'text',
success(res) {
console.log(res);
}
})
}
})
}
})