nearbyPoi.add

本接口应在服务器端调用,详细说明参见服务端API

本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载),wx-server-sdk >= 0.4.0

添加地点

调用方式:

HTTPS 调用

请求地址

  1. POST https://api.weixin.qq.com/wxa/addnearbypoi?access_token=ACCESS_TOKEN

请求参数

属性类型默认值必填说明
access_tokenstring接口调用凭证
is_comm_nearbystring必填,写死为”1”
pic_liststring门店图片,最多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_infosstring必服务标签列表 必填,需要填写
1、 服务标签ID
2、 服务类型tpye
3、 服务名称name
详细字段格式见下方《服务标签id编号、类型与服务名称表》
4、 APPID
5、 对应服务落地页的path路径:path路径页面要与对应的服务标签一致,例如选取外卖服务,path路径应该是小程序的外卖对应的那个页面,path路径获取咨询开发或者到小程序管理后台-工具-生成小程序码页面获取
6、新增服务描述desc:描述服务内容,例如满减、折扣等优惠信息或新品、爆品等商品信息,仅标准服务都可添加,10个字符以内。
service_infos是字符串,内容是一个json
kf_infostring客服信息 选填,可自定义服务头像与昵称,具体填写字段见下方示例kf_info pic_list是字符串,内容是一个json
store_namestring门店名字 必填,门店名称需按照所选地理位置自动拉取腾讯地图门店名称,不可修改,如需修改请重现选择地图地点或重新创建地点。
hourstring营业时间,格式11:11-12:12 必填
addressstring地址 必填
poi_idstring如果创建新的门店,poi_id字段为空 如果更新门店,poi_id参数则填对应门店的poi_id 选填
company_namestring主体名字 必填
contract_phonestring门店电话 必填
credentialstring资质号 必填, 15位营业执照注册号或9位组织机构代码
qualification_liststring证明材料 必填 如果company_name和该小程序主体不一致,需要填qualification_list,详细规则见附近的小程序使用指南-如何证明门店的经营主体跟公众号或小程序帐号主体相关http://kf.qq.com/faq/170401MbUnim17040122m2qY.html
map_poi_idstring对应《在腾讯地图中搜索门店》中的sosomap_poi_uid字段 腾讯地图那边有些数据不一致,如果不填map_poi_id的话,小概率会提交失败!
注:
poi_id与map_poi_id关系:
map_poi_id是腾讯地图对于poi的唯一标识
poi_id是门店进驻附近后的门店唯一标识
NearbyPoiError@error

返回值

Object

返回的 JSON 数据包

属性类型说明
errmsgstring错误信息
errcodenumber错误码
dataobject返回数据

data 的结构

属性类型说明
audit_idstring审核单 ID
poi_idstring附近地点 ID
related_credentialstring经营资质证件号

注:添加门店需要审核,需要1到2个工作日

服务标签id编号、类型与服务名称表

| ID | type | name(服务名称) | | —————- | ————————————————————— | | 0 | 2 | 自定义服务,可自定义名称(10个字符以内) | | 1 | 1 | 外送 | | 2 | 1 | 快递 | | 3 | 1 | 充电 | | 4 | 1 | 预约 | | 5 | 1 | 挂号 | | 6 | 1 | 点餐 | | 7 | 1 | 优惠 | | 8 | 1 | 乘车 | | 9 | 1 | 会员 | | 10 | 1 | 买单 | | 11 | 1 | 排队 | | 12 | 1 | 缴费 | | 13 | 1 | 购票 | | 14 | 1 | 到店自提 | | 15 | 1 | 预订 |

频率限制说明

添加请求暂不支持并发调用,建议使用时间隔1s进行串行调用

请求示例

  1. {
  2. "is_comm_nearby": "1", //值固定
  3. "kf_info": "{\"open_kf\":true,\"kf_headimg\":\"http://mmbiz.qpic.cn/mmbiz_jpg/kKMgNtnEfQzDKpLXYhgo3W3Gndl34gITqmP914zSwhajIEJzUPpx40P7R8fRe1QmicneQMhFzpZNhSLjrvU1pIA/0?wx_fmt=jpeg\",\"kf_name\":\"Harden\"}",
  4. "pic_list": "{\"list\":[\"http://mmbiz.qpic.cn/mmbiz_jpg/kKMgNtnEfQzDKpLXYhgo3W3Gndl34gITqmP914zSwhajIEJzUPpx40P7R8fRe1QmicneQMhFzpZNhSLjrvU1pIA/0?wx_fmt=jpeg\",\"http://mmbiz.qpic.cn/mmbiz_jpg/kKMgNtnEfQzDKpLXYhgo3W3Gndl34gITRneE5FS9uYruXGMmrtmhsBySwddEWUGOibG8Ze2NT5E3Dyt79I0htNg/0?wx_fmt=jpeg\"]}",
  5. "service_infos": "{\"service_infos\":[{\"id\":2,\"type\":1,\"name\":\"快递\",\"appid\":\"wx1373169e494e0c39\",\"path\":\"index\"},{\"id\":0,\"type\":2,\"name\":\"自定义\",\"appid\":\"wx1373169e494e0c39\",\"path\":\"index\"}]}",
  6. "store_name": "羊村小马烧烤",
  7. "contract_phone": "111111111",
  8. "hour": "00:00-11:11",
  9. "company_name": "深圳市腾讯计算机系统有限公司",
  10. "credential": "156718193518281",
  11. "address": "新疆维吾尔自治区克拉玛依市克拉玛依区碧水路15-1-8号(碧水云天广场)",
  12. "qualification_list": "3LaLzqiTrQcD20DlX_o-OV1-nlYMu7sdVAL7SV2PrxVyjZFZZmB3O6LPGaYXlZWq",
  13. "poi_id": ""
  14. }

返回json示例: { “errcode”:0, “errmsg”:”ok”, “data”:{ “audit_id”:416620525, “poi_id”: 112333 } }

审核状态通知

审核状态通过事件推送通知,推送数据格式为 XML

示例数据

  1. <xml>
  2. <ToUserName><![CDATA[gh_4346ac1514d8]]></ToUserName>
  3. <FromUserName><![CDATA[od1P50M-fNQI5Gcq-trm4a7apsU8]]></FromUserName>
  4. <CreateTime>1488856741</CreateTime>
  5. <MsgType><![CDATA[event]]></MsgType>
  6. <Event><![CDATA[add_nearby_poi_audit_info]]></Event>
  7. <audit_id>11111</audit_id>
  8. <status>3</status> // 2: 审核失败 3: 审核通过
  9. <reason><![CDATA[xxx]]></reason> //审核失败的理由
  10. <poi_id>111111</poi_id>
  11. </xml>

参数说明

参数说明
audit_id审核单id
status审核状态(3:审核通过,2:审核失败)
reason如果status为2,会返回审核失败的原因
poi_idpoi_id

云调用

云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。

接口方法

  1. openapi.nearbyPoi.add

需在 config.json 中配置 nearbyPoi.add API 的权限,详情

请求参数

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

返回值

Object

返回的 JSON 数据包

属性类型说明
errMsgstring错误信息
errCodenumber错误码
dataobject返回数据

data 的结构

属性类型说明
auditIdstring审核单 ID
poiIdstring附近地点 ID
relatedCredentialstring经营资质证件号

异常

Object

抛出的异常

属性类型说明
errMsgstring错误信息
errCodenumber错误码

errCode 的合法值

说明最低版本

请求示例

  1. {
  2. "is_comm_nearby": "1", //值固定
  3. "kf_info": "{\"open_kf\":true,\"kf_headimg\":\"http://mmbiz.qpic.cn/mmbiz_jpg/kKMgNtnEfQzDKpLXYhgo3W3Gndl34gITqmP914zSwhajIEJzUPpx40P7R8fRe1QmicneQMhFzpZNhSLjrvU1pIA/0?wx_fmt=jpeg\",\"kf_name\":\"Harden\"}",
  4. "pic_list": "{\"list\":[\"http://mmbiz.qpic.cn/mmbiz_jpg/kKMgNtnEfQzDKpLXYhgo3W3Gndl34gITqmP914zSwhajIEJzUPpx40P7R8fRe1QmicneQMhFzpZNhSLjrvU1pIA/0?wx_fmt=jpeg\",\"http://mmbiz.qpic.cn/mmbiz_jpg/kKMgNtnEfQzDKpLXYhgo3W3Gndl34gITRneE5FS9uYruXGMmrtmhsBySwddEWUGOibG8Ze2NT5E3Dyt79I0htNg/0?wx_fmt=jpeg\"]}",
  5. "service_infos": "{\"service_infos\":[{\"id\":2,\"type\":1,\"name\":\"快递\",\"appid\":\"wx1373169e494e0c39\",\"path\":\"index\"},{\"id\":0,\"type\":2,\"name\":\"自定义\",\"appid\":\"wx1373169e494e0c39\",\"path\":\"index\"}]}",
  6. "store_name": "羊村小马烧烤",
  7. "contract_phone": "111111111",
  8. "hour": "00:00-11:11",
  9. "company_name": "深圳市腾讯计算机系统有限公司",
  10. "credential": "156718193518281",
  11. "address": "新疆维吾尔自治区克拉玛依市克拉玛依区碧水路15-1-8号(碧水云天广场)",
  12. "qualification_list": "3LaLzqiTrQcD20DlX_o-OV1-nlYMu7sdVAL7SV2PrxVyjZFZZmB3O6LPGaYXlZWq",
  13. "poi_id": ""
  14. }

返回json示例: { “errcode”:0, “errmsg”:”ok”, “data”:{ “audit_id”:416620525, “poi_id”: 112333 } }