实时获取POI关联文章信息

请求说明

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

调试

请求参数

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

Query

const columns = [
  {
    width: '20%',
    title: '参数',
    dataIndex: 'Name',
    className: 'openapi-doc-parameter-table-name'
  },
  {
    width: 130,
    title: '类型',
    dataIndex: 'DataType',
    className: 'openapi-doc-parameter-table-type'
  },
  {
    width: 90,
    title: '是否必填',
    dataIndex: 'IsRequired',
    className: 'openapi-doc-parameter-table-required'
  },
  {
    width: '20%',
    title: '示例值',
    dataIndex: 'Example',
    className: 'openapi-doc-parameter-table-example'
  },
  {
    title: '描述',
    dataIndex: 'Description',
    className: 'openapi-doc-parameter-table-description'
  },
];

const queryData = [
  {
    rowKey: '->Action',
    Name: 'Action',
    DataType: 'String',
    IsRequired: '是',
    Example: <RenderMd content={"MGetPoiArticlePlayListForSDK"} />,
    Description: <RenderMd content={"要执行的操作，取值：MGetPoiArticlePlayListForSDK。"} />,
    children: [
    ]
  },
  {
    rowKey: '->Version',
    Name: 'Version',
    DataType: 'String',
    IsRequired: '是',
    Example: <RenderMd content={"2024-01-01"} />,
    Description: <RenderMd content={"API的版本，取值：2024-01-01。"} />,
    children: [
    ]
  },
];

return (<Table
  rowKey="rowKey"
  className="openapi-doc-parameter-table"
  columns={columns}
  data={queryData}
  border={ { cell: true, wrapper: true } }
  scroll={ { x: "auto" } }
  pagination={false}
/>);

Body

const columns = [
  {
    width: '20%',
    title: '参数',
    dataIndex: 'Name',
    className: 'openapi-doc-parameter-table-name'
  },
  {
    width: 130,
    title: '类型',
    dataIndex: 'DataType',
    className: 'openapi-doc-parameter-table-type'
  },
  {
    width: 90,
    title: '是否必填',
    dataIndex: 'IsRequired',
    className: 'openapi-doc-parameter-table-required'
  },
  {
    width: '20%',
    title: '示例值',
    dataIndex: 'Example',
    className: 'openapi-doc-parameter-table-example'
  },
  {
    title: '描述',
    dataIndex: 'Description',
    className: 'openapi-doc-parameter-table-description'
  },
];

const bodyData = [
  {
    rowKey: '->UtmSource',
    Name: 'UtmSource',
    DataType: 'String',
    IsRequired: '是',
    Example: <RenderMd content={"xxx_default_content"} />,
    Description: <RenderMd content={"渠道号。"} />,
    children: [
    ]
  },
  {
    rowKey: '->PoiIds',
    Name: 'PoiIds',
    DataType: 'Array of String',
    IsRequired: '是',
    Example: <RenderMd content={"6601123777029867533"} />,
    Description: <RenderMd content={"获取文章详情的poi id列表，最多100个，超过时按100返回。"} />,
    children: [
    ]
  },
];

return (<Table
  rowKey="rowKey"
  className="openapi-doc-parameter-table"
  columns={columns}
  data={bodyData}
  border={ { cell: true, wrapper: true } }
  scroll={ { x: "auto" } }
  pagination={false}
/>);

返回参数

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

const columns = [
  {
    width: '25%',
    title: '参数',
    dataIndex: 'Name',
    className: 'openapi-doc-parameter-table-name',
  },
  {
    width: 130,
    title: '类型',
    dataIndex: 'DataType',
    className: 'openapi-doc-parameter-table-type'
  },
  {
    width: '25%',
    title: '示例值',
    dataIndex: 'Example',
    className: 'openapi-doc-parameter-table-example'
  },
  {
    title: '描述',
    dataIndex: 'Description',
    className: 'openapi-doc-parameter-table-description'
  },
];

const data = [
  {
    rowKey: "->PoiArticlePlayInfo",
    Name: "PoiArticlePlayInfo",
    DataType: "Object",
    Example: <RenderMd content={"{\n            \"6601123777029867533\": {\n                \"PoiId\": \"6601123777029867533\",\n                \"PlayUrl\": \" H5播放链接\",\n                \"DisplayName\": \"视频标题\",\n                \"DisplayCoverImage\": {\n                    \"Width\": 540,\n                    \"Height\": 720,\n                    \"Url\": \"关联视频封面图 url\"\n                }\n            }\n        }"} />,
    Description: <RenderMd content={"POI 关联的文章详情。其中key为Poi id，value为文章详情。\n文章详情字段说明：\n| 字段名 | 字段类型 | 说明 |\n| --- | --- | --- |\n| PoiId | String | Poi Id |\n| PlayUrl | String | 播放链接，h5 |\n| DisplayName | String | Poi关联视频标题 |\n| DisplayCoverImage | ArticleImage | Poi关联视频封面图 |\nArticleImage\n| 字段名 | 字段类型 | 说明 |\n| --- | --- | --- |\n| Url | String | 图片链接 |\n| Width | Integer | 图片宽 |\n| Height | Integer | 图片高 |"} />,
    children: [
    ]
  },
  {
    rowKey: "->MissPoiIds",
    Name: "MissPoiIds",
    DataType: "Array of String",
    Example: <RenderMd content={"6601226325149616138   "} />,
    Description: <RenderMd content={"没有关联到文章的Poi id列表。"} />,
    children: [
    ]
  },
];

return (<Table
  rowKey="rowKey"
  className="openapi-doc-parameter-table"
  columns={columns}
  data={data}
  border={ { cell: true, wrapper: true } }
  scroll={ { x: "auto" } }
  pagination={false}
/>);

请求示例

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"
    ]
  }
}

错误码

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