MGetPoiArticlePlayListForSDK - 实时获取POI关联文章信息--内容定制-火山引擎

文档中心

立即注册

导航

MGetPoiArticlePlayListForSDK - 实时获取POI关联文章信息

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

实时获取POI关联文章信息

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必填	示例值	描述
UtmSource	String	是	xxx_default_content	渠道号。
PoiIds	Array of String	是	6601123777029867533	获取文章详情的poi id列表，最多100个，超过时按100返回。

返回参数

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

参数

类型

示例值

描述

PoiArticlePlayInfo

Object

{
"6601123777029867533": {
"PoiId": "6601123777029867533",
"PlayUrl": " H5播放链接",
"DisplayName": "视频标题",
"DisplayCoverImage": {
"Width": 540,
"Height": 720,
"Url": "关联视频封面图 url"
}
}
}

POI 关联的文章详情。其中key为Poi id，value为文章详情。
文章详情字段说明：

字段名	字段类型	说明
PoiId	String	Poi Id
PlayUrl	String	播放链接，h5
DisplayName	String	Poi关联视频标题
DisplayCoverImage	ArticleImage	Poi关联视频封面图

ArticleImage

字段名	字段类型	说明
Url	String	图片链接
Width	Integer	图片宽
Height	Integer	图片高

MissPoiIds

Array of String

6601226325149616138

没有关联到文章的Poi id列表。

请求示例

POST /?Action=MGetPoiArticlePlayListForSDK&Version=2024-01-01 HTTP/1.1
Host: https://mercury.volcengineapi.com?Action=MGetPoiArticlePlayListForSDK&Version=2024-01-01
Content-Type: application/json; charset=UTF-8
X-Date: 20241031T071230Z
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": "202410311512520390981451768A1146",
    "Action": "MGetPoiArticlePlayListForSDK",
    "Version": "2024-01-01",
    "Service": "volc_torchlight_api",
    "Region": "cn-beijing"
  },
  "Result": {
    "PoiArticlePlayInfo": {
      "6601123777029867533": {
        "PoiId": "6601123777029867533",
        "PlayUrl": "h5 play url",
        "DisplayName": "title",
        "DisplayCoverImage": {
          "Width": 540,
          "Height": 720,
          "Url": "cover image url"
        }
      }
    },
    "MissPoiIds": [
      "6601226325149616138"
    ]
  }
}

错误码

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