跳至主要內容

资源相关

大约 2 分钟

注意

对于 Shamrock 尚未实现的 API,会在标题添加标记 未实现

获取图片

该接口用于获取图片,只能获取已缓存的图片。

API 端点

/get_image

参数

字段类型必须说明
filestring文件 MD5

响应

字段类型说明
sizeint64文件大小
urlstring文件 URL
filenamestring文件 名称

检查是否可以发送图片 未实现

该接口用于检查是否可以发送图片。

API 端点

/can_send_image

参数

提示

该 API 无需参数

响应

字段名数据类型说明
yesboolean是或否

图片 OCR 未实现

该接口用于图片 OCR。

API 端点

/ocr_image

参数

字段类型说明
imagestring图片ID

响应

字段类型说明
textsList<TextDetection>OCR结果
languagestring语言

TextDetection

字段类型说明
textstring文本
confidenceint32置信度
coordinatesvector2[]二维数组表示的坐标

获取语音

该接口用于获取语音。

API 端点

/get_record

参数

字段类型必须说明
filestring文件 MD5
out_formatstring输出格式

响应

字段类型说明
filestring文件路径
urlstring文件 URL

检查是否可以发送语音 未实现

该接口用于检查是否可以发送语音。

API 端点

/can_send_record

参数

提示

该 API 无需参数

响应

字段名数据类型说明
yesboolean是或否

API 端点

/get_record

提示

要使用此接口, 通常需要安装 ffmpeg, 请参考 OneBot 实现的相关说明。

参数

字段名数据类型默认值说明
filestring-收到的语音文件名(消息段的 file 参数), 如 0B38145AA44505000B38145AA4450500.silk
out_formatstring-要转换到的格式, 目前支持 mp3amrwmam4aspxoggwavflac

响应

字段名数据类型说明
filestring转换后的语音文件路径, 如 /home/somebody/cqhttp/data/record/0B38145AA44505000B38145AA4450500.mp3

获取文件 未实现

该接口用于获取文件。

获取视频 未实现

该接口用于获取视频。

获取缩略图 未实现

该接口用于获取缩略图。