首页
/ EvolutionAPI 中媒体类型参数的正确使用方法

EvolutionAPI 中媒体类型参数的正确使用方法

2025-06-25 08:11:19作者:尤辰城Agatha

在使用 EvolutionAPI 发送媒体消息时,开发者经常会遇到关于 mediatype 参数的配置问题。本文将详细解析该参数的正确使用方法,帮助开发者避免常见的配置错误。

问题背景

许多开发者在尝试通过 EvolutionAPI 发送文档或音频等媒体消息时,会遇到类似 "instance requires property \"mediatype\"" 的错误提示。这通常是由于 API 版本差异或参数命名不规范导致的。

参数配置解析

文档发送的正确格式

对于文档类型的媒体消息,正确的请求体格式应该是:

{
  "number": "#############",
  "mediatype": "document",
  "fileName": "teste.pdf",
  "media": "base64编码的文档内容"
}

关键点在于:

  1. mediatype 必须作为顶级属性直接出现在请求体中
  2. 属性名必须完全小写 mediatype,而不是 mediaTypeMediaType
  3. 文档类型应指定为 "document"

音频发送的正确格式

对于音频消息,正确的请求体格式更为简洁:

{
  "number": "手机号码",
  "audio": "base64编码的音频内容"
}

API 版本差异说明

这个问题主要源于 API 版本的不同:

  1. v1 版本:需要使用 mediaMessage 嵌套结构,并包含 mediaType 属性
  2. v2 版本:参数更为扁平化,直接使用 mediatype 作为顶级属性

开发者应当根据自己使用的 API 版本选择合适的参数结构。如果使用的是最新版本,建议采用 v2 的扁平化参数结构,它更加简洁直观。

最佳实践建议

  1. 始终确认你使用的 API 版本
  2. 对于不确定的参数,可以先进行小规模测试
  3. 注意参数的大小写,API 通常对大小写敏感
  4. 文档和音频的发送方式有所不同,需分别处理
  5. 确保媒体文件的 base64 编码正确无误

通过遵循这些指导原则,开发者可以避免大多数与媒体类型参数相关的配置问题,确保消息能够成功发送。

登录后查看全文
热门项目推荐
相关项目推荐