AI Robot X

Svip
menu_device menu_feedback 设备配网 设置 menu_logout

API接口文档

所有接口地址均基于: http://devapi.genicsoft.com/

接口概览

接口名称 请求方式 接口地址 功能描述
发送播放URL POST /sendPlayUrl 向设备发送音频URL进行播放（仅限mp3格式）
发送播放文本 POST /sendPlayText 向设备发送文本进行语音播放（支持模式与重复次数控制）
发送播放图片 POST /sendPlayImage 向设备发送图片URL进行显示（支持jpg、png等）
发送播放GIF POST /sendPlayGif 向设备发送GIF动画URL进行播放

接口详情

5. 发送播放URL

POST /sendPlayUrl

功能描述: 向设备发送音频URL进行播放

请求参数:

参数名 类型 必填 描述
sn string 是 设备序列号
url string 是 音频URL地址

响应示例:

{
  "status": "sent",
  "to": "目标地址",
  "message": "发送的消息内容"
}

6. 发送播放文本

POST /sendPlayText

功能描述: 向设备发送文本进行语音播放，并支持控制播放结束后的状态及重复次数。需要系统版本 0.26929 及以上版本。

请求参数:

参数名 类型 必填 描述
sn string 是 设备序列号
text string 是 要播放的文本内容（最长100字符，超长自动截断）
mode int 否 播放完毕后的状态：
1 – 进入对话状态（默认）
2 – 进入待机状态
repeat int 否 重复播放次数，默认 1，取值范围 ≥ 1 （此参数目前无效，默认1次）

响应示例:

// 成功
{
  "status": "success"
}
// 设备未找到
{
  "status": "error",
  "message": "user not found"
}

7. 发送播放图片

POST /sendPlayImage

功能描述: 向设备发送图片URL进行显示（支持jpg、png等常见格式）

📌 使用建议：
• 最佳显示尺寸：360×360 像素（正方形）
• 文件大小建议控制在 1MB 以内，以保证加载速度
• ⚠️ 个别使用特殊算法优化的 JPG 格式可能不兼容，若显示异常，请自行转换为标准 JPG 格式后再上传

请求参数:

参数名 类型 必填 描述
sn string 是 设备序列号
url string 是 图片URL地址

响应示例:

// 成功
{
  "status": "success"
}
// 设备未找到
{
  "status": "error",
  "message": "user not found"
}

8. 发送播放GIF

POST /sendPlayGif

功能描述: 向设备发送GIF动画URL进行播放

📌 使用建议：
• 最佳显示尺寸：360×360 像素（正方形）
• 文件大小建议控制在 1MB 以内，以保证流畅播放
• ⚠️ 个别使用特殊算法优化的 GIF 格式可能不兼容，若播放异常，请自行转换为标准 GIF 格式后再上传

请求参数:

参数名 类型 必填 描述
sn string 是 设备序列号
url string 是 GIF动画URL地址

响应示例:

// 成功
{
  "status": "success"
}
// 设备未找到
{
  "status": "error",
  "message": "user not found"
}

注意事项

  • 所有接口均需要设备序列号(sn)作为标识
  • 发送到设备的文本内容会自动加密处理
  • 发送播放文本时，文本长度超过100个字符会被自动截断
  • 发送播放图片和GIF时，URL长度建议不超过500个字符，过长会被截断
  • 图片和GIF接口直接透传URL，无需加密，设备将自行从网络加载资源
  • 为确保显示效果，图片及GIF素材请尽量遵循各接口提示的最佳尺寸和容量要求
  • 新增：发送播放文本接口现已支持 mode（播放后状态，默认1）和 repeat（重复次数，默认1）参数，请按需使用。

错误代码

错误代码 描述
404 用户/设备未找到
500 服务器内部错误或Redis操作超时