文件识别

使用指定的文件名、Hash、文件长度信息寻找文件可能对应的节目信息。

接口说明

此接口用于当用户打开某视频文件时,可以通过文件名称、Hash等信息查找此视频可能对应的节目信息。

此接口首先会使用Hash信息进行搜寻,如果有相应的记录,会返回“精确关联”的结果(即isMatched属性为true,此时列表中只包含一个搜索结果)。

如果Hash信息匹配失败,则会继续通过文件名进行模糊搜寻。

返回值说明

一个包含节目信息的列表,节目在列表中排名越靠前,这个节目越有可能是视频文件的内容。 当列表中只有一个节目时(isMatched属性为true),视为“精确关联” —— 说明此视频已被人工关联了某一节目。客户端应自动选择这个唯一的结果,不必再让用户做出选择。

post/api/v2/match

Request

  • Base URL: https://api.dandanplay.net
  • URL: https://api.dandanplay.net/api/v2/match
  • Auth: one of:
    • API key in header X-AppId
    • API key in header X-AppSecret
    • HTTP bearer

Request body

fileNamestring nullable

视频文件名,不包含文件夹名称和扩展名,特殊字符需进行转义。

fileHashstring nullable

文件前16MB (16x1024x1024 Byte) 数据的32位MD5结果,不区分大小写。

fileSizeinteger

文件总长度,单位为Byte。

videoDurationinteger

[可选]32位整数的视频时长,单位为秒。默认为0。

matchMode'hashAndFileName' | 'fileNameOnly' | 'hashOnly'

Response

errorCodeinteger

错误代码,0表示没有发生错误,非0表示有错误,详细信息会包含在errorMessage属性中

successboolean

接口是否调用成功

errorMessagestring nullable

当发生错误时,说明错误具体原因

errorDetailstring nullable

当参数校验失败时,提供可供调用方定位问题字段的补充信息。

isMatchedboolean

是否已精确关联到某个弹幕库

Changes

No recorded changes to this operation across all 1 revision of this API.