微信小程序开发文档 第65页

logistics.onCancelOrder 本文档描述服务器端接收的消息或事件，详细说明参见消息推送。 取消订单事件。 消息参数 Object 属性 类型 说明 ToUserName string 快递公司小程序 UserName FromUserName string 下单用户的 OpenID CreateTime number 事件时间，Unix 时间戳 MsgType string 消息类型，固定为 event Event string 事件类型，固定为 cancel_waybill OrderID string 唯一标识订单的 ID，由商户生成 BizID string 商户 ID BizPwd string 商户密码 ShopAppID string 商户的小程序 AppID WayBillID string 运单 ID，从微信号段中生成 消息返回 属性 类型 默认值 必填 说明 ToUserName string 是 原样返回请求中的 FromUserName FromUserName string 是 快递公司小程序 UserName CreateTime number 是 事件时间，Unix 时间戳 MsgType string 是 消息类型，固定为 event Event string 是 事件类型，固定为 cancel_waybill，不区分大小写 BizID string 是 商户ID，请原样返回 OrderID string 是 唯一标识订单的ID，由商户生成。请原样返回 WayBillID string 是 运单ID，请原样返回 ResultCode number 是 处理结果错误码 ResultMsg string 是 处理结果详情 ResultCode 的合法值 值 说明 最低版本 0 取消成功 -1 其他错误 30001 参数错误（BizID、OrderID、WayBillID不存在） 30002 已经揽收，不可取消 30003 无效单（如已经取消过、或签收超过一定时间），不可取消 30004 快递不支持取消运单 消息数据包示例 XML 格式 <xml> <ToUserName><![CDATA[gh_abcdefg]]></ToUserName>...

logistics.onAddOrder 本文档描述服务器端接收的消息或事件，详细说明参见消息推送。 请求下单事件。 消息参数 Object 属性 类型 说明 ToUserName string 快递公司小程序 UserName FromUserName string 微信团队的 OpenID （固定值） CreateTime number 事件时间，Unix时间戳 MsgType string 消息类型，固定为 event Event string 事件类型，固定为 add_waybill，不区分大小写 Token string 订单 Token。请保存该 Token，调用logistics.updatePath时需要传入 OrderID string 唯一标识订单的 ID，由商户生成。快递需要保证相同的 OrderID 生成相同的运单ID。 BizID string 商户 ID，即商户在快递注册的客户编码或月结账户名 BizPwd string BizID 对应的密码 ShopAppID string 商户的小程序 AppID WayBillID string 运单 ID，从微信号段中生成。若为 0，则表示需要快递来生成运单 ID。 Remark string 快递备注，会打印到面单上，比如”易碎物品” Sender Array.<Object> 发件人信息 Receiver Array.<Object> 收件人信息 Cargo Array.<Object> 包裹信息 Insured Array.<Object> 保价信息 Service Array.<Object> 服务类型 Sender 的结构 属性 类型 说明 Name string 发件人姓名 Tel string 发件人座机号码 Mobile string 发件人手机号码 Company string 发件人公司名 PostCode string 发件人邮编 Country string 发件人所在国家，默认为”中国” Province string 发件人省份，比如”广东省” City string 发件人地区/市，比如”广州市” Area string 发件人区/县，比如”海珠区” Address string 发件人详细地址，比如”XX路XX号XX大厦XX” Receiver 的结构 属性 类型 说明 Name string 收件人姓名 Tel string...

logistics.testUpdateOrder 本接口应在服务器端调用，详细说明参见服务端API。 模拟快递公司更新订单状态, 该接口只能用户测试 请求地址 POST https://api.weixin.qq.com/cgi-bin/express/business/test_update_order?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 biz_id string 是 商户id,需填test_biz_id order_id string 是 订单号 delivery_id string 是 快递公司id,需填TEST waybill_id string 是 运单号 action_time number 是 轨迹变化 Unix 时间戳 action_type number 是 轨迹变化类型 action_msg string 是 轨迹变化具体信息说明,使用UTF-8编码 action_type 的合法值 值 说明 最低版本 100001 揽件阶段-揽件成功 100002 揽件阶段-揽件失败 100003 揽件阶段-分配业务员 200001 运输阶段-更新运输轨迹 300002 派送阶段-开始派送 300003 派送阶段-签收成功 300004 派送阶段-签收失败 400001 异常阶段-订单取消 400002 异常阶段-订单滞留 返回值 Object 属性 类型 说明 errcode number 错误码 errmsg string 错误信息 errcode 的合法值 值 说明 最低版本 0 成功 -1 系统失败 请求数据示例 { "biz_id": "test_biz_id", "order_id": "xxxxxxxxxxxx", "delivery_id": "TEST", "waybill_id": "xxxxxxxxxx", "action_time": 123456789, "action_type": 100001, "action_msg": "揽件阶段" } 返回数据示例 { "errcode": 0, "errmsg": "ok" }

logistics.onPathUpdate 本文档描述服务器端接收的消息或事件，详细说明参见消息推送。 运单轨迹更新事件。当运单轨迹有更新时，会产生如下数据包。收到事件之后，回复success或者空串即可。 消息参数 Object 属性 类型 说明 ToUserName string 小程序的原始ID FromUserName string 发送者的openid CreateTime number 消息创建时间（整型） MsgType string 固定 event Event string 固定 add_express_path DeliveryID string 快递公司ID WayBillId string 运单ID OrderId string 订单ID Version number 轨迹版本号（整型） Count number 轨迹节点数（整型） Actions Array.<Object> 轨迹列表 Actions 的结构 属性 类型 说明 ActionTime number 轨迹节点 Unix 时间戳 ActionType number 轨迹节点类型 ActionMsg string 轨迹节点详情 ActionType 的合法值 值 说明 最低版本 100001 揽件阶段-揽件成功 100002 揽件阶段-揽件失败 100003 揽件阶段-分配业务员 200001 运输阶段-更新运输轨迹 300002 派送阶段-开始派送 300003 派送阶段-签收成功 300004 派送阶段-签收失败 400001 异常阶段-订单取消 400002 异常阶段-订单滞留 消息数据包示例 XML 格式 <xml> <ToUserName><![CDATA[toUser]]></ToUserName> <FromUserName><![CDATA[fromUser]]></FromUserName> <CreateTime>1546924844</CreateTime> <MsgType><![CDATA[event]]></MsgType> <Event><![CDATA[add_express_path]]></Event> <DeliveryID><![CDATA[SF]]></DeliveryID> <WayBillId><![CDATA[123456789]]></WayBillId> <OrderId><![CDATA[123456]]></OrderId> <Version>3</Version> <Count>3</Count> <Actions> <ActionTime>1546924840</ActionTime> <ActionType>100001</ActionType> <ActionMsg><![CDATA[小哥A揽件成功]]></ActionMsg> </Actions> <Actions> <ActionTime>1546924841</ActionTime> <ActionType>200001</ActionType> <ActionMsg><![CDATA[到达广州集包地]]></ActionMsg> </Actions> <Actions> <ActionTime>1546924842</ActionTime> <ActionType>200001</ActionType> <ActionMsg><![CDATA[运往目的地]]></ActionMsg> </Actions> </xml> JSON 格式 { "ToUserName": "toUser", "FromUserName": "fromUser", "CreateTime":...

logistics.onBindResultUpdate 本文档描述服务器端接收的消息或事件，详细说明参见消息推送。 绑定商户审核结果更新事件。收到事件之后，回复success或者空串即可。 消息参数 OnBindResultUpdateData 消息数据包示例 XML 格式 <xml> <ToUserName><![CDATA[toUser]]></ToUserName> <FromUserName><![CDATA[fromUser]]></FromUserName> <CreateTime>1546924844</CreateTime> <MsgType><![CDATA[event]]></MsgType> <Event><![CDATA[update_business_bind_result]]></Event> <errcode>0</errcode> <errmsg><![CDATA[ok]]></errmsg> <delivery_id><![CDATA[EMS]]></delivery_id> <biz_id><![CDATA[1234567]]></biz_id> </xml> JSON 格式 { "ToUserName": "toUser", "FromUserName": "fromUser", "CreateTime": 1546924844, "MsgType": "event", "Event": "update_business_bind_result", "errcode": 0, "errmsg": "ok", "delivery_id": "EMS", "biz_id": "1234567", }

nearbyPoi.setShowStatus 本接口应在服务器端调用，详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载） wx-server-sdk >= 0.4.0 展示/取消展示附近小程序 调用方式： HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/wxa/setnearbypoishowstatus?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 poi_id string 是 附近地点 ID status number 是 是否展示 status 的合法值 值 说明 最低版本 0 不展示 1 展示 返回值 Object 返回的 JSON 数据 属性 类型 说明 errmsg string 错误信息 errcode number 错误码 错误 错误码 错误信息 说明 0 ok 正常 47001 POST数据json格式错误 20002 POST参数非法 44002 POST数据为空 92000 该经营资质已添加，请勿重复添加 92002 附近地点添加数量达到上线，无法继续添加 92003 地点已被其它小程序占用 92004 附近功能被封禁 92005 地点正在审核中 92006 地点正在展示小程序 92007 地点审核失败 92008 程序未展示在该地点 93009 小程序未上架或不可见 93010 地点不存在 93011 个人类型小程序不可用 93011 个人类型小程序不可用 93012 非普通类型小程序（门店小程序、小店小程序等）不可用 93013 从腾讯地图获取地址详细信息失败 93014 同一资质证件号重复添加 云调用 云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力，需要在云函数中通过 wx-server-sdk 使用。 接口方法 openapi.nearbyPoi.setShowStatus 需在 config.json 中配置 nearbyPoi.setShowStatus API 的权限，详情 请求参数 属性 类型 默认值 必填 说明 poiId string 是 附近地点 ID status number 是...

nearbyPoi.delete 本接口应在服务器端调用，详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载） wx-server-sdk >= 0.4.0 删除地点 调用方式： HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/wxa/delnearbypoi?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 poi_id string 是 附近地点 ID 返回值 deleteNearbyPoiResponse 返回的 JSON 数据包 错误 错误码 错误信息 说明 0 ok 正常 47001 POST数据json格式错误 20002 POST参数非法 44002 POST数据为空 92000 该经营资质已添加，请勿重复添加 92002 附近地点添加数量达到上线，无法继续添加 92003 地点已被其它小程序占用 92004 附近功能被封禁 92005 地点正在审核中 92006 地点正在展示小程序 92007 地点审核失败 92008 程序未展示在该地点 93009 小程序未上架或不可见 93010 地点不存在 93011 个人类型小程序不可用 93011 个人类型小程序不可用 93012 非普通类型小程序（门店小程序、小店小程序等）不可用 93013 从腾讯地图获取地址详细信息失败 93014 同一资质证件号重复添加 POST数据示例： { "poi_id":"469382092" } 云调用 云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力，需要在云函数中通过 wx-server-sdk 使用。 接口方法 openapi.nearbyPoi.delete 需在 config.json 中配置 nearbyPoi.delete API 的权限，详情 请求参数 属性 类型 默认值 必填 说明 poiId string 是 附近地点 ID 返回值 deleteNearbyPoiResponse 返回的 JSON 数据包 错误 错误码 错误信息 说明 0 ok 正常 47001 POST数据json格式错误 20002 POST参数非法 44002 POST数据为空 92000 该经营资质已添加，请勿重复添加 92002...

nearbyPoi.add 本接口应在服务器端调用，详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载） wx-server-sdk >= 0.4.0 添加地点 调用方式： HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/wxa/addnearbypoi?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 is_comm_nearby string 是 必填,写死为”1″ pic_list string 是 门店图片，最多9张，最少1张，上传门店图片如门店外景、环境设施、商品服务等，图片将展示在微信客户端的门店页。图片链接通过文档https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1444738729中的《上传图文消息内的图片获取URL》接口获取。必填，文件格式为bmp、png、jpeg、jpg或gif，大小不超过5M pic_list是字符串，内容是一个json service_infos string 是 必服务标签列表 必填，需要填写 1、 服务标签ID 2、 服务类型tpye 3、 服务名称name 详细字段格式见下方《服务标签id编号、类型与服务名称表》 4、 APPID 5、 对应服务落地页的path路径：path路径页面要与对应的服务标签一致，例如选取外卖服务，path路径应该是小程序的外卖对应的那个页面，path路径获取咨询开发或者到小程序管理后台-工具-生成小程序码页面获取 6、新增服务描述desc：描述服务内容，例如满减、折扣等优惠信息或新品、爆品等商品信息，仅标准服务都可添加，10个字符以内。 service_infos是字符串，内容是一个json kf_info string 是 客服信息 选填，可自定义服务头像与昵称，具体填写字段见下方示例kf_info pic_list是字符串，内容是一个json store_name string 是 门店名字 必填，门店名称需按照所选地理位置自动拉取腾讯地图门店名称，不可修改，如需修改请重现选择地图地点或重新创建地点。 hour string 是 营业时间，格式11:11-12:12 必填 address string 是 地址 必填 poi_id string 是 如果创建新的门店，poi_id字段为空 如果更新门店，poi_id参数则填对应门店的poi_id 选填 company_name string 是 主体名字 必填 contract_phone string 是 门店电话 必填 credential string 是 资质号 必填, 15位营业执照注册号或9位组织机构代码 qualification_list string 是 证明材料 必填 如果company_name和该小程序主体不一致，需要填qualification_list，详细规则见附近的小程序使用指南-如何证明门店的经营主体跟公众号或小程序帐号主体相关http://kf.qq.com/faq/170401MbUnim17040122m2qY.html map_poi_id string 是 对应《在腾讯地图中搜索门店》中的sosomap_poi_uid字段 腾讯地图那边有些数据不一致，如果不填map_poi_id的话，小概率会提交失败！ 注： poi_id与map_poi_id关系： map_poi_id是腾讯地图对于poi的唯一标识 poi_id是门店进驻附近后的门店唯一标识 NearbyPoiError@error 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errmsg...

updatableMessage.createActivityId 本接口应在服务器端调用，详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载） wx-server-sdk >= 0.4.0 创建被分享动态消息的 activity_id。详见动态消息。 调用方式： HTTPS 调用 云调用 HTTPS 调用 请求地址 GET https://api.weixin.qq.com/cgi-bin/message/wxopen/activityid/create?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 返回值 Object 返回的 JSON 数据包 属性 类型 说明 activity_id string 动态消息的 ID expiration_time number activity_id 的过期时间戳。默认24小时后过期。 errcode number 错误码 errcode 的合法值 值 说明 最低版本 0 请求成功 -1 系统繁忙。此时请开发者稍候再试 42001 access_token 过期 云调用 云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力，需要在云函数中通过 wx-server-sdk 使用。 接口方法 openapi.updatableMessage.createActivityId 需在 config.json 中配置 updatableMessage.createActivityId API 的权限，详情 返回值 Object 返回的 JSON 数据包 属性 类型 说明 activityId string 动态消息的 ID expirationTime number activity_id 的过期时间戳。默认24小时后过期。 errCode number 错误码 errCode 的合法值 值 说明 最低版本 0 成功 异常 Object 抛出的异常 属性 类型 说明 errCode number 错误码 errCode 的合法值 值 说明 最低版本 -1 系统繁忙。此时请开发者稍候再试 42001 access_token 过期

auth.getAccessToken 本接口应在服务器端调用，详细说明参见服务端API。 获取小程序全局唯一后台接口调用凭据（access_token）。调用绝大多数后台接口时都需使用 access_token，开发者需要进行妥善保存。 请求地址 GET https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=APPID&secret=APPSECRET 请求参数 属性 类型 默认值 必填 说明 grant_type string 是 填写 client_credential appid string 是 小程序唯一凭证，即 AppID，可在「微信公众平台 – 设置 – 开发设置」页中获得。（需要已经成为开发者，且帐号没有异常状态） secret string 是 小程序唯一凭证密钥，即 AppSecret，获取方式同 appid 返回值 Object 返回的 JSON 数据包 属性 类型 说明 access_token string 获取到的凭证 expires_in number 凭证有效时间，单位：秒。目前是7200秒之内的值。 errcode number 错误码 errmsg string 错误信息 errcode 的合法值 值 说明 最低版本 -1 系统繁忙，此时请开发者稍候再试 0 请求成功 40001 AppSecret 错误或者 AppSecret 不属于这个小程序，请开发者确认 AppSecret 的正确性 40002 请确保 grant_type 字段值为 client_credential 40013 不合法的 AppID，请开发者检查 AppID 的正确性，避免异常字符，注意大小写 返回数据示例 正常返回 {"access_token":"ACCESS_TOKEN","expires_in":7200} 错误时返回 {"errcode":40013,"errmsg":"invalid appid"} access_token 的存储与更新 access_token 的存储至少要保留 512 个字符空间； access_token 的有效期目前为 2 个小时，需定时刷新，重复获取将导致上次获取的 access_token 失效； 建议开发者使用中控服务器统一获取和刷新 access_token，其他业务逻辑服务器所使用的 access_token 均来自于该中控服务器，不应该各自去刷新，否则容易造成冲突，导致 access_token 覆盖而影响业务； access_token 的有效期通过返回的 expires_in 来传达，目前是7200秒之内的值，中控服务器需要根据这个有效时间提前去刷新。在刷新过程中，中控服务器可对外继续输出的老 access_token，此时公众平台后台会保证在5分钟内，新老 access_token 都可用，这保证了第三方业务的平滑过渡； access_token 的有效时间可能会在未来有调整，所以中控服务器不仅需要内部定时主动刷新，还需要提供被动刷新 access_token 的接口，这样便于业务服务器在API调用获知 access_token 已超时的情况下，可以触发 access_token 的刷新流程。