MGetInterestMapPoisForSDK - 通过 POI ID批量获取POI--内容定制-火山引擎

文档中心

立即注册

导航

MGetInterestMapPoisForSDK - 通过 POI ID批量获取POI

最近更新时间：2024.11.01 14:03:09首次发布时间：2024.11.01 14:03:09

批量定向获取兴趣地图可用POI，只返回当前客户可用的POI列表。

请求说明

请求方式：POST
请求地址：https://mercury.volcengineapi.com?Action=MGetInterestMapPoisForSDK&Version=2024-01-01
请求头：
- ServiceName:volc_torchlight_api
- Content-Type:application/json

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必填	示例值	描述
Action	String	是	MGetInterestMapPoisForSDK	要执行的操作，取值：MGetInterestMapPoisForSDK。
Version	String	是	2024-01-01	API的版本，取值：2024-01-01。

Body

参数	类型	是否必填	示例值	描述
UtmSource	String	是	xxx_default_content	渠道号
PoiIds	Array of String	是	6601226325149616136	POI ID列表，最大数量100个。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数

类型

示例值

描述

Pois

Array of Object

可访问的POI列表。

MissReasons

Object

{
"6601226325149616138": 2
}

没有成功获取 POI 的原因。
其中key是POI ID，value 是失败原因。
失败原因枚举值：

枚举值	原因
1	没有权限
2	无效id

请求示例

POST /?Action=MGetInterestMapPoisForSDK&Version=2024-01-01 HTTP/1.1
Host: https://mercury.volcengineapi.com?Action=MGetInterestMapPoisForSDK&Version=2024-01-01
Content-Type: application/json; charset=UTF-8
X-Date: 20241031T055150Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241031/cn-beijing/volc_torchlight_api/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "UtmSource": "xxx_default_content",
  "PoiIds": [
    "6601123777029867533","6601226325149616138"
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241031135241218078225064ADDFC5",
    "Action": "MGetInterestMapPoisForSDK",
    "Version": "2024-01-01",
    "Service": "volc_torchlight_api",
    "Region": "cn-beijing"
  },
  "Result": {
    "Pois": [
      {
        "PoiId": "6601123777029867533",
        "ParentId": "0",
        "Name": "POI 名称",
        "ProvinceCode": "11",
        "CityCode": "110000",
        "DistrictCode": "110105",
        "Address": "POI 地址",
        "Categories": [
          {
            "Code": "180000",
            "Name": "游玩",
            "SubNodes": []
          }
        ],
        "Longitude": 116.393092,
        "Latitude": 40.009939,
        "QualityRank": 100,
        "CreateTime": 1536943898
      }
    ],
    "MissReasons": {
      "6601226325149616138": 2
    }
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。