# 获取城市服务限定页面链接
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:cityserviceservicehomepath
本接口用于获取城市服务限定页面链接
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/cityservice/getservicepath?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:22、105
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 | 枚举 |
|---|---|---|---|---|
| page_type | number | 是 | 获取城市服务路径类型 | 枚举值 |
| src_channel | number | 是 | 跳转来源渠道 | 枚举值 |
| need_path_type | number | 否 | 获取h5 URL需填写1(OpenSDK不需要填写) | - |
| device_type | number | 否 | 获取h5 URL需填写2(OpenSDK不需要填写) | - |
| city_name | string | 否 | 城市名称,page_type为1、3、5时必填(城市名称以地级市为准) | - |
| content_name | string | 否 | 专题页名称,page_type为3时必填 | - |
| ext_params | objarray | 否 | 附加参数,包括关键字等其他参数,page_type为5时必填 | - |
| service_id | number | 否 | 服务id,page_type为0时必填 | - |
| params | string | 否 | 透传参数,page_type为0时必填 必须为一个json数组,每个object包括两个成员key和value。key的值是透传的字段名,value的值是透传参数的值。 例如,[{\"key\":\"type\",\"value\":\"11\"}]表示将type=11通过城市服务主页透传到第三方。 限制:透传参数个数最多为10个;key和value的值必须为字符串;key的值不能重复。key=city,表示用户所在城市,如广州. | - |
| city_id | string | 否 | 用户所在城市id(需与腾讯内部要是同一套编码),page_type为0时可传 | - |
# Body.ext_params(Array) Object Payload
附加参数,包括关键字等其他参数,page_type为5时必填
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| key | string | 是 | 关键字的key名称置顶位keyword |
| value | string | 是 | 服务列表名称(以城市服务的标签名称为准) |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误描述 |
| path | string | 结果路径 |
| business_type | string | 类型 |
| app_id | string | 小程序 id,page_type为5时返回 |
| username | string | 原始id,page_type为5时返回 |
| query_string | string | path的参数,page_type为0时返回 |
# 4. 枚举信息
# Body.page_type Enum
获取城市服务路径类型
| 枚举值 | 描述 |
|---|---|
| 0 | 服务主页 |
| 1 | 首页 |
| 3 | 专题页 |
| 5 | 服务列表页 |
# Body.src_channel Enum
跳转来源渠道
| 枚举值 | 描述 |
|---|---|
| 0 | 公众号 |
| 1 | 小程序 |
| 2 | 短信 |
| 3 | 其他 |
| 5 | 厂商 |
# 5. 注意事项
本接口无特殊注意事项
# 6. 代码示例
# 6.1 城市服务首页示例
请求示例
{
"page_type": 1,
"src_channel": 0,
"city_name": "广州"
}
返回示例
{
"errcode": 0,
"errmsg": "成功"
"path": "XXX",
"business_type": "xxd"
}
效果参考
# 6.2 专题页面示例
请求示例
{
"page_type": 3,
"src_channel": 0,
"city_name": '广州',
"content_name": '购房落户'
}
返回示例
{
"errcode": 0,
"errmsg": "成功",
"path": "XXX",
"bussiness_type": "xxd"
}
效果参考
# 6.3 服务列表页示意
请求示例
{
"city_name":"广州",
"page_type":5,
"src_channel":1,
"ext_params":[
{
"key":"keyword",
"value":"挂号就诊"
}
]
}
返回示例
{
"errcode":0,
"errmsg":"ok",
"path":"path/xxx/xxx",
"app_id":"wx322xxxx",
"username":"gh_xxx"
}
效果参考
# 6.4 服务主页示例
请求示例
{
"page_type":0,
"src_channel":0,
"service_id":1001344,
" params ": "[
{ \"key\":\"type\",
\"value\":\"11\"},
{
\"key\":\"dd\",
\"value\":\"23\"
}]"
}
返回示例
{
"errcode":0,
"errmsg":"成功",
"path":"XXX",
"query_string":"xxx”",
"business_type":"xxd”"
}
效果参考
# 7. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| 83200 | no exist service |
# 8. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。