微信小程序开发文档微信小程序 add

2024-02-25 开发教程微信小程序开发文档匿名 0℃

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	string	错误信息
errcode	number	错误码
data	object	返回数据

data 的结构

属性	类型	说明
audit_id	string	审核单 ID
poi_id	string	附近地点 ID
related_credential	string	经营资质证件号

注：添加门店需要审核，需要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进行串行调用

请求示例

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

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

审核状态通知

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

示例数据

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

参数说明

参数	说明
audit_id	审核单id
status	审核状态（3：审核通过，2：审核失败）
reason	如果status为2，会返回审核失败的原因
poi_id	poi_id

云调用

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

接口方法

openapi.nearbyPoi.add

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

请求参数

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

返回值

Object

返回的 JSON 数据包

属性	类型	说明
errMsg	string	错误信息
errCode	number	错误码
data	object	返回数据

data 的结构

属性	类型	说明
auditId	string	审核单 ID
poiId	string	附近地点 ID
relatedCredential	string	经营资质证件号

异常

Object

抛出的异常

属性	类型	说明
errMsg	string	错误信息
errCode	number	错误码

errCode 的合法值

值	说明	最低版本

请求示例

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

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

上一节：微信小程序 unbindPlugin

下一节：微信小程序 delete

"微信小程序开发文档"的目录

微信小程序开发文档 微信小程序 add

nearbyPoi.add

HTTPS 调用

请求地址

请求参数

返回值

Object

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

频率限制说明

请求示例

审核状态通知

示例数据

参数说明

云调用

接口方法

请求参数

返回值

Object

异常

Object

请求示例

微信小程序开发文档微信小程序 add